# js-notifier

> A Vanilla built-in library that lets you add toast notifications to your app in an easy way.

Latest version **1.0.0** (published 2022-04-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install js-notifier
pnpm add js-notifier
yarn add js-notifier
bun add js-notifier
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-04-25 |
| First published | 2022-04-25 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 23.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Angelo Nazzaro |
| Maintainers | sl1msha4dey |
| Keywords | toast, notification, library, vanilla, js, css3, html5, es6 |

## Links

- npm: https://www.npmjs.com/package/js-notifier
- Repository: https://github.com/sl1mSha4dey/NotificationJS
- Homepage: https://github.com/sl1mSha4dey/NotificationJS#readme
- Issues: https://github.com/sl1mSha4dey/NotificationJS/issues
- npm.io page: https://npm.io/package/js-notifier

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.0 (latest) — 2022-04-25

## README

# NotificationJS

NotificationJS is a personal project that I used to improve my front-end skills. <br>
It is build completely using ```Javascript Vanilla```, ```CSS3``` and ```HTML5```. No frameworks or third-party libraries used. <br>
This project was inspired by [React-toastify](https://fkhadra.github.io/react-toastify/introduction/) and [Web dev Simplified](https://www.youtube.com/c/WebDevSimplified). 

## Usage

```javascript
import Toast from "/yourpathtothelib/Toast.js";

// instantiate toast
new Toast({
  text: "Hello World! :) (very original huh)",
  progressBar: true,
  autoClose: 5000,
  animation: "bounce"
})
```

## Features

- Define the lifetime of the toast
- Super customizable (styles, icons, type)
- Pause toast when the window loses focus
- Pause toast when the user hovers over it
- Has ```onClose``` hook
- Dark mode
- Define your animation
- Much more :D

## Options

| Option              | Type                    | Description  |
| -------------       |:-------------:          | -----        |
| text                | string                  |  Sets the text content of the toast. |
| position            | string                  |  Places the toast container in one of the following positions: top-right, top-left, bottom-left, bottom-right. |
| onClose             | function                |  Defines what should be done after the toast has been closed. |
| progressBar         | bool                    |  Defines if the toast should have a progress bar or not. |
| autoClose           | number \| bool          |  Sets the lifetime of the toast. If 0 or false the progress bar will not be displayed even if the ```progressBar```                                                      option has been                                      set to ```true```. |
| closeOnClick        | bool                    |  If set to ```true``` makes the toast disappear when clicked. |
| pauseOnHover        | bool                    |  If set to ```true``` makes the "toast aging" paused when hovered. |
| pauseOnFocusLoss    | bool                    |  If set to ```true``` makes the "toast aging" paused when the window loses focus. Ex. the user navigates to a new                                                         tab. |
| newestOnTop         | bool                    |  If set to ```true``` makes the new toast appear above the others. |
| darkMode            | bool                    |  Sets the dark or the light theme. |
| type                | string                  |  Renders the toast with one of the following styles: default (light or dark), success, info, warning, danger,                                                             success-bg, info-bg, warning- bg, danger-bg. |
| styles              | object                  |  Allows to override the default styles of the toast such as background color, color, the color of the progress bar                                                       etc. |
| icon                | string                  |  Sets the icon that will rendered with the text. You must pass the ```d``` attribute of the ```path``` of an                                                             ```svg```. |
| animation           | string                  |  Sets the animation the toast will perform when opened and closed. |
| draggable           | bool                    |  If set to ```true``` makes the toast draggable. When it gets dragged over a certain point, it will begin to fade. |

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change :shipit:

## People I'd like to mention
Again, I'd like to mention @fkhadra and @WebDevSimplified that inspired me to code this project.

## License
License under [MIT](https://choosealicense.com/licenses/mit/)

---
_Source: https://npm.io/package/js-notifier · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._