# easy-notify-vanilla

> ------------------------------

Latest version **0.2.7** (published 2024-02-17) · 0 weekly downloads

## Install

```sh
npm install easy-notify-vanilla
pnpm add easy-notify-vanilla
yarn add easy-notify-vanilla
bun add easy-notify-vanilla
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.7 |
| Published | 2024-02-17 |
| First published | 2023-04-02 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 70.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | misha-yan |
| Keywords | notify, notification, toast, alert, message, vanilla |

## Links

- npm: https://www.npmjs.com/package/easy-notify-vanilla
- npm.io page: https://npm.io/package/easy-notify-vanilla

## Dependencies (1)

- [sass](https://npm.io/package/sass.md) ^1.71.0

## 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
- [react-simple-toasts](https://npm.io/package/react-simple-toasts.md) — 1.9K weekly downloads

## Recent versions

- 0.2.7 (latest) — 2024-02-17
- 0.2.6 — 2023-04-03
- 0.2.5 — 2023-04-03
- 0.2.4 — 2023-04-03
- 0.2.3 — 2023-04-03
- 0.2.2 — 2023-04-03
- 0.2.1 — 2023-04-03
- 0.1.10 — 2023-04-03
- 0.1.9 — 2023-04-03
- 0.1.8 — 2023-04-03
- 0.1.6 — 2023-04-03
- 0.1.5 — 2023-04-03
- 0.1.4 — 2023-04-03
- 0.1.3 — 2023-04-03
- 0.1.2 — 2023-04-03
- … 2 more at https://npm.io/package/easy-notify-vanilla/versions

## README

# Easy Notification Packgae
------------------------------

## Description
This package is doing somthing you are probably too lazy to do. 
Using this package you will be able to run simple notifications on you page. 

## installation

```
 npm i easy-notify-vanilla
```

### Setup

to use the notification import the one and only function:

```javascript
import { notify } from 'easy-notify-vanilla';
```

### How to use it
__________________

#### Must have:
---------------
the first object is a *must have* which will provide you with the simplest notification possible

type: the type of the notification - can be: "success" | "error" | "warning" | "info"

message: "this is a message" can be what ever you want

Example:
```javascript
notify({type: "success", message: "Hello World"});
```

#### Optional values:
---------------------

in optional values object you can add diffrent configurations that you may need or not, setting up various styling options.

###### The Options:

isIcon: = true/false - each type has it's own specific icon;
  
timeout: number - this is configured in ms => 1s = 1000ms

position: you can change the position of the notification: 
"top-left" | "top-right" | "bottom-left" | "bottom-right"

isCloseButton: = true/false - add a close button that can close the notification.

isProgress: true/false - adds a progress bar for the time that the notification is working.

top: false/number - distance from top if false defualt value.

bottom: false/number - distance from bottom if false defualt value.

left: false/number - distance from left if false defualt value.

right: false/number - distance from right if false defualt value.

height: false/number - custom height if false defualt value.

width: false/number - custom width if false defualt value.

##### Examples:
---------------

```javascript
  notify({type: "success", message: "Hello World"},{isProgress: true, isIcon: true, isCloseButton: true})
```

```javascript
  notify({type: "info", message: "Hello World"},{position: "bottom-left", isIcon:true, isCloseButton: true})
```

```javascript
  notify({type: "error", message: "Hello World"},{position: "top-right", isProgress: true, isCloseButton: true})

```

##### Github:

[Link to Github](https://github.com/MishaYanov/npm-modules-easy-notify-vanilla)

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