Start sharing components as a team!Share components as a team!Join Bit to build your applications faster.Get Started Free

accordion

v2.6.5arrow_drop_down
v2.6.5
v2.5.5
STATUS
Passing
DOWNLOADS
70
LICENSE
Apache 2.0
VISIBILITY
Public
PUBLISHED
7 months ago
SIZE
34 KB
An accordion containing collapsible panels.
1 contributor
Use accordion in your project ?
Copied
npm i @bit/grommet.grommet.accordion
Set Bit as a scoped registryLearn more
npm config set '@bit:registry' https://node.bit.dev
Component Example
React
React
Vue
Angular
Add dependency... help_outline
Just
import
any of the 1 million components
and packages in Bit or NPM to the example.
import Button from '@bit/grommet.grommet.button';
import Lodash from 'lodash';
toggle layout
modifieddraft
chevron_left
chevron_right

Accordion

An accordion containing collapsible panels.

Usage

import { Accordion, AccordionPanel } from 'grommet';
<Accordion>
  <AccordionPanel label='Panel 1'>...</AccordionPanel>
  <AccordionPanel label='Panek 2'>...</AccordionPanel>
</Accordion>

Properties

a11yTitle

Custom title to be used by screen readers.

string

alignSelf

How to align along the cross axis when contained in a Box or along the column axis when contained in a Grid.

start
center
end
stretch

gridArea

The name of the area to place this inside a parent Grid.

string

margin

The amount of margin around the component. An object can be specified to distinguish horizontal margin, vertical margin, and margin on a particular side.

none
xxsmall
xsmall
small
medium
large
xlarge
{
  bottom: 
    xxsmall
    xsmall
    small
    medium
    large
    xlarge
    string,
  horizontal: 
    xxsmall
    xsmall
    small
    medium
    large
    xlarge
    string,
  left: 
    xxsmall
    xsmall
    small
    medium
    large
    xlarge
    string,
  right: 
    xxsmall
    xsmall
    small
    medium
    large
    xlarge
    string,
  top: 
    xxsmall
    xsmall
    small
    medium
    large
    xlarge
    string,
  vertical: 
    xxsmall
    xsmall
    small
    medium
    large
    xlarge
    string
}
string

activeIndex

Active panel index. If specified, Accordion will be a controlled component. This means that future panel changes will not work unless you subscribe to onActive function and update activeIndex accordingly.

number
[number]

animate

Transition content in & out with a slide down animation. Defaults to true.

boolean

children

Array of AccordionPanels.

node

onActive

Function that will be called when the active index changes. It will always send an array with currently active panel indexes.

function

multiple

Allow multiple panels to be opened at once.

boolean

messages

Custom messages for Tabs. Used for accessibility by screen readers. Defaults to { "tabContents": "Tab Contents" }.

{
  tabContents: string
}

Intrinsic element

div