# simple-toast-notification

> Configurable react toast notifications

Latest version **1.0.8** (published 2020-07-11) · ISC license · 0 weekly downloads

## Install

```sh
npm install simple-toast-notification
pnpm add simple-toast-notification
yarn add simple-toast-notification
bun add simple-toast-notification
```

## 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.8 |
| Published | 2020-07-11 |
| First published | 2020-03-20 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 7.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Sanskar Gupta |
| Maintainers | snskr95 |

## Links

- npm: https://www.npmjs.com/package/simple-toast-notification
- Repository: https://github.com/Sanskar95/snack-toast
- Homepage: https://github.com/Sanskar95/snack-toast#readme
- Issues: https://github.com/Sanskar95/snack-toast/issues
- npm.io page: https://npm.io/package/simple-toast-notification

## Dependencies (5)

- [react](https://npm.io/package/react.md) ^16.13.1
- [react-dom](https://npm.io/package/react-dom.md) ^16.13.1
- [@babel/core](https://npm.io/package/@babel/core.md) ^7.9.0
- [@material-ui/core](https://npm.io/package/@material-ui/core.md) ^4.9.7
- [@material-ui/icons](https://npm.io/package/@material-ui/icons.md) ^4.9.1

## Recent versions

- 1.0.8 (latest) — 2020-07-11
- 1.0.7 — 2020-07-11
- 1.0.6 — 2020-07-11
- 1.0.5 — 2020-07-11
- 1.0.4 — 2020-07-11
- 1.0.3 — 2020-07-11
- 1.0.2 — 2020-03-22
- 1.0.1 — 2020-03-20
- 1.0.0 — 2020-03-20

## README

## Simple Toast Notification

This component is used to generate alerts after an action, for example successful rest call.

## Using the Component

To be able to use the component, follow the steps below:

- Install simple-toast-notification in your application, this will install the latest release:
`npm i simple-toast-notification@latest --save`

- Import the component:
`import { snackToast } from 'simple-toast-notification'`

## API
 There are 4 methods under the snackToast API.
 1) success
 2) error
 3) warning
 4) info
 
 Every method flavour accepts an object having following fields.
 
 1)message - The message string to be displayed on the toast.
 
 2)showDismissButton - Its a flag that determines whether to show the manual dismiss button on the toast.
 
 3)autoHideDuration: Time in ms after that the toast goes away, the default is 3200 ms
     
     
     
## Example
      snackToast.success({
                    message: 'This is a success message',
                    showDismissButton: false,
                    autoHideDuration: 50000
                  })

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