# Note.js

> A lightweight and elegant notifications library

Latest version **0.0.4** (published 2016-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install Note.js
pnpm add Note.js
yarn add Note.js
bun add Note.js
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2016-11-07 |
| First published | 2016-11-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 25 |
| Author | Gregory |
| Maintainers | chmln |
| Keywords | javascript, notifications, notification, library, lightweight, simple |

## Links

- npm: https://www.npmjs.com/package/Note.js
- Repository: https://github.com/chmln/Note.js
- Issues: https://github.com/chmln/Note.js/issues
- npm.io page: https://npm.io/package/Note.js

## Alternatives

- [update-check](https://npm.io/package/update-check.md) — 4.0M weekly downloads
- [react-native-onesignal](https://npm.io/package/react-native-onesignal.md) — 134.5K weekly downloads
- [react-redux-toastr](https://npm.io/package/react-redux-toastr.md) — 33.7K weekly downloads
- [@nocobase/plugin-notification-manager](https://npm.io/package/@nocobase/plugin-notification-manager.md) — 2.0K weekly downloads
- [@okxweb3/coin-bitcoin](https://npm.io/package/@okxweb3/coin-bitcoin.md) — 1.5K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2016-11-07
- 0.0.3 — 2016-11-06
- 0.0.2 — 2016-11-06

## README

# Note.js
Elegant, lightweight & simple notification library.

![Note.js - lightweight javascript notifications](https://cloud.githubusercontent.com/assets/11352152/20041472/8e647b32-a437-11e6-9dfe-05f1c3b60b7f.png)
![Note.js - vanilla js notification library](https://cloud.githubusercontent.com/assets/11352152/20041473/8e6ef3be-a437-11e6-9e6b-c64d6564f205.png)


**Why another notification library?**

Existing js notification libraries are either:
* Forcing you to load jQuery, Bootstrap, or something else totally unnecessary
* ~~Ugly~~
* Specific to a certain framework
* Painful to use with bundlers, such as Webpack

Note.js is:
* **Lightweight** - `< 2kb` js+css
* **Framework-agnostic** (use it in React, Angular, Vue, or in plain HTML/JS environment)
* Compatible with **IE10+** and all major browsers

### Getting Started

`npm install Note.js --save` or [download](https://github.com/chmln/Note.js/releases) a release

```js
// Start by creating an instance. Overriding default config is optional
const note = new Note({}); // Note
```

Then,
```js
note.success(title, text, config);
note.info(title, text, config);
note.error(title, text, config);
note.warn(title, text, config);
note.notify(title, text, config); // colorless
```

You can customize the duration, and make the notification sticky.
```js
note.success("Success!", "But I'm not going anywhere..yet", { sticky: true });
note.info("Hey!", "I'm leaving in 5 seconds", { duration: 5 });
```

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