Skip to content

Latest commit

 

History

History
175 lines (140 loc) · 4.17 KB

README.md

File metadata and controls

175 lines (140 loc) · 4.17 KB

rc-notification


React Notification UI Component

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

Development

npm install
npm start

Example

http://localhost:8000/examples/

online example: http://react-component.github.io/notification/examples/

Feature

  • support ie8,ie8+,chrome,firefox,safari

install

rc-notification

Usage

var Notification = require('rc-notification');
var notification = Notification.newInstance();
notification.notice({
  content: 'content'
});

API

Notification.newInstance(props)

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 { top: 65, left: '50%' } additional style for single notice node.

notification.removeNotice(key:string)

remove single notice with specified key

notification.destroy()

destroy current notification

Test Case

npm test
npm run chrome-test

Coverage

npm run coverage

open coverage/ dir

License

rc-notification is released under the MIT license.