Skip to content

CodyTave/Easy-Notify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ISC License

easy-notify-ts

easy-notify-ts is a simple and lightweight JavaScript library for displaying toast notifications in your web applications. It allows you to easily show alert, error, or success messages in a customizable and stylish manner. This library is written in TypeScript and provides an intuitive way to notify your users about important events or messages.

Demo

Demo

Screenshots

Installation

You can install easy-notify-ts via npm:

npm install easy-notify-ts

Usage

Here's how you can use the library in your web application:

import { NotificationType, renderToastNotification } from "easy-notify-ts";

// Create a notification object

const notification: ToastNotification = {
  type: NotificationType.Success, // Choose from Alert, Error, or Success
  title: "Notification Title",
  content: "This is the notification content.",
  color: "#3f8860", // Optional: Set a custom background color
};

// Display the notification
renderToastNotification(notification);

API

API NotificationType An enum defining the types of notifications:

  • Alert: Represents an alert notification.
  • Error: Represents an error notification.
  • Success: Represents a success notification.
  • type: The type of notification (one of the values from NotificationType).
  • title: The title of the notification.
  • content: The content or message of the notification.
  • color (optional): A custom background color for the notification.

Notification Types

Type Color
Alert #e67e22#e67e22
Error #c0392b#c0392b
Success #3f8860#3f8860

Authors

License

ISC

Thank you for using Easy-Notify-TS! We hope it simplifies the way you handle notifications in your TypeScript projects. If you have any questions or need assistance, feel free to reach out to us.

About

A lightweight and simple package for oversimplified notification on web apps with typescript

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published