growl-alert
v1.0.1
Published
A simple growl like notification system.
Readme
Growl Alert
A simple growl like notification system.
Table of Contents
Install
You can get it on npm
$ npm install --save growl-alertThen import it with a module bundler like rollup or webpack
// using ES6 modules
import growl from 'growl-alert'
// you need to import the css too!
// but first you need to configure your bundler to process css files!
import 'growl-alert/dist/growl-alert.css'
// using CommonJS modules
var growl = require('growl-alert')
require('growl-alert/dist/growl-alert.css')There is also an UMD build available on unpkg:
<head>
...
<link rel="stylesheet" href="https://unpkg.com/growl-alert/dist/growl-alert.css"></link>
...
</head>
<body>
...
<script src="https://unpkg.com/growl-alert"></script>
</body>You can find the library on window.growl or just growl.
Usage
You can use the growl() function, or one of its shortcuts.
//..
growl({text: 'Hello World!', type: 'success'});
growl.success('User Saved!');
growl.error('Somethng gone wrong...');
growl.warning({options...});
growl.info();
Examples & Demos
Soon :)
API
option: (default value) type/values description
- type: ('success') ['success', 'error', 'warning', 'info'] Type of the growl-alert
- text: The message
- fadeAway: (false) Boolean: If the growl notification should fade away after x milliseconds
- fadeAwayTimeout: (5000) Integer: Time in milliseconds.
- alertBoxLoadedCB: Function: open callback
- alertBoxOnCloseCB: Function: close callback
You can also define your own default options
growl.defaults.type = 'error'
Contribute
All contributions are welcome.
- Fork the repo on GitHub
- Clone the project to your own machine
- Install the tools necessary for development:
npm install - Make your changes and test it:
npm test - Commit it to your own branch
- Push your work back up to your fork
- Submit a pull request with full remarks documenting your changes
Browser Support
IE 10+ Modern Browsers