toastr is a Javascript library for non-blocking notifications. jQuery is required. The goal is to create a simple core library that can be customized and extended.
2.1.0
- Demo can be found at http://codeseven.github.io/toastr/demo.html
- Demo using FontAwesome icons with toastr
Toastr is hosted at CDN JS
- //cdnjs.cloudflare.com/ajax/libs/toastr.js/latest/js/toastr.js
- //cdnjs.cloudflare.com/ajax/libs/toastr.js/latest/css/toastr.css
- //cdnjs.cloudflare.com/ajax/libs/toastr.js/latest/js/toastr.min.js
- //cdnjs.cloudflare.com/ajax/libs/toastr.js/latest/css/toastr.min.css
http://nuget.org/packages/toastr
bower install toastr
####Animation Changes The following animations options have been deprecated and should be replaced:
- Replace
options.fadeInwithoptions.showDuration - Replace
options.onFadeInwithoptions.onShown - Replace
options.fadeOutwithoptions.hideDuration - Replace
options.onFadeOutwithoptions.onHidden
###3 Easy Steps For other API calls, see the demo.
-
Link to toastr.css
<link href="toastr.css" rel="stylesheet"/> -
Link to toastr.js
<script src="toastr.js"></script> -
use toastr to display a toast for info, success, warning or error
// Display an info toast with no title toastr.info('Are you the 6 fingered man?')
// Display a warning toast, with no title
toastr.warning('My name is Inigo Montoya. You killed my father, prepare to die!')
// Display a success toast, with a title
toastr.success('Have fun storming the castle!', 'Miracle Max Says')
// Display an error toast, with a title
toastr.error('I do not think that word means what you think it means.', 'Inconceivable!')
// Clears the current list of toasts
toastr.clear()
Optionally enable a close button
toastr.options.closeButton = true;
Optionally override the close button's HTML.
toastr.options.closeHtml = '<button><i class="icon-off"></i></button>';
You can also override the CSS/LESS for #toast-container .toast-close-button
Show newest toast at bottom (top is default)
toastr.options.newestOnTop = false;
// Define a callback for when the toast is shown/hidden
toastr.options.onShown = function() { console.log('hello'); }
toastr.options.onHidden = function() { console.log('goodbye'); }
Toastr will supply default animations, so you do not have to provide any of these settings. However you have the option to override the animations if you like.
####Easings Optionally override the animation easing to show or hide the toasts. Default is swing. swing and linear are built into jQuery.
toastr.options.showEasing = 'swing';
toastr.options.hideEasing = 'linear';
Using the jQuery Easing plugin (http://www.gsgd.co.uk/sandbox/jquery/easing/)
toastr.options.showEasing = 'easeOutBounce';
toastr.options.hideEasing = 'easeInBack';
####Animation Method Use the jQuery show/hide method of your choice. These default to fadeIn/fadeOut. The methods fadeIn/fadeOut, slideDown/slideUp, and show/hide are built into jQuery.
toastr.options.showMethod = 'slideDown';
toastr.options.hideMethod = 'slideUp';
###Prevent Duplicates Rather than having identical toasts stack, set the preventDuplicates property to true. Duplicates are matched to the previous toast based on their message content.
toastr.options.preventDuplicates = true;
###Timeouts Control how toastr interacts with users by setting timeouts appropriately.
toastr.options.timeout = 30; // How long the toast will display without user interaction
toastr.options.extendedTimeOut = 60; // How long the toast will display after a user hovers over it
###Progress Bar Visually indicate how long before a toast expires.
toastr.options.progressBar = true;
To build the minified and css versions of Toastr you will need node installed.
Install the Grunt command line. This might require sudo.
npm install -g grunt-cliThen, from the main project folder run this command. This should not require sudo.
npm installAt this point the dependencies have been installed and you can build Toastr
gruntFor a pull request to be considered it must resolve a bug, or add a feature which is beneficial to a large audience.
Pull requests must pass existing unit tests, CI processes, and add additional tests to indicate successful operation of a new feature, or the resolution of an identified bug.
Requests must be made against the develop branch. Pull requests submitted against the master branch will not be considered.
All pull requests are subject to approval by the repository owners, who have sole discretion over acceptance or denial.
Hans Fjällemark
John Papa
Tim Ferrell
Inspired by https://github.com/Srirangan/notifer.js/.
Copyright © 2012-2014 Hans Fjällemark , John Papa, and Tim Ferrell
toastr is under MIT license - http://www.opensource.org/licenses/mit-license.php