LI-NA / toastify-js

Pure JavaScript library for better notification messages

Home Page:https://apvarun.github.io/toastify-js/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Toastify

forthebadge forthebadge

toastify-js

Toastify is a lightweight, vanilla JS toast notification library.

Demo

Click here

Features

  • Multiple stacked notifications
  • Customizable
  • No blocking of execution thread

Customization options

  • Notification Text
  • Duration
  • Toast background color
  • Close icon display
  • Display position

Installation

Toastify now supports installation via NPM

  • Run the below command to add toastify-js to your exisitng or new project.
npm install --save toastify-js

or

yarn add toastify-js -S
  • Import toastify-js into your module to start using it.
import Toastify from 'toastify-js'

You can use the default CSS from Toastify as below and later override it or choose to write your own CSS.

import "toastify-js/src/toastify.css"

Adding ToastifyJs to HTML page using the traditional method

To start using Toastify, add the following CSS on to your page.

<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/toastify-js/src/toastify.min.css">

And the script at the bottom of the page

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/toastify-js"></script>

Files are delivered via the CDN service provided by jsdeliver

Documentation

Toastify({
  text: "This is a toast",
  duration: 3000, 
  destination: "https://github.com/apvarun/toastify-js",
  newWindow: true,
  close: true,
  gravity: "top", // `top` or `bottom`
  position: 'left', // `left`, `center` or `right`
  backgroundColor: "linear-gradient(to right, #00b09b, #96c93d)",
  stopOnFocus: true, // Prevents dismissing of toast on hover
  onClick: function(){} // Callback after click
}).showToast();

Toast messages will be centered on devices with screen width less than 360px.

Add own custom classes

If you want to use custom classes on the toast for customizing (like info or warning for example), you can do that as follows:

Toastify({
  text: "This is a toast",
  backgroundColor: "linear-gradient(to right, #00b09b, #96c93d)",
  className: "info",
}).showToast();

Multiple classes also can be assigned as a string, with spaces between class names.

API

Option Key type Usage Defaults
text string Message to be displayed in the toast "Hi there!"
duration number Duration for which the toast should be displayed.
0 for permanent toast
3000
selector string CSS Selector on which the toast should be added body
destination URL string URL to which the browser should be navigated on click of the toast
newWindow boolean Decides whether the destination should be opened in a new window or not false
close boolean To show the close icon or not false
gravity "top" or "bottom" To show the toast from top or bottom "top"
position "left" or "right" To show the toast on left or right "right"
backgroundColor CSS background value Sets the background color of the toast
avatar URL string Image/icon to be shown before text
className string Ability to provide custom class name for further customization
stopOnFocus boolean To stop timer when hovered over the toast (Only if duration is set) true
callback Function Invoked when the toast is dismissed
onClick Function Invoked when the toast is clicked

Browsers support


IE / Edge

Firefox

Chrome

Safari

Opera
IE10, IE11, Edge last 10 versions last 10 versions last 10 versions last 10 versions

Contributors

haydster7
haydster7
fiatjaf
fiatjaf
victorfeijo
victorfeijo
t12ung
t12ung
Tadaz
Tadaz
mort3za
mort3za
Wachiwi
Wachiwi
gavinhungry
gavinhungry
juliushaertl
juliushaertl
skjnldsv
skjnldsv
danielkaiser80
danielkaiser80
d4rn0k
d4rn0k
GodzzZZZ
GodzzZZZ
caiomoura1994
caiomoura1994
rndevfx
rndevfx
apvarun
apvarun

License

MIT © Varun A P

About

Pure JavaScript library for better notification messages

https://apvarun.github.io/toastify-js/

License:MIT License


Languages

Language:JavaScript 69.8%Language:CSS 16.5%Language:HTML 13.6%