[![Build Status][build-badge]][build]
[![Code Coverage][coverage-badge]][coverage]
[![version][version-badge]][package]
[![downloads][downloads-badge]][npmtrends]
[![MIT License][license-badge]][license]

[![PRs Welcome][prs-badge]][prs]
[![Code of Conduct][coc-badge]][coc]

[![Watch on GitHub][github-watch-badge]][github-watch]
[![Star on GitHub][github-star-badge]][github-star]
[![Tweet][twitter-badge]][twitter]

The problem

We create similar info panels and accordion components that collapse and expand, to and from a height of zero. The logic is always the same but the look may change between use cases. Additionally, we want to have the component accessible to all users, at all times.

This solution

This is a WAI-ARIA compliant React component. It controls how panels/accordions/etc collapse and
expand. ReactSimpleExpand uses render props to reduce overhead and give you flexibility in styling.

Table of Contents

* Installation
* Usage
* Props
* id required
* isOpen
* onToggle
* duration
* Render Prop
* Prop Getters
* State
* LICENSE

Installation

This module is distributed via [npm][npm] which is bundled with [node][node] and
should be installed as one of your project's dependencies:

``bash
npm install --save react-simple-expand
`

Usage

`js
class Accordion extends React.Component {
state = {
open: 0,
}

onClickItem = index => () => {
this.setState({open: index})
}

render() {
const {items} = this.props
const {open} = this.state

return items.map((item, index) => (
key={item.title}
onToggle={this.onClickItem(index)}
isOpen={open === index}
>
({(getRootProps, getHeaderProps, getContentProps)}) => (


// Using the accordion
const App = () => (
items={[
{title: 'First item', description: 'This is just a demo.'},
{
title: "I'm the second item",
description:
'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque scelerisque mi sed sapien mollis tempor. Donec ut pretium mi, et mollis dolor. Donec fermentum, augue tristique dapibus facilisis, velit nisi mattis mi, sit amet ultrices arcu libero sed odio. Donec id nisl facilisis, luctus turpis vitae, egestas velit.',
},
{
title: 'Yup, this is the last item...',
description: 'Last but not least!',
},
]}
/>
)
`

Props

$3

`js
id: PropTypes.string.isRequired
`

Unique html id.

$3

`js
isOpen: PropTypes.bool
`

Controls the visibilty of the content. If the value changes _after the first render_,
the component will change with an animation.

$3

`js
onToggle: PropTypes.func
`

onToggle is passed to the header element and called when clicked. This is the ideal place to
trigger a state change.

$3

`js
duration: PropTypes.number
`

If a value is supplied, the component will animate the toggle.

> Note: This API is likely to change.

Render Prop

This is where you pass your own components to render the state of
ReactSimpleExpand. You can either use a prop called render, or use the
children prop.

The render prop function is passed an object that has the following properties:

$3

These functions are used to apply props to the elements that you render.
The functions take care composing event handlers, merging style objects and
applying other important props and attributes to your components. Their API
is all as follows:

`js
@params {Object} props - optional props you want to add.
@returns {Object} - the props that you need to render the component.
`

_Note:_ If you are rendering a composite component, that component
will need a prop called refKey. The refKey is used to forward a
required ref function that ReactSimpleExpand uses internally to
the root DOM element of the composite component. Commonly, folks
call this innerRef. So you'd call:
getRootProps({ refKey: 'innerRef' }) and your composite component
would forward like: