Socket
Socket
Sign inDemoInstall

toastr

Package Overview
Dependencies
0
Maintainers
2
Versions
5
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    toastr

ToastrJS 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.


Version published
Weekly downloads
175K
increased by10.53%
Maintainers
2
Install size
537 kB
Created
Weekly downloads
 

Changelog

Source

2.1.0 (2014-10-15)

New Features

  • Prevent duplicate sequential toasts SBero | aa083d8
  • Add support for top-center and bottom-center toasts showwin | 86a4798
  • Add feature allowing progress bars to be shown for toasts TravisTX | PR 189

toastr.options.preventDuplicates = true;

toastr.options.progressBar = true;

Bug Fixes

  • None

Breaking Changes

  • None

Dev Ops

  • Add karma test runner
  • Added Travis CI hooks

Readme

Source

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.

Build Status

Current Version

2.1.0

Demo

CDNjs

Toastr is hosted at CDN JS

Debug
Minified

http://nuget.org/packages/toastr

Bower

	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.

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

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'; 

###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.

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

###Progress Bar Visually indicate how long before a toast expires.

toastr.options.progressBar = 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

Authors

John Papa

Tim Ferrell

Hans Fjällemark

Credits

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

Copyright © 2012-2014

License

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

Keywords

FAQs

Last updated on 29 Jun 2015

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc