Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/react-component/drawer
React Drawer
https://github.com/react-component/drawer
drawer rc-drawer react
Last synced: 9 days ago
JSON representation
React Drawer
- Host: GitHub
- URL: https://github.com/react-component/drawer
- Owner: react-component
- License: mit
- Created: 2017-11-03T02:55:11.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-10T21:55:09.000Z (6 months ago)
- Last Synced: 2024-05-17T05:43:54.745Z (6 months ago)
- Topics: drawer, rc-drawer, react
- Language: TypeScript
- Homepage: https://drawer-react-component.vercel.app/
- Size: 12.5 MB
- Stars: 407
- Watchers: 22
- Forks: 91
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# rc-drawer
[![NPM version][npm-image]][npm-url] [](https://github.com/umijs/dumi) [![build status][github-actions-image]][github-actions-url] [](https://codecov.io/gh/react-component/drawer) [![node version][node-image]][node-url] [![npm download][download-image]][download-url]
[npm-image]: http://img.shields.io/npm/v/rc-drawer.svg?style=flat-square
[npm-url]: http://npmjs.org/package/rc-drawer
[github-actions-image]: https://github.com/react-component/drawer/workflows/CI/badge.svg
[github-actions-url]: https://github.com/react-component/drawer/actions
[node-image]: https://img.shields.io/badge/node.js-%3E=_0.10-green.svg?style=flat-square
[node-url]: http://nodejs.org/download/
[download-image]: https://img.shields.io/npm/dm/rc-drawer.svg?style=flat-square
[download-url]: https://npmjs.org/package/rc-drawer
## Example
https://drawer-react-component.vercel.app/
## Usage
```js
import Drawer from 'rc-drawer';
import React from 'react';
import ReactDom from 'react-dom';
ReactDom.render(
{menu children}
, mountNode);
```
## Install
[](https://npmjs.org/package/rc-drawer)
## Browser Support
|  |  |  |  |  |
| ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| IE 10+ ✔ | Chrome 31.0+ ✔ | Firefox 31.0+ ✔ | Opera 30.0+ ✔ | Safari 7.0+ ✔ |
## API
| props | type | default | description |
| ------------------ | --------------------------------------------------------------------------- | -------------------------------------- | ----------------------------------------------------------------------------- |
| className | string | null | - |
| classNames | { mask?: string; content?: string; wrapper?: string; } | - | pass className to target area |
| styles | { mask?: CSSProperties; content?: CSSProperties; wrapper?: CSSProperties; } | - | pass style to target area |
| prefixCls | string | 'drawer' | prefix class |
| width | string \| number | null | drawer content wrapper width, drawer level transition width |
| height | string \| number | null | drawer content wrapper height, drawer level transition height |
| open | boolean | false | open or close menu |
| defaultOpen | boolean | false | default open menu |
| placement | string | `left` | `left` `top` `right` `bottom` |
| level | string \| array | `all` | With the drawer level element. `all`/ null / className / id / tagName / array |
| levelMove | number \| array \| func | null | level move value. default is drawer width |
| duration | string | `.3s` | level animation duration |
| ease | string | `cubic-bezier(0.78, 0.14, 0.15, 0.86)` | level animation timing function |
| getContainer | string \| func \| HTMLElement | `body` | Return the mount node for Drawer. if is `null` use React.creactElement |
| showMask | boolean | true | mask is show |
| maskClosable | boolean | true | Clicking on the mask (area outside the Drawer) to close the Drawer or not. |
| maskStyle | CSSProperties | null | mask style |
| afterOpenChange | func | null | transition end callback(open) |
| onClose | func | null | close click function |
| keyboard | boolean | true | Whether support press esc to close |
| autoFocus | boolean | true | Whether focusing on the drawer after it opened |
| onMouseEnter | React.MouseEventHandler\ | - | Trigger when mouse enter drawer panel |
| onMouseOver | React.MouseEventHandler\ | - | Trigger when mouse over drawer panel |
| onMouseLeave | React.MouseEventHandler\ | - | Trigger when mouse leave drawer panel |
| onClick | React.MouseEventHandler\ | - | Trigger when mouse click drawer panel |
| onKeyDown | React.MouseEventHandler\ | - | Trigger when mouse keydown on drawer panel |
| onKeyUp | React.MouseEventHandler\ | - | Trigger when mouse keyup on drawer panel |
> 2.0 Rename `onMaskClick` -> `onClose`, add `maskClosable`.
## Development
```
npm install
npm start
```