# vue-toast-mobile

> A mobile toast component for vue.js

Latest version **2.0.0** (published 2016-10-25) · MIT license · 0 weekly downloads

## Install

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

## 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 | 2.0.0 |
| Published | 2016-10-25 |
| First published | 2016-05-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 143 |
| Author | yi.shyang@ele.me |
| Maintainers | yi.yang |

## Links

- npm: https://www.npmjs.com/package/vue-toast-mobile
- Repository: https://github.com/ElemeFE/vue-toast-mobile
- Homepage: https://github.com/Elemefe/vue-toast-mobile#readme
- Issues: https://github.com/Elemefe/vue-toast-mobile/issues
- npm.io page: https://npm.io/package/vue-toast-mobile

## Recent versions

- 2.0.0 (latest) — 2016-10-25
- 0.1.3 — 2016-06-05
- 0.1.2 — 2016-05-26
- 0.1.1 — 2016-05-19
- 0.1.0 — 2016-05-19
- 0.0.8 — 2016-05-11
- 0.0.7 — 2016-05-06
- 0.0.6 — 2016-05-06
- 0.0.4 — 2016-05-05
- 0.0.3 — 2016-05-05
- 0.0.2 — 2016-05-05
- 0.0.1 — 2016-05-05

## README

# Overview
vue-toast-mobile is a mobile toast plugin for vue.js.

# Installation
First, install `vue-toast-mobile` from npm:
```bash
$ npm install vue-toast-mobile
```

Then use it:
```Javascript
// ES6 mudule
import Toast from 'vue-toast-mobile';

// CommonJS
const Toast = require('vue-toast-mobile').default;
```

# Usage
Basically you can pass a string to `Toast`:
```Javascript
Toast('Upload Completed');
```
Or invoke `Toast` with an object as its configuration:
```Javascript
Toast({
  message: 'Upload Completed',
  position: 'bottom',
  duration: 5000
});
```

# API
| Option    | Description                                    | Value                   | Default  |
|-----------|------------------------------------------------|-------------------------|----------|
| message   | content of the toast                           |                         |          |
| position  | location of the toast relative to viewport     | 'top' 'bottom' 'middle' | 'middle' | 
| duration  | time before the toast vanishes, in millisecond |                         | 3000     |
| className | custom class name of the toast                 |                         |          |
| iconClass | class name of the optional icon font           |                         |          |

# License
MIT

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