Skip to content

Component-wrapper for collapse animation with css for elements with variable and dynamic height

License

Notifications You must be signed in to change notification settings

torleifhalseth/react-css-collapse

 
 

Repository files navigation

react-css-collapse

Component-wrapper for collapse animation with css for elements with variable and dynamic height

Build Status npm version npm downloads

Installation

Using npm:

npm install --save react-css-collapse

Then with a module bundler like webpack, use as you would anything else:

import Collapse from 'react-css-collapse';

<Collapse isOpen={true || false}>
  <div>Random content</div>
</Collapse>

Options

isOpen: PropTypes.boolean.isRequired

Expands or collapses content.

children: PropTypes.node.isRequired

One or multiple children with static, variable or dynamic height.

<Collapse isOpen={true}>
  <p>Paragraph of text</p>
  <p>Another paragraph is also OK</p>
  <p>Images and any other content are ok too</p>
  <img src="cutecat.gif" />
</Collapse>

onRest: PropTypes.func

Callback function for when your transition on height (specified in className) is finished. It can be used to trigger any function after transition is done.

className: PropType.string

You can specify a className with your desired style and animation

.react-css-collapse-transition {
  transition: height 250ms cubic-bezier(.4, 0, .2, 1);
}

Development and testing

To run example covering all features, use npm run storybook.

git clone [repo]
cd [repo]
npm install
npm run storybook

Open http://localhost:6006 🎆

About

Component-wrapper for collapse animation with css for elements with variable and dynamic height

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 99.2%
  • CSS 0.8%