https://github.com/zerox-dg/noticez
A javascript library for creating "web" push notifications
https://github.com/zerox-dg/noticez
javascript javascript-library nodejs notifications push-notifications
Last synced: 11 months ago
JSON representation
A javascript library for creating "web" push notifications
- Host: GitHub
- URL: https://github.com/zerox-dg/noticez
- Owner: ZeroX-DG
- License: mit
- Created: 2016-10-31T06:14:26.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-01-24T14:38:15.000Z (over 8 years ago)
- Last Synced: 2025-04-19T08:17:33.357Z (about 1 year ago)
- Topics: javascript, javascript-library, nodejs, notifications, push-notifications
- Language: JavaScript
- Homepage: https://zerox-dg.github.io/NoticeZ/
- Size: 347 KB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NoticeZ
[](https://github.com/ZeroX-DG/NoticeZ)
NoticeZ is a library for creating web push notification, which means it will creates a html notification using JS then append it to the website body.
## Installation:
You can install it via npm
```
npm install noticez
```
This library can be use for both browser and nodeJs web app.
```javascript
// for nodejs
let NoticeZ = require('noticez');
NoticeZ('hello', 'this is a notification');
// for browser
NoticeZ('hello', 'this is a notification')
```
## How to use ?
Checkout the full documment at:
https://zerox-dg.github.io/NoticeZ/
### Syntax
This is how you call the library
```javascript
NoticeZ( , , )
```
In there:
- title (string) (required) : Indicate the title of the notification
- content (string) (required) : This is the content of the notification
- options (object) (optional) : This is the config for the notification
### Basic notification
To create a basic notification, you will only need to specify the title and content of the notification then let the library do the rest.
```javascript
NoticeZ ("Success", "A task has been successfully executed !")
```
### Custom time and position notification
To customize "time until disappear" of a notification, you can specify the time property in the options.
```javascript
let options = {
time: 3000 //3secs
}
NoticeZ ( 'Hello' , 'Good bye in 3 secs' , options )
```
To change the position of the notification, the position property has been provided.
There are 4 different types of position:
- top left
- top right
- bottom left
- bottom right
```javascript
let options = {
position: 'top right' ,
time: 5000 // 5 secs
}
NoticeZ ( 'Hello' , 'Good bye in 5 secs' , options )
```
## Todos
- [x] Allow notifications to appear forever (if time is negative)
- [x] Allow html in notification
- [ ] One line notification
- [ ] Add entrance transition effects
- [ ] Add out transition effects
- [ ] Allow pin notification
## Contributing
PRs are welcome ! don't hesitate to submit one !
## Contact
viethungax@gmail.com