What is toastr?
Toastr is a simple JavaScript library for non-blocking notifications. It is designed to be easy to use and customize, providing a way to display notifications to users in a clean and unobtrusive manner.
What are toastr's main functionalities?
Basic Notification
Displays a basic success notification with the message 'Hello, world!'.
toastr.success('Hello, world!')
Custom Notification Types
Displays different types of notifications: error, info, and warning.
toastr.error('Something went wrong!');
toastr.info('Here is some information.');
toastr.warning('This is a warning.');
Custom Options
Shows how to customize various options for the notifications, such as enabling a close button, setting the position, and configuring the display duration.
toastr.options = {
'closeButton': true,
'debug': false,
'newestOnTop': false,
'progressBar': true,
'positionClass': 'toast-top-right',
'preventDuplicates': false,
'onclick': null,
'showDuration': '300',
'hideDuration': '1000',
'timeOut': '5000',
'extendedTimeOut': '1000',
'showEasing': 'swing',
'hideEasing': 'linear',
'showMethod': 'fadeIn',
'hideMethod': 'fadeOut'
};
toastr.success('Settings applied!');
Clear Notifications
Clears all currently displayed notifications.
toastr.clear();
Other packages similar to toastr
noty
Noty is a notification library that provides a wide range of customization options and supports various notification types. It is similar to toastr but offers more flexibility in terms of layout and animation.
sweetalert2
SweetAlert2 is a popular library for creating beautiful, responsive, and customizable alerts. While it is more focused on modal alerts rather than toast notifications, it can be used to achieve similar functionality with more visual appeal.
pnotify
PNotify is a JavaScript notification library that offers a variety of notification types and extensive customization options. It is comparable to toastr but provides more advanced features such as stacking and modules for additional functionality.
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.
Current Version
2.0.3
Demo
CDNjs
Toastr is hosted at CDN JS
Debug
Minified
NuGet Gallery
http://nuget.org/packages/toastr
bower install toastr
Wiki and Change Log
Wiki including Change Log
Breaking Changes
####Animation Changes
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!')
// Clears the current list of toasts
toastr.clear()
Close Button
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
Display Sequence
Show newest toast at bottom (top is default)
toastr.options.newestOnTop = false;
Callbacks
// Define a callback for when the toast is shown/hidden
toastr.options.onShown = function() { console.log('hello'); }
toastr.options.onHidden = function() { console.log('goodbye'); }
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.
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';
Building Toastr
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-cli
Then, from the main project folder run this command. This should not require sudo
.
npm install
At this point the dependencies have been installed and you can build Toastr
grunt
Authors
Hans Fjällemark
John Papa
Credits
Inspired by https://github.com/Srirangan/notifer.js/.
Copyright
Copyright © 2012-2014 Hans Fjällemark & John Papa.
License
toastr is under MIT license - http://www.opensource.org/licenses/mit-license.php