# awesome-vue-toast

> awesome vue2 simple toast

Latest version **1.0.5** (published 2017-04-06) · 0 weekly downloads

## Install

```sh
npm install awesome-vue-toast
pnpm add awesome-vue-toast
yarn add awesome-vue-toast
bun add awesome-vue-toast
```

## 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.5 |
| Published | 2017-04-06 |
| First published | 2017-03-28 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4.0.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Salam Hiyali |
| Maintainers | hiyaliorg |

## Links

- npm: https://www.npmjs.com/package/awesome-vue-toast
- npm.io page: https://npm.io/package/awesome-vue-toast

## Dependencies (2)

- [vue](https://npm.io/package/vue.md) ^2.1.0
- [stylus-loader](https://npm.io/package/stylus-loader.md) ^2.4.0

## Recent versions

- 1.0.5 (latest) — 2017-04-06
- 1.0.3 — 2017-03-28
- 1.0.2 — 2017-03-28
- 1.0.1 — 2017-03-28
- 1.0.0 — 2017-03-28

## README

# awesome-vue-toast
:whale: awesome vue2 simple toast

[![npm package](https://img.shields.io/npm/v/awesome-vue-toast.svg)](https://www.npmjs.com/package/awesome-vue-toast)


* Can be singleton
* Programmable

Changed from [AStaroverov/vue-toast](https://github.com/AStaroverov/vue-toast)

## Example

[Live demo](https://hiyali.github.io/awesome-vue-toast)

### Screenshot

![screenshot](https://raw.githubusercontent.com/hiyali/awesome-vue-toast/master/assets/toast-screenshot.png "screenshot")

## Install

```shell
npm i -S awesome-vue-toast
```

## Usage
```javascript
import Toast from 'awesome-vue-toast'
...
Toast.showToast('Enjoy toast!')
```

### Singleton

```html
<body>
  ...
  <script src="./awesome-vue-toast/build/js/toast.js"></script>
  <script>
    ...
    Toast.showToast('Enjoy toast!')
    ...
  </script>
  ...
</body>
```

## Option
```javascript
Toast.addMessage({
  text: 'This is success type',
  type: 'success',
  dismissAfter: 3 * 1000
})
```

| option         | type       |  default      | other value  |
| :------------- | :--------- | :------------ | :----------- |
| `text`         | `String`   |               |              |
| `type`         | `String`   | info          | success, warning, danger |
| `dismissAfter` | `Int`      | 5 * 1000      | milliseconds |

## Development / build
```shell
npm run dev # development
npm run build # build
```

## For customization props

| props         | default    | other value    | description    |
| :------------ | :--------- | :------------- | :------------- |
| `position`    | se         | n, s, nw, ne, sw, se | north, south, north west, ... |

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