README.md
rc-notification
React Notification UI Component
Development
npm install
npm startExample
http://localhost:8000/examples/
online example: http://react-component.github.io/notification/examples/
Feature
- support ie9,ie9+,chrome,firefox,safari
install
Usage
var Notification = require('rc-notification');
Notification.newInstance({}, notification => {
notification.notice({
content: 'content'
});
});API
Notification.newInstance(props, (notification) => void) => void
props details:
| name | type | default | description |
|---|---|---|---|
| prefixCls | String | prefix class name for notification container | |
| style | Object | {'top': 65, left: '50%'} | additional style for notification container. |
| getContainer | getContainer(): HTMLElement | function returning html node which will act as notification container |
notification.notice(props)
props details:
| name | type | default | description |
|---|---|---|---|
| content | React.Element | content of notice | |
| key | String | id of this notice | |
| closable | Boolean | whether show close button | |
| onClose | Function | called when notice close | |
| duration | number | 1.5 | after duration of time, this notice will disappear.(seconds) |
| style | Object | { right: '50%' } | additional style for single notice node. |
| maxCount | number | max notices show, drop first notice if exceed limit | |
| closeIcon | ReactNode | specific the close icon. |
notification.removeNotice(key:string)
remove single notice with specified key
notification.destroy()
destroy current notification
Test Case
npm test
npm run chrome-testCoverage
npm run coverageopen coverage/ dir
License
rc-notification is released under the MIT license.
