README.md

js-toast

This is a small JavaScript library that produces a toast message. Toasts are small, unobtrusive notifictions to alert the user of something. This toast slides in from the bottom of the page, stays for a specified amount of time, and then slides away. This is much friendlier than using the alert() function in JavaScript.

A demo is available on my playground.

Usage

Usage is extremely simple, but advanced customization can also be done. For starters, a toast can be created when a button is clicked

<input type="button" value="Toast!" onclick="showAToast();">

Where the showAToast() function creates and shows a toast

function showAToast() {
	iqwerty.toast.toast('Hello!');
}

This shows a toast with default settings.

If you'd like to close any toast, grab a reference to any toast and call .hide().

const toast = iqwerty.toast.toast('Hello!');
toast.hide();

Note this closes any toast currently visible, not the one you have a reference to. Because programming is hard :(

Advanced customization

The toast is easy to use, and it looks great by default. However, it can also be customized to your liking.

Styles

The toast style can be customized by specifying a style in the options parameter

const options = {
	style: {
		main: {
			background: "pink",
			color: "black",
		},
	},
};

iqwerty.toast.toast('Hello!', options);

The styles are in CSS-ish syntax.

Duration

The duration of the toast (the time that the toast stays on the screen) is set to 4000ms (4s) by default, but you can change this if you wish. If set to 0, the toast will remain visible forever until .hide() is called.

const options = {
	settings: {
		duration: 5000,
	},
};

iqwerty.toast.toast('Hello!', options);

Have fun!

Accessibility (a11y)

I will add aria-live for a11y when I have time... Sorry to users with disabilities that are using this now :(