https://github.com/firstandthird/notice

jquery notification library
https://github.com/firstandthird/notice

Last synced: 3 days ago
JSON representation

jquery notification library

• Host: GitHub
• URL: https://github.com/firstandthird/notice
• Owner: firstandthird
• License: mit
• Created: 2012-04-09T20:04:42.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2017-12-20T09:18:59.000Z (about 7 years ago)
• Last Synced: 2025-01-16T00:47:14.799Z (7 days ago)
• Language: JavaScript
• Homepage:
• Size: 167 KB
• Stars: 3
• Watchers: 10
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Notice

Notice is a plugin for simple notifications.

## Installation

`npm install @firstandthird/notice`

## Usage

Import notice:

```javascript

  import Notice form 'notice';

  Notice('Test Notification');

```

Import [default CSS styles](styles.css)

## Notice(message, [options])

`message` {string} - Notice text to display

List of options:

| Option      | Default                                                                         | Action                        |

|-------------|---------------------------------------------------------------------------------|-------------------------------|

| `level`     | _{string='default'}_ Options: 'default', 'info', 'success', 'warning', 'error'} | Type of alert                 |

| `timeout`   | _{number=5000}_                                                                 | Timeout before auto closing   |

| `container` | _{string|Element|NodeList='body'}_                                              | Container to append notice to |

| `showClose` | _{boolean=true}_                                                                | Display close button          |

```javascript

  Notice('My message', {

    level: 'info'

    timeout: 2000,

    container: document.body

    showClose: true

  });

};

```

## License

### MIT License

Copyright (c) 2016 First+Third

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.