iziToast Documentation

For Ruby on Rails integration, use the iziToast-rails GEM available on GitHub.

https://github.com/BadAllOff/iziToast-rails

You can install the core iziToast library using your preferred package manager.

# NPM
npm install izitoast --save

# Yarn
yarn add izitoast --save

# Bower
bower install izitoast --save

To use iziToast within a Vue 2 application, install the vue-izitoast wrapper using NPM or Yarn.

# NPM
npm install vue-izitoast --save

# Yarn
yarn add vue-izitoast

To use iziToast within an Angular 2 application, install the ng2-izitoast wrapper.

npm install ng2-izitoast --save

You can interact with the settings of a specific, already-rendered toast instance using its reference.

• $iziToast.setSetting(ref, option, value): Updates a specific option for a toast identified by ref.
• $iziToast.getSettings(ref, option): Retrieves a specific option or the entire settings object for a toast identified by ref.

For toasts with a progress bar, you can control the timer using the .progress() method on the iziToast instance. This returns an object with the following methods:

• start(): Starts or resumes the progress bar timer.
• pause(): Pauses the progress bar timer.
• resume(): Resumes the progress bar timer.
• reset(): Resets the progress bar to 100% and clears the timer.

iziToast provides shorthand methods for common notification types. These methods automatically apply theme-specific colors and icons. The available theme methods are:

• iziToast.info(options)
• iziToast.success(options)
• iziToast.warning(options)
• iziToast.error(options)
• iziToast.question(options)