Shim repository for https://github.com/CodeSeven/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., (*1)
Browser testing provided by BrowserStack., (*2)
2.1.3, (*3)
Toastr is hosted at CDN JS, (*4)
Install-Package toastr
bower install toastr
npm install --save toastr
Wiki including Change Log, (*5)
The following animations options have been deprecated and should be replaced:, (*6)
options.fadeIn
with options.showDuration
options.onFadeIn
with options.onShown
options.fadeOut
with options.hideDuration
options.onFadeOut
with options.onHidden
For other API calls, see the demo., (*7)
Link to toastr.css <link href="toastr.css" rel="stylesheet"/>
, (*8)
Link to toastr.js <script src="toastr.js"></script>
, (*9)
use toastr to display a toast for info, success, warning or error, (*10)
// 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!') // Immediately remove current toasts without using animation toastr.remove() // Remove current toasts using animation toastr.clear() // Override global options toastr.success('We do have the Kapua suite available.', 'Turtle Bay Resort', {timeOut: 5000})
In case you want to escape HTML charaters in title and message, (*11)
toastr.options.escapeHtml = true;
Optionally enable a close button, (*12)
toastr.options.closeButton = true; ```` Optionally override the close button's HTML. ```js toastr.options.closeHtml = '<button><i class="icon-off"></i></button>';
You can also override the CSS/LESS for #toast-container .toast-close-button
, (*13)
Optionally override the hide animation when the close button is clicked (falls back to hide configuration)., (*14)
toastr.options.closeMethod = 'fadeOut'; toastr.options.closeDuration = 300; toastr.options.closeEasing = 'swing';
Show newest toast at bottom (top is default), (*15)
toastr.options.newestOnTop = false;
// Define a callback for when the toast is shown/hidden/clicked toastr.options.onShown = function() { console.log('hello'); } toastr.options.onHidden = function() { console.log('goodbye'); } toastr.options.onclick = function() { console.log('clicked'); } toastr.options.onCloseClick = function() { console.log('close button clicked'); }
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., (*16)
Optionally override the animation easing to show or hide the toasts. Default is swing. swing and linear are built into jQuery., (*17)
toastr.options.showEasing = 'swing'; toastr.options.hideEasing = 'linear'; toastr.options.closeEasing = 'linear';
Using the jQuery Easing plugin (http://www.gsgd.co.uk/sandbox/jquery/easing/), (*18)
toastr.options.showEasing = 'easeOutBounce'; toastr.options.hideEasing = 'easeInBack'; toastr.options.closeEasing = 'easeInBack';
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., (*19)
toastr.options.showMethod = 'slideDown'; toastr.options.hideMethod = 'slideUp'; toastr.options.closeMethod = 'slideUp';
Rather than having identical toasts stack, set the preventDuplicates property to true. Duplicates are matched to the previous toast based on their message content., (*20)
toastr.options.preventDuplicates = true;
Control how toastr interacts with users by setting timeouts appropriately. Timeouts can be disabled by setting them to 0., (*21)
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
Visually indicate how long before a toast expires., (*22)
toastr.options.progressBar = true;
Flip the toastr to be displayed properly for right-to-left languages., (*23)
toastr.options.rtl = true;
To build the minified and css versions of Toastr you will need node installed. (Use Homebrew or Chocolatey.), (*24)
npm install -g gulp karma-cli npm install
At this point the dependencies have been installed and you can build Toastr, (*25)
gulp analyze
gulp test
gulp
For a pull request to be considered it must resolve a bug, or add a feature which is beneficial to a large audience., (*26)
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., (*27)
Requests must be made against the develop
branch. Pull requests submitted against the master
branch will not be considered., (*28)
All pull requests are subject to approval by the repository owners, who have sole discretion over acceptance or denial., (*29)
John Papa, (*30)
Tim Ferrell, (*31)
Hans FjÀllemark, (*32)
Inspired by https://github.com/Srirangan/notifer.js/., (*33)
Copyright © 2012-2015, (*34)
toastr is under MIT license - http://www.opensource.org/licenses/mit-license.php, (*35)