@dmuy/mdtoast NPM

Material-Toast

A simple plugin to display a material concept toast (alert message).

DEMO

Larger screen layout:

Material-Toast on large screens

Smaller screen layout:

Material-Toast on small screens

How to use

Include mdtoast.css and mdtoast.js in your html file:

<link rel="stylesheet" type="text/css" href="mdtoast.css">
<script type="text/javascript" src="mdtoast.js"></script>

Call mdtoast() in your script tag:

// Initializes and shows default toast or with the 'new' keyword - i.e new mdtoast(...)
mdtoast('This is a toast message.');

CDN

Use the following if you don't want to host the js and css files:

https://cdn.jsdelivr.net/gh/dmuy/Material-Toast/mdtoast.css
https://cdn.jsdelivr.net/gh/dmuy/Material-Toast/mdtoast.js

Minified version:

https://cdn.jsdelivr.net/gh/dmuy/Material-Toast/mdtoast.min.css
https://cdn.jsdelivr.net/gh/dmuy/Material-Toast/mdtoast.min.js

Learn more about the CDN

Options

You can add options when calling mdtoast() to fit your needs. Below are the options you can use:

Option	Defaut	Description
init	`false`	Determines if toast is initialize-only (meaning toast will not show unless `show()` is called
duration	`5000`	Determines the toast display duration (in milliseconds).
type	`default`	Determines the type of toast to display. Other types in `mdtoast`: `INFO`, `WARNING`, `SUCCESS`, `ERROR`. Or you can just type these string values: `info`, `warning`, `success`, `error`.
modal	`false`	Determines if toast is modal (pointer events on other elements will be disabled).
interaction	`false`	Determines if toast requires user interaction to dismiss or has some sort of user interaction button to click.
interactionTimeout	`null`	Determines the toast duration (timeout to dismiss) if `interaction` is set to `true`. This overrides the `duration` option if `interaction` is set to `true`.
actionText	`OK`	The action text to display for user interaction (e.g. `UNDO` -> showing toast after archiving items and giving the user an option to undo archiving.)
action	`hide()`	This will be the function to be called when the user clicks the action text. The default calls the toast's `hide()` method.
callbacks	`{}`	You can place the callbacks `hidden()` and `shown()` in this option if you have some things to do after the toast is shown or hidden.

Usage sample

Below is an example of storing your toast in a variable for future reuse:

// Initializes default toast with duration of 10 seconds (this will not show the toast since init is set to true)
var myToast = mdtoast('This is a toast message.', { duration: 10000, init: true }); 

// Displays the toast
myToast.show();

Different types of toast:

// Initializes different toasts with duration of 10 seconds
mdtoast('This is an info toast.', { duration: 10000, type: mdtoast.INFO });      // or type: 'info'
mdtoast('This is an error toast.', { duration: 10000, type: mdtoast.ERROR });    // or type: 'error'
mdtoast('This is a warning toast.', { duration: 10000, type: mdtoast.WARNING }); // or type: 'warning'
mdtoast('This is a success toast.', { duration: 10000, type: mdtoast.SUCCESS }); // or type: 'success'

Specifying toast action:

// Initializes a toast with action (this toast will not dismiss unless 'interactionTimeout' is specified)
mdtoast('Message archived.', {
  type: 'success', 
  interaction: true, actionText: 'UNDO', 
  action: function(){
    //TODO: Undo codes here...
    this.hide(); // this is the toast instance
  }
});

Remember

Comment or remove the line shown below in the css file if you already have a link to the Roboto font.

@import url('https://fonts.googleapis.com/css?family=Roboto:400,500');

Older browsers may need the classList polyfill which extends classList support back to IE8 (natively, it’s IE10+).

material-toast alert-messages toast-message toast-plugin

2.0.1

4 years ago