# noty-noty

> Beautiful customizable notifications with no jQuery depencies

Latest version **0.0.6** (published 2017-07-04) · 0 weekly downloads

## Install

```sh
npm install noty-noty
pnpm add noty-noty
yarn add noty-noty
bun add noty-noty
```

## 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.6 |
| Published | 2017-07-04 |
| First published | 2017-06-13 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Samuel Amoah |
| Maintainers | snamoah |
| Keywords | notifications, ui, react |

## Links

- npm: https://www.npmjs.com/package/noty-noty
- npm.io page: https://npm.io/package/noty-noty

## Dependencies (1)

- [underscore](https://npm.io/package/underscore.md) ^1.8.3

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.0.6 (latest) — 2017-07-04
- 0.0.5 — 2017-06-13
- 0.0.4 — 2017-06-13
- 0.0.3 — 2017-06-13
- 0.0.2 — 2017-06-13
- 0.0.1 — 2017-06-13

## README

# Noty, A customizable Javascript notification library

Noty is a small javascript notification library that doesn't depend on jQuery. It can
easily be used in your client side applications regardless of the framework

### Installation
Add the package npm package into your project directory like so:
```bash
$ yarn add noty-noty
```


### Usage
Just use it by importing the library

```javascript
import Noty from 'noty-noty';

const ExampleComponent = (props) => {

  const handleClick = () => {
    Noty({
      type: 'primary',
      message: 'Hi there, Welcome back to our app',
    });
  };

  return (
    <button onClick={handleClick}>Click me!</button>
  );
}
```

### Options

Below shows a list of options you can pass to Noty

| Option  | Description | Example Values |
|---------|-------------|----------|
| type    | Sets the type of alert to show it. (default: `primary`) | `primary`, `success`, `info`, `danger` |
| icon    | Sets an icon for the alert. You can pass it any icon classes you have configured (default: "") | `fa fa-info-circle`, `glyphicon glyphicon-envelope` |
| html    | Option to pass html content. When option is set, title and message options are not used (default: null) | `<h3>Example</h3>` |
| title   | Sets a heading for the alert (default: "") | - |
| message | Sets a message body (default: "") | - |
| closeBtn | Shows a close button that allows users to close alert (default: true) | - |
| timer | Set timer delay to show alert before disappearing (default: 500) | - |
| onShow | Set handler to run right before alert is shown | - |
| onShown | Set handler to run after alert is shown | - |
| onHide | Set handler function to run right before it is hidden | - |
| onHidden | Set handler function to run after it is hidden | - |


### TODO
  * option for page banner alert
  * option for panel level alert


### Contributing

Feel free to create an issue or pull request if there's something you wish to be added to
it

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