Miss any of our Open RFC calls?Watch the recordings here! »

mk-toast

1.4.0 • Public • Published

mk-toast

Library agnostic notifier with Vue.js connector. Mobile friendly and compact. Smooth CSS animation with no twitching.

screenshot

Demo and details

Installation

 npm install --save mk-toast

Inclusion

Browser

<link  href="nodes_modules/mk-toast/dist/mk-toast.min.css" rel="stylesheet">
<script src="nodes_modules/mk-toast/dist/mk-toast.min.js"></script>

Build systems

var mktoast = require('mk-toast'); // reads es5 version
// or 
import mktoast from 'mk-toast'; // this will take es6 module

Don't forget to include css styles

Vue.js

To use it anywhere inside components (without inclusion in every file), add in main.js:

import mktoast from 'mk-toast/vue';
Vue.use(mktoast);

You don't have to include styles in this case, 'cos styles are already included in Vue connector.

Then in any vue component you can use this.$mktoast:

this.$mktoast.echo(message [,title] [,options]);
this.$mktoast.success(message [,title] [,options]);
...

To use it in a router or vuex, which does not have vue context, use regular es6 approach:

import mktoast from 'mk-toast';
mktoast.echo('your message');

Usage

mktoast.echo(message [,title] [,options]);
mktoast.success(message [,title] [,options]);
mktoast.danger(message [,title] [,options]);
mktoast.warning(message [,title] [,options]);
mktoast.info(message [,title] [,options]);
 
// most universal usage
mktoast.print(options);

Options

option type default comment
position string 'right bottom' Positioning of mktoast: left center right top bottom
duration milliseconds 5000 Time to keep toast message on screen
container DOMElement null Parent DOMElement of toast messages, default is body
type string 'default' Used only in mktoast.print(). Types of message: default, info, danger, success, warning.
message string 'empty' Used only in mktoast.print(). String or html code of message.
title string undefined Used only in mktoast.print(). String of toast title.

Demo and details

Install

npm i mk-toast

DownloadsWeekly Downloads

9

Version

1.4.0

License

MIT

Unpacked Size

1.55 MB

Total Files

21

Last publish

Collaborators

  • avatar