1.0.1 • Published 8 years ago
snack.js v1.0.1
snack.js
Simple lightweight toasts (minified and gzipped less ~ 1.5 kb js incl. bundled css);
Install
npm i snack.js
Usage
js
var Snack = require('snack.js'); // or include dist/snack.(min.)js for the standalone version
var snack = new Snack({
// optional, defaults to document.body
domParent: document.querySelector('.some-element');
});
// show a snack for 4s
snack.show('Snack content', 4000);
// html content
snack.show('<h1>HTML</h1>');
// hide the snack
snack.hide();
// toggle / show it again
snack.toggle();
// destroy the snack
snack.destroy();
The styles are included in the dist/js files (via cssify);
API
snack.show(content, timeout)
- show snack with content for timeout mscontent can be a string or html
snack.hide()
- hide the snacksnack.toggle()
- show / hide the snacksnack.destroy()
- destroy the instance
Build
Install the dependencies, npm i
, then run the build npm run build
Examples / visual tests
*beefy is expected to be installed globally -> npm i beefy -g
Standalone:
npm run test:visual-standalone
Browserify:
npm run test:visual-browserify
Licence
MIT