toaster-ts
TypeScript icon, indicating that this package has built-in type declarations

0.3.0 • Public • Published

toaster-ts

toaster-ts is a JavaScript library to show toast notifications in your website.

⚠️ WARNING: This library is still a work in progress! ⚠️

Please, be aware that while this library is being actively developed and improved, there may be instability and breaking changes.

Usage

To start using the library, install it in your project:

npm install toaster-ts

Add <section id="toaster-wrapper"></section> inside <body> element. That will be the container for all the notifications. You can customize the position by adding the data-position attribute. See the example below:

<!DOCTYPE html>
<html lang="en">
  <head>...</head>
  <body>
    ...
    <section
        id="toaster-wrapper"
        data-position="bottom-left" />
  </body>
</html>

Import the stylesheet

@import 'toaster-ts/dist/bundle.css';

Then, you can use toast() from anywhere in your app.

import { toast } from 'toaster-ts';

toast('My first toast');

Thanks

This library has been deeply inspired by Sonner, an opinionated toast component for React. Thanks to its author, Emil Kowalski

Package Sidebar

Install

npm i toaster-ts

Weekly Downloads

219

Version

0.3.0

License

MIT

Unpacked Size

17.4 kB

Total Files

8

Last publish

Collaborators

  • mpriereira