IOP-Toaster.js

Toaster is a small library that allows you to create HTML Toasts - special messages that pop up at the top of the page, informing the user about events happening on the site.

Why us?

• Fast and easy to use and install - the Toast library makes it easy to create Toast notifications without having to write complex code. This makes it an ideal solution for web developers who want to add functionality quickly and effortlessly. It is also easy to install using NPM or by downloading the GitHub repository;
• Versatility - the library offers several options and settings, which allows you to adapt toasts to your design and site style. This way, you can create unique and attractive notifications for users;
• Availability - the library is provided free of charge, making it accessible to any developer. This allows you to save time and money without resorting to expensive solutions;
• Browser support - the library is well tested and compatible with most modern browsers, which guarantees its stable operation on various devices;
• Written in pure JS - Toaster is written entirely in JavaScript, without the use of any additional libraries or frameworks. This means that it is easy to use, understand and maintain. It can also be easily integrated into any web application or site as it does not require any additional dependencies;
• Improving user experience - Toasts allow you to quickly and conveniently convey important information to the user, which improves his experience of interacting with a site or application. This could be information about successful registration, error, warning, etc.

Installations

1. NPM package manager

Through the terminal, run the following command in the root folder of the project:

npm i iop-toaster

In .js files, use import with the desired module path:

import {Toast} from '../node_modules/iop-toaster/src/iop-toaster.js';

Don't forget that your JavaScript files must be included as a modules:

<script src="index.js" type="module"></script>

2. Build from source

Go to /src folder of GitHub page and download script and style files. Include style to your HTML page using

<link rel="stylesheet" href="../path/to/your/styles/folder/iop-cookiemaster.css">

Then include script to your HTML page using

<script src="../path/to/your/scripts/folder/iop-cookiemaster.js"></script>

Usage

Using the Toaster library gives you access to the Toast function. It can be used to create a one-time Toast or to create an object with which you can dynamically control the created Toast.

One-time Toast

Creating a one-time Toast:

Toast.show(message, duration, className, authohide)

Method parameters:

• message (string) - semantic message displayed by Toast;
• duration (number) - time in milliseconds after which Toast will disappear. Has a default value of 3000 milliseconds;
• className (string) - an optional parameter that allows you to specify an additional class for Toast to style it using CSS;
• authohide (bool) - a boolean parameter set to true by default. If true, Toast will disappear after the time specified in duration.

License

This library is distributed under the ISC license. License text:

Copyright (c) 2024, IOPjolnir <[email protected]>.

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.