Snapshot of CodeSeven/toastr: 12.1k★, JavaScript. Simple javascript toast notifications
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
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
The following animations options have been deprecated and should be replaced:
Replace options.fadeIn with options.showDuration
Replace options.onFadeIn with options.onShown
Replace options.fadeOut with options.hideDuration
Replace options.onFadeOut with options.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 title
toastr.info('Are you the 6 fingered man?')
Other Options
// 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})
Escape HTML characters
In case you want to escape HTML characters in title and message
// 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'); }
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.
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.
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
Prevent from Auto Hiding
To prevent toastr from closing based on the timeouts, set the timeOut and extendedTimeOut options to 0. The toastr will persist until selected.
Visually indicate how long before a toast expires.
toastr.options.progressBar = true;
rtl
Flip the toastr to be displayed properly for right-to-left languages.
toastr.options.rtl = 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
http://twitter.com/John_Papa
Tim Ferrell
http://twitter.com/ferrell_tim
Hans Fjällemark
http://twitter.com/hfjallemark
Credits
Inspired by https://github.com/Srirangan/notifer.js/.
TopGit's last sync did not record any GitHub topics for CodeSeven/toastr. GitHub topics appear in the right sidebar of a repository page; that's the authoritative place to check.
How active is development on CodeSeven/toastr?
The most recent commit recorded on CodeSeven/toastr was 3.7 years ago, based on the GitHub push timestamp. The repository has 2.0k forks — one of the better signals of community interest.
How many stars does CodeSeven/toastr have?
CodeSeven/toastr has 12.1k GitHub stars — refresh the page for the live number, or check github.com/CodeSeven/toastr. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What is CodeSeven/toastr?
CodeSeven/toastr (CodeSeven/toastr) is a JavaScript project on GitHub. From the project's own README: Simple javascript toast notifications
What language is CodeSeven/toastr written in?
CodeSeven/toastr is written primarily in JavaScript. GitHub's language field is based on the largest share of bytes in the default branch.
Read full README in the tab above.
Want a second opinion on toastr?
Ask an AI that can read this page — one click and you get its take on toastr.