{"id":27300884,"url":"https://github.com/zerox-dg/noticez","last_synced_at":"2025-07-31T14:12:38.515Z","repository":{"id":109052350,"uuid":"72407930","full_name":"ZeroX-DG/NoticeZ","owner":"ZeroX-DG","description":"A javascript library for creating \"web\" push notifications","archived":false,"fork":false,"pushed_at":"2018-01-24T14:38:15.000Z","size":355,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-19T08:17:33.357Z","etag":null,"topics":["javascript","javascript-library","nodejs","notifications","push-notifications"],"latest_commit_sha":null,"homepage":"https://zerox-dg.github.io/NoticeZ/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ZeroX-DG.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-10-31T06:14:26.000Z","updated_at":"2023-09-08T17:16:32.000Z","dependencies_parsed_at":"2023-03-09T21:30:29.078Z","dependency_job_id":null,"html_url":"https://github.com/ZeroX-DG/NoticeZ","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/ZeroX-DG/NoticeZ","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZeroX-DG%2FNoticeZ","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZeroX-DG%2FNoticeZ/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZeroX-DG%2FNoticeZ/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZeroX-DG%2FNoticeZ/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ZeroX-DG","download_url":"https://codeload.github.com/ZeroX-DG/NoticeZ/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZeroX-DG%2FNoticeZ/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268053744,"owners_count":24188090,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-31T02:00:08.723Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","javascript-library","nodejs","notifications","push-notifications"],"created_at":"2025-04-12T01:26:27.228Z","updated_at":"2025-07-31T14:12:38.510Z","avatar_url":"https://github.com/ZeroX-DG.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NoticeZ\n\n[![NoticeZ](https://img.shields.io/badge/build-passing-brightgreen.svg)](https://github.com/ZeroX-DG/NoticeZ)\n\nNoticeZ 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.\n\n## Installation:\nYou can install it via npm\n```\nnpm install noticez\n```\nThis library can be use for both browser and nodeJs web app.\n\n\u003cbr\u003e\n\n```javascript\n// for nodejs\nlet NoticeZ = require('noticez');\nNoticeZ('hello', 'this is a notification');\n\n// for browser\n\u003cscript src='path/to/NoticeZ.js'\u003e\u003c/script\u003e\n\u003cscript\u003e\n\tNoticeZ('hello', 'this is a notification')\n\u003c/script\u003e\n```\n\n## How to use ?\n\nCheckout the full documment at:\nhttps://zerox-dg.github.io/NoticeZ/\n\n### Syntax\n\nThis is how you call the library\n\n```javascript\nNoticeZ( \u003ctitle\u003e , \u003ccontent\u003e , \u003coptions\u003e )\n```\n\nIn there:\n\n- title (string) (required) : Indicate the title of the notification\n- content (string) (required) : This is the content of the notification\n- options (object) (optional) : This is the config for the notification\n\n### Basic notification\n\nTo create a basic notification, you will only need to specify the title and content of the notification then let the library do the rest.\n\n```javascript\nNoticeZ (\"Success\", \"A task has been successfully executed !\")\n```\n\n### Custom time and position notification\n\nTo customize \"time until disappear\" of a notification, you can specify the time property in the options.\n\n```javascript\nlet options = {\n  time: 3000 //3secs\n}\nNoticeZ ( 'Hello' , 'Good bye in 3 secs' , options )\n```\n\nTo change the position of the notification, the position property has been provided. \nThere are 4 different types of position:\n\n- top left\n- top right\n- bottom left\n- bottom right\n\n```javascript\nlet options = {\n  position: 'top right' ,\n  time: 5000 // 5 secs\n}\nNoticeZ ( 'Hello' , 'Good bye in 5 secs' , options )\n```\n## Todos\n\n- [x] Allow notifications to appear forever (if time is negative)\n- [x] Allow html in notification\n- [ ] One line notification\n- [ ] Add entrance transition effects\n- [ ] Add out transition effects\n- [ ] Allow pin notification\n\n## Contributing\nPRs are welcome ! don't hesitate to submit one !\n\n## Contact\nviethungax@gmail.com\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzerox-dg%2Fnoticez","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzerox-dg%2Fnoticez","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzerox-dg%2Fnoticez/lists"}