rci-sidebar

0.1.0 • Public • Published

rci-sidebar


React RcSidebar Component

NPM version build status Test coverage gemnasium deps node version npm download

Browser Support

IE Chrome Firefox Opera Safari
IE 8+ ✔ Chrome 31.0+ ✔ Firefox 31.0+ ✔ Opera 30.0+ ✔ Safari 7.0+ ✔

Screenshots

Development

npm install
npm start

Example

http://localhost:8009/examples/

online example: http://react-component.github.io/rc-sidebar/

install

rci-sidebar

Usage

var RcSidebar = require('rci-sidebar');
var React = require('react');
React.render(<RcSidebar />, container);

API

props

Property name Type Default Description
className String '' additional css class of root dom node
prefixCls String 'rci-sidebar' prefix class
children Anything React can render n/a The main content
sidebarStyle object {} Inline styles.
contentStyle object {} Inline styles.
overlayStyle object {} Inline styles.
dragHandleStyle object {} Inline styles.
sidebar Anything React can render n/a The sidebar content
onSetOpen function n/a Callback called when the sidebar wants to change the open prop. Happens after sliding the sidebar and when the overlay is clicked when the sidebar is open.
docked boolean false If the sidebar should be always visible
open boolean false If the sidebar should be open
transitions boolean true If transitions should be enabled
touch boolean true If touch gestures should be enabled
touchHandleWidth number 20 Width in pixels you can start dragging from the edge when the sidebar is closed.
dragToggleDistance number 30 Distance the sidebar has to be dragged before it will open/close after it is released.
pullRight boolean false Place the sidebar on the right

change from https://github.com/balloob/react-sidebar

Test Case

npm test
npm run chrome-test

Coverage

npm run coverage

open coverage/ dir

License

rci-sidebar is released under the MIT license.

Package Sidebar

Install

npm i rci-sidebar

Weekly Downloads

0

Version

0.1.0

License

none

Last publish

Collaborators

  • warmhug