Skip to content
Accessible Accordion component for React
TypeScript JavaScript CSS HTML
Branch: master
Clone or download

Latest commit

yuzima Merge pull request #251 from springload/fix/header_cover_section_in_demo
fix: header and footer cover section in demo site
Latest commit 558510c Feb 28, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Run integration tests in band Feb 10, 2019
demo/src fix: header and footer cover section in demo site Feb 27, 2020
integration Fix semantics in tests Mar 11, 2019
src Switched usage of Array.prototype.findIndex to indexOf. Nov 14, 2019
.browserslistrc Add .browserslistrc file Jun 11, 2018
.editorconfig Simplify editorconfig in favour of prettierrc Dec 17, 2018
.gitignore Install gh-pages and rimraf and fix 'build:demo' task Jan 23, 2019
.nvmrc Bump node to latest LTS Dec 17, 2018
.prettierignore Add a bunch of files to prettierignore Dec 17, 2018
.prettierrc Prettier Feb 1, 2019
CHANGELOG.md Update CHANGELOG.md to include issue numbers Nov 14, 2019
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Jan 30, 2019
CONTRIBUTING.md Add note on gh-pages deployment Jun 26, 2019
LICENSE Update LICENSE Apr 1, 2019
README.md Switched usage of Array.prototype.findIndex to indexOf. Nov 14, 2019
babel.config.js Fix regeneratorRuntime missing in tests Feb 4, 2019
jest.config.js Remove enzyme Mar 5, 2019
package.json Update build:demo task to include CNAME file Jan 14, 2020
rollup.config.js Configure TS extensions with rollup config Jan 7, 2019
tsconfig.declaration.json Omit demo and integration types from build, and specify correct types… Mar 18, 2019
tsconfig.json Refactor AccordionItemHeading into two separate components (with Acco… Mar 11, 2019
tslint.json Bump react-testing-library Jun 26, 2019
webpack.config.js Springload logo update. Oct 23, 2019
yarn.lock Bump puppeteer to latest Jan 13, 2020

README.md

react-accessible-accordion npm Dependency Status devDependency Status Accessibility status

Demo

Try a demo now.

Usage

First, grab the package from npm:

npm install --save react-accessible-accordion

Then, import the editor and use it in your code. Here is a basic example:

import React from 'react';

import {
    Accordion,
    AccordionItem,
    AccordionItemHeading,
    AccordionItemButton,
    AccordionItemPanel,
} from 'react-accessible-accordion';

// Demo styles, see 'Styles' section below for some notes on use.
import 'react-accessible-accordion/dist/fancy-example.css';

export default function Example() {
    return (
        <Accordion>
            <AccordionItem>
                <AccordionItemHeading>
                    <AccordionItemButton>
                        What harsh truths do you prefer to ignore?
                    </AccordionItemButton>
                </AccordionItemHeading>
                <AccordionItemPanel>
                    <p>
                        Exercitation in fugiat est ut ad ea cupidatat ut in
                        cupidatat occaecat ut occaecat consequat est minim minim
                        esse tempor laborum consequat esse adipisicing eu
                        reprehenderit enim.
                    </p>
                </AccordionItemPanel>
            </AccordionItem>
            <AccordionItem>
                <AccordionItemHeading>
                    <AccordionItemButton>
                        Is free will real or just an illusion?
                    </AccordionItemButton>
                </AccordionItemHeading>
                <AccordionItemPanel>
                    <p>
                        In ad velit in ex nostrud dolore cupidatat consectetur
                        ea in ut nostrud velit in irure cillum tempor laboris
                        sed adipisicing eu esse duis nulla non.
                    </p>
                </AccordionItemPanel>
            </AccordionItem>
        </Accordion>
    );
}

Styles

We strongly encourage you to write your own styles for your accordions, but we've published the styles used on our demo page to help you get up and running:

import 'react-accessible-accordion/dist/fancy-example.css';

We recommend that you copy them into your own app and modify them to suit your needs, particularly if you're using your own classNames.

Component API

Accordion

allowMultipleExpanded : boolean [optional, default: false]

Don't autocollapse items when expanding other items.

allowZeroExpanded : boolean [optional, default: false]

Allow the only remaining expanded item to be collapsed.

preExpanded: string[] [optional, default: []]

Accepts an array of strings and any AccordionItem whose uuid prop matches any one of these strings will be expanded on mount.

className : string [optional, default: 'accordion']

Class(es) to apply to element.

onChange : (string[]) => void [optional]

Callback which is invoked when items are expanded or collapsed. Gets passed uuids of the currently expanded AccordionItems.


AccordionItem

className : string [optional, default: accordion__item]

Class(es) to apply to element.

uuid : string|number [optional]

Recommended for use with onChange. Will be auto-generated if not provided.


AccordionItemHeading

className : string [optional, default: 'accordion__heading']

Class(es) to apply to the 'heading' element.

aria-level : number [optional, default: 3]

Semantics to apply to the 'heading' element. A value of 1 would make your heading element hierarchically equivalent to an <h1> tag, and likewise a value of 6 would make it equivalent to an <h6> tag.

AccordionItemButton

className : string [optional, default: 'accordion__button']

Class(es) to apply to the 'button' element.


AccordionItemPanel

className : string [optional, default: 'accordion__panel']

Class(es) to apply to element.


AccordionItemState

children : ({ expanded: boolean, disabled: boolean }): JSX.Element [required]


Helpers

resetNextUuid : (): void

Resets the internal counter for Accordion items' identifiers (including id attributes). For use in test suites and isomorphic frameworks.


Accessibility Best-Practice

Authoring an 'accordion' component to the WAI ARIA spec can be complex, but React Accessible Accordion does most of the heavy lifting for you, including:

  • Applying appropriate aria attributes (aria-expanded, aria-controls, aria-disabled, aria-hidden and aria-labelledby).
  • Applying appropriate role attributes (button, heading, region).
  • Applying appropriate tabindex attributes.
  • Applying keyboard interactivity ('space', 'end', 'tab', 'up', 'down', 'home' and 'end' keys).

However, there's still a couple of things you need to keep in mind to remain spec-compliant:

  • Only ever use phrasing content inside of your AccordionItemHeading component. If in doubt, use text only.
  • Always provide an aria-level prop to your AccordionItemHeading component, especially if you are nesting accordions. This attribute is a signal used by assistive technologies (eg. screenreaders) to determine which heading level (ie. h1-h6) to treat your heading as.

If you have any questions about your implementation, then please don't be afraid to get in touch via our issues.

FAQs

Which design patterns does this component aim to solve?

Those described by the WAI ARIA spec's description of an 'accordion':

An accordion is a vertically stacked set of interactive headings that each contain a title, content snippet, or thumbnail representing a section of content. The headings function as controls that enable users to reveal or hide their associated sections of content. Accordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.

Which design patterns does this component NOT aim to solve?

Components which are "accordion-like" but do not match the WAI ARIA spec's description, as written above. By "accordion-like", we mean components which have collapsible items but require bespoke interactive mechanisms in order to expand, collapse and 'disable' them. This includes (but is not limited to) multi-step forms, like those seen in many cart/checkout flows, which we believe require (other) complex markup in order to be considered 'accessible'.

If you believe that you have a valid use-case for 'disabled' items, or items which require manual 'expanded' state-management, then please let us know - we're always open for critical (but polite) feedback. Otherwise, we don't plan on implementing this functionality in the near future.

How do I disable an item?

See "Which design patterns does this component NOT aim to solve?".

How do I manually control the expanded state of an item?

See "Which design patterns does this component NOT aim to solve?". You may use the 'preExpanded' prop to set the initial expanded state, but it may not be controlled manually thereafter.

Browser Support

Supported browser / device versions:

Browser Device/OS Version
Mobile Safari iOS latest
Chrome Android latest
IE Windows 11
MS Edge Windows latest
Chrome Desktop latest
Firefox Desktop latest
Safari OSX latest
You can’t perform that action at this time.