# react-toaster-js

> a simple react toaster

Latest version **0.0.1** (published 2016-12-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-toaster-js
pnpm add react-toaster-js
yarn add react-toaster-js
bun add react-toaster-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.1 |
| Published | 2016-12-15 |
| First published | 2016-12-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Joseph Clay |
| Maintainers | josephclay |

## Links

- npm: https://www.npmjs.com/package/react-toaster-js
- Repository: https://github.com/JosephClay/react-toaster-js
- Homepage: https://github.com/JosephClay/react-toaster-js#readme
- Issues: https://github.com/JosephClay/react-toaster-js/issues
- npm.io page: https://npm.io/package/react-toaster-js

## Dependencies (2)

- [classnames](https://npm.io/package/classnames.md) ^2.2.5
- [overload-js](https://npm.io/package/overload-js.md) ^1.0.0

## Recent versions

- 0.0.1 (latest) — 2016-12-15

## README

# react-toaster-js

`npm i -S react-toaster-js`

## Component

```js
const { Toaster } = require('react-toaster-js')

// place where you'd like in your app
module.exports = () => <Toaster />;
```


## Usage

```js
const toaster = require('react-toaster-js');

// display an info toast with no title
toastr.info('Are you the 6 fingered man?')

// display a warning toast, with no title
toastr.warning('My name is Inigo Montoya. You killed my father, prepare to die!')

// display a success toast, with a title
toastr.success('Have fun storming the castle!', 'Miracle Max Says')

// display an error toast, with a title
toastr.error('I do not think that word means what you think it means.', 'Inconceivable!')

// remove all toasts without using animation
toastr.remove()

// override global options
toastr.success('We do have the Kapua suite available.', 'Turtle Bay Resort', { timeOut: 5000 })
```

## Options

`position: String`
The position to mount the toaster. Possible values: `top-right`, `top-left`, `bottom-right`, `bottom-left`. Defaults to `top-right`.

`type: String`
The type of toast to throw. Possible values: `success`, `danger`, `info`, `warning`. Defaults to `''` (standard).

`className: String`
Adds the class to the toast.

`title: String`
The title of the toast.

`message: String`
The message of the toast

`fade: Number`
The duration to wait until fade, in milliseconds. Defaults to `5000`.

`duration: Number`
The toast display duration, in milliseconds. Defaults to `15000`.

`nofade: Boolean`
Prevents the toast from fading. Defaults to `false`.

`persist: Boolean`
Prevents the toast from expiring. Defaults to `false`.

`dismissible: Boolean`
Whether the toast can be dismissed with a click. Defaults to `true`.


## Styles

### CSS

An `index.css` file is located in the root of the project.

### #SASS

An `index.scss` file is located in the root of the project.

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