/toastr

Simple javascript toast notifications

Primary LanguageJavaScript

toastr

toastr is a Javascript library for Gnome / Growl type non-blocking notifications. jQuery is required. The goal is to create a simple core library that can be customized and extended.

Current Version

1.3.0

Demo

Demo can be found at http://CodeSeven.github.com/toastr

NuGet Gallery

http://nuget.org/packages/toastr

bower install toastr

Quick start

###3 Easy Steps For other API calls, see the demo.

  1. Link to toastr.css <link href="toastr.css" rel="stylesheet"/>

  2. Link to toastr.js <script src="toastr.js"></script>

  3. 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()

// 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'); }

// Use the jQuery show/hide method of your choice
// (These default to fadeIn/fadeOut)
toastr.options.showMethod = 'slideDown'; 
toastr.options.hideMethod = 'slideUp'; 

// Use easing effects (using the jQuery Easing plugin (http://www.gsgd.co.uk/sandbox/jquery/easing/))
toastr.options.showEasing = 'easeOutBounce';
toastr.options.hideEasing = 'easeInBack';

Authors

Hans Fjällemark

John Papa

Credits

Inspired by https://github.com/Srirangan/notifer.js/.

Copyright

Copyright © 2012 Hans Fjällemark & John Papa.

License

toastr is under MIT license - http://www.opensource.org/licenses/mit-license.php