2017 © Pedro PelĂĄez
 

component toastr

Shim repository for https://github.com/CodeSeven/toastr

image

stinger-soft/toastr

Shim repository for https://github.com/CodeSeven/toastr

  • Friday, March 3, 2017
  • by Viburnum
  • Repository
  • 2 Watchers
  • 0 Stars
  • 634 Installations
  • JavaScript
  • 0 Dependents
  • 0 Suggesters
  • 1 Forks
  • 0 Open issues
  • 3 Versions
  • 2 % Grown

The README.md

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)

Build Status Browser testing provided by BrowserStack., (*2)

Current Version

2.1.3, (*3)

Demo

CDNjs

Toastr is hosted at CDN JS, (*4)

Debug

Minified

Install

NuGet Gallery

Install-Package toastr

Bower

bower install toastr

npm

npm install --save toastr

Wiki and Change Log

Wiki including Change Log, (*5)

Breaking Changes

Animation Changes

The following animations options have been deprecated and should be replaced:, (*6)

  • 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., (*7)

  1. Link to toastr.css <link href="toastr.css" rel="stylesheet"/>, (*8)

  2. Link to toastr.js <script src="toastr.js"></script>, (*9)

  3. 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?')
    

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 charaters in title and message, (*11)

toastr.options.escapeHtml = true;

Close Button

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

Display Sequence

Show newest toast at bottom (top is default), (*15)

toastr.options.newestOnTop = false;

Callbacks

// 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., (*16)

Easings

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

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., (*19)

toastr.options.showMethod = 'slideDown';
toastr.options.hideMethod = 'slideUp';
toastr.options.closeMethod = '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., (*20)

toastr.options.preventDuplicates = true;

Timeouts

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

Progress Bar

Visually indicate how long before a toast expires., (*22)

toastr.options.progressBar = true;

rtl

Flip the toastr to be displayed properly for right-to-left languages., (*23)

toastr.options.rtl = true; 

Building Toastr

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)

  • 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., (*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)

Authors

John Papa, (*30)

Tim Ferrell, (*31)

Hans FjÀllemark, (*32)

Credits

Inspired by https://github.com/Srirangan/notifer.js/., (*33)

Copyright © 2012-2015, (*34)

License

toastr is under MIT license - http://www.opensource.org/licenses/mit-license.php, (*35)

The Versions

03/03 2017

dev-master

9999999-dev

Shim repository for https://github.com/CodeSeven/toastr

  Sources   Download

MIT

03/03 2017

2.1.3

2.1.3.0

Shim repository for https://github.com/CodeSeven/toastr

  Sources   Download

MIT

20/05 2016

2.1.2

2.1.2.0

Shim repository for https://github.com/CodeSeven/toastr

  Sources   Download

MIT