rc-notification
    TypeScript icon, indicating that this package has built-in type declarations

    4.5.7 • Public • Published

    rc-notification

    React Notification UI Component

    NPM version dumi build status Test coverage Dependencies DevDependencies npm download bundle size

    Install

    rc-notification

    Usage

    import Notification from 'rc-notification';
    
    Notification.newInstance({}, notification => {
      notification.notice({
        content: 'content'
      });
    });

    Compatibility

    IE / Edge
    IE / Edge
    Firefox
    Firefox
    Chrome
    Chrome
    Safari
    Safari
    Electron
    Electron
    IE11, Edge last 2 versions last 2 versions last 2 versions last 2 versions

    Example

    http://localhost:8001

    online example: https://notification-react-component.vercel.app

    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
    maxCount number max notices show, drop first notice if exceed limit

    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.
    closeIcon ReactNode specific the close icon.
    props Object An object that can contain data-*, aria-*, or role props, to be put on the notification div. This currently only allows data-testid instead of data-* in TypeScript. See https://github.com/microsoft/TypeScript/issues/28960.

    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.

    Install

    npm i rc-notification

    DownloadsWeekly Downloads

    359,660

    Version

    4.5.7

    License

    MIT

    Unpacked Size

    53.9 kB

    Total Files

    22

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar