Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@talixo/accordion

0.1.0 • Public • Published

Talixo Accordion

UI component which represents Accordion

How to install

Package is available as @talixo/accordion in NPM registry, so you can use it in your project using npm install @talixo/accordion --save or yarn add @talixo/accordion.

Requirements

Your package should additionally have some extra dependencies:

  • prop-types: ^15.6.1
  • react: ^16.2.0
  • react-dom: ^16.2.0
  • @talixo/shared: ^0.1.0
  • @talixo/collapse: ^0.1.0

These packages are required by @talixo/accordion, but you have to install them manually, to avoid having different versions of these in your application.

Supported props

Property name Type Default Description
className string n/a additional class name passed to wrapper
smooth bool n/a should elements be collapsed and opened smoothly?
animationTime number n/a time of smooth animation (in ms)
options Option[] n/a options to show in Accordion
value any n/a ID of currently opened option
onChange function n/a Handler fired on possible change of opened container
renderOpenIcon function n/a Render "open" icon for closed option
renderCloseIcon function n/a Render "close" icon for opened option
buildId function (x, index) => index Function to build unique ID for option

Types

Option

Option which should be shown in Accordion has few required properties:

Property name Type Default Description
label node n/a Label to show in button
content nodes n/a Content to put inside collapsible element

Changelog

  • 0.1.0 - initial version

Keywords

none

Install

npm i @talixo/accordion

DownloadsWeekly Downloads

37

Version

0.1.0

License

MIT

Unpacked Size

23.7 kB

Total Files

10

Last publish

Collaborators

  • avatar
  • avatar
  • avatar