bare-toasts
v1.0.0
Published
A lightweight, framework-agnostic, customizable toast library.
Downloads
6
Maintainers
Readme
bare-toasts
A minimalistic, toast notification library.
Features
- Framework Agnostic: Works seamlessly with any JavaScript framework/library.
- Lightweight: Minimal overhead.
- Customizable: Easy to customize toast appearance.
Installation
npm install bare-toasts
Usage
import { ToastManager } from "bare-toasts";
const toastManager = ToastManager.getInstance();
toastManager.createToast({
message: "Hello World",
duration: 5000,
});
Parameters for createToast
| Parameter | Type | Description | Default Value |
| ----------- | -------- | ------------------------------------------------------------------------------------------------------------------ | -------------- |
| message
| string | The message to display in the toast. | |
| type
| string | The type of toast (normal
, success
, info
, warning
, error
). | normal
|
| position
| string | The position of the toast (top-left
, top-right
, bottom-left
, bottom-right
, top-center
, bottom-center
). | bottom-right
|
| duration
| number | The duration the toast should be visible (in milliseconds). | 3000
|
| showIcon
| boolean | Determines whether to show an icon in the toast. | true
|
| className
| string | Additional class names to apply to the toast. | |
| styles
| object | Inline styles to apply to the toast. | |
| onShow
| function | A callback function to be called when the toast is shown. | |
| onHide
| function | A callback function to be called when the toast is hidden. | |