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 |
drag | Boolean | enable draggable functions | |
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 |
dragStart | Function (e, data) | noop | if drag is enabled, this function will be called once the tab start dragging |
onDrag | Function (e, data) | noop | if drag is enabled, this function will be called once the tab on dragging |
dragStop | Function (e, data) | noop | if drag is enabled, this function will be called once the tab stop dragging |
onSwap | Function (fromIndex, toIndex) | noop | when data is swapped |
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 | |
className | String or object | custom className to apply |
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.