toastr
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.
Browser testing provided by BrowserStack.
Current Version
2.1.4
Demo
- Demo can be found at http://codeseven.github.io/toastr/demo.html
- Demo using FontAwesome icons with toastr
CDNjs
Toastr is hosted at CDN JS
Debug
Minified
- //cdnjs.cloudflare.com/ajax/libs/toastr.js/latest/toastr.min.js
- //cdnjs.cloudflare.com/ajax/libs/toastr.js/latest/toastr.min.css
Install
NuGet Gallery
Install-Package toastr
Bower
bower install toastr
npm
npm install --save toastr
Ruby on Rails
# Gemfile
# application.coffee #= require toastr
// application.scss ;
Wiki and Change Log
Breaking Changes
Animation Changes
The following animations options have been deprecated and should be replaced:
- Replace
options.fadeIn
withoptions.showDuration
- Replace
options.onFadeIn
withoptions.onShown
- Replace
options.fadeOut
withoptions.hideDuration
- Replace
options.onFadeOut
withoptions.onHidden
Quick Start
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 titletoastr
Other Options
// Display a warning toast, with no titletoastr // Display a success toast, with a titletoastr // Display an error toast, with a titletoastr // Immediately remove current toasts without using animationtoastr // Remove current toasts using animationtoastrclear // Override global optionstoastr
Escape HTML characters
In case you want to escape HTML characters in title and message
toastr.options.escapeHtml = true;
Close Button
Optionally enable a close button
toastroptionscloseButton = true;
Optionally override the close button's HTML.
toastroptionscloseHtml = '<button><i class="icon-off"></i></button>';
You can also override the CSS/LESS for #toast-container .toast-close-button
Optionally override the hide animation when the close button is clicked (falls back to hide configuration).
toastroptionscloseMethod = 'fadeOut';toastroptionscloseDuration = 300;toastroptionscloseEasing = 'swing';
Display Sequence
Show newest toast at bottom (top is default)
toastroptionsnewestOnTop = false;
Callbacks
// Define a callback for when the toast is shown/hidden/clickedtoastroptions { console; }toastroptions { console; }toastroptions { console; }toastroptions { console; }
Animation Options
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.
toastroptionsshowEasing = 'swing';toastroptionshideEasing = 'linear';toastroptionscloseEasing = 'linear';
Using the jQuery Easing plugin (http://www.gsgd.co.uk/sandbox/jquery/easing/)
toastroptionsshowEasing = 'easeOutBounce';toastroptionshideEasing = 'easeInBack';toastroptionscloseEasing = '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.
toastroptionsshowMethod = 'slideDown';toastroptionshideMethod = 'slideUp';toastroptionscloseMethod = '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.
toastroptionspreventDuplicates = true;
Timeouts
Control how toastr interacts with users by setting timeouts appropriately. Timeouts can be disabled by setting them to 0.
toastroptionstimeOut = 30; // How long the toast will display without user interactiontoastroptionsextendedTimeOut = 60; // How long the toast will display after a user hovers over it
Progress Bar
Visually indicate how long before a toast expires.
toastroptionsprogressBar = true;
rtl
Flip the toastr to be displayed properly for right-to-left languages.
toastroptionsrtl = true;
Building Toastr
To build the minified and css versions of Toastr you will need node installed. (Use Homebrew or Chocolatey.)
npm install -g gulp karma-cli
npm install
At this point the dependencies have been installed and you can build Toastr
- Run the analytics
gulp analyze
- Run the test
gulp test
- Run the build
gulp
Contributing
For 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.
Authors
John Papa
Tim Ferrell
Hans Fjällemark
Credits
Inspired by https://github.com/Srirangan/notifer.js/.
Copyright
Copyright © 2012-2015
License
toastr is under MIT license - http://www.opensource.org/licenses/mit-license.php