What is rc-collapse?
The rc-collapse npm package is a React component for creating collapsible panels. It allows developers to create sections of content that can be expanded or collapsed by the user, making it useful for FAQs, menus, and more. It supports accordion mode, where only one panel can be open at a time.
What are rc-collapse's main functionalities?
Basic Collapse
This code sample demonstrates how to create a basic collapsible component with two panels. Each panel has its own header and content.
import Collapse from 'rc-collapse';
import 'rc-collapse/assets/index.css';
const Panel = Collapse.Panel;
const App = () => (
<Collapse>
<Panel header="This is panel header 1" key="1">
<p>Content of panel 1</p>
</Panel>
<Panel header="This is panel header 2" key="2">
<p>Content of panel 2</p>
</Panel>
</Collapse>
);
Accordion Mode
This example shows how to enable accordion mode, where opening one panel will close the others, ensuring only one panel is open at a time.
import Collapse from 'rc-collapse';
import 'rc-collapse/assets/index.css';
const Panel = Collapse.Panel;
const App = () => (
<Collapse accordion>
<Panel header="This is panel header 1" key="1">
<p>Content of panel 1</p>
</Panel>
<Panel header="This is panel header 2" key="2">
<p>Content of panel 2</p>
</Panel>
</Collapse>
);
Other packages similar to rc-collapse
react-collapse
Similar to rc-collapse, react-collapse provides components for creating collapsible content. It focuses on smooth height animations and flexibility, but it might not offer the same out-of-the-box accordion functionality.
react-accessible-accordion
This package offers a set of components to build accessible accordions in React. It emphasizes accessibility and semantic HTML structure, making it a good choice for projects that require adherence to accessibility standards. It provides a different approach compared to rc-collapse, focusing more on accessibility.
rc-collapse
rc-collapse ui component for react
Development
npm install
npm start
Example
http://localhost:8000/examples/
online example: http://react-component.github.io/collapse/
Features
- support ie8,ie8+,chrome,firefox,safari
Install
Usage
var Collapse = require('rc-collapse');
var Panel = Collapse.Panel;
var React = require('react');
var ReactDOM = require('react-dom');
var collapse = (
<Collapse accordion={true}>
<Panel header="hello">this is panel content</Panel>
<Panel header="title2">this is panel content2 or other</Panel>
</Collapse>
);
ReactDOM.render(collapse, container);
API
Collapse
props:
name | type | default | description |
---|
activeKey | Array|String | The first panel key | current active Panel key |
---|
defaultActiveKey | Array|String | null | default active key |
---|
accordion | Boolean | false | accordion mode, default is null, is collapse mode |
---|
onChange | Function(key) | noop | called when collapse Panel is changed |
---|
If accordion
is null or false, every panel can open. Opening another panel will not close any of the other panels
activekey
should be an array, a string will work fine, activekey will be an
array, and the only item is the activeKey string provided.
If accordion
is true, only one panel can be open. Opening any one panel will cause the previously opened panel to close.
activekey
should be an string, but array is support too, just use the first
item.
Collapse.Panel
props
name | type | default | description |
---|
header | String or node | | header content of Panel |
---|
key
If key
is not provided, the panel's index will be used instead.
Test Case
npm test
npm run chrome-test
Coverage
npm run coverage
open coverage/ dir
License
rc-collapse is released under the MIT license.