Skip to content

sandundil2002/Sand-Alerts

Repository files navigation

Typing SVG

project-image

Sand Alert is a professional customizable alert component library built with Next js and TypeScript. It offers an intuitive API for simple yet flexible contextual feedback in web applications. Designed for performance and accessibility it seamlessly integrates into any React project from small to enterprise-scale. With robust state management animations and TypeScript support Sand Alert ensures type safety and enhances developer experience while delivering consistent brand-aligned notifications and prompts for exceptional user experiences.

🚀 Demo

https://sand-alerts.vercel.app/

Project Screenshots:

project-screenshot

project-screenshot

project-screenshot

project-screenshot

project-screenshot

project-screenshot

project-screenshot

project-screenshot

project-screenshot

project-screenshot

project-screenshot

🧐 Features

Here're some of the project's best features:

  • 🎨 Highly Customizable: Style alerts to match your application's design system
  • 🔄 Smooth Animations: Elegant enter/exit transitions for better UX
  • 🔊 Sound Effects - Audio sounds for different alert types
  • ⚡ Lightweight: Less than 5KB gzipped with zero dependencies
  • 📱 Responsive: Looks great on all devices and viewport sizes
  • 🌐 Accessibility: WCAG 2.1 compliant with proper ARIA attributes
  • 🌙 Theming: Built-in light/dark mode support
  • 🧩 Component Composition: Build complex alerts with custom content
  • 📦 Tree-Shakable: Import only what you need

🚀 Quick Start

import { useAlert } from 'sand-alerts';
import { CheckCircle } from 'lucide-react';

//Success alert
const SuccessExample = () => {
  const { showAlert } = useAlert();
  return (
    <button onClick={() => showAlert({
      type: 'success',
      message: 'Operation successful!',
      icon: CheckCircle,
      playSound: true,
      soundOptions: { volume: 0.6 }
    })}>
      Trigger Success
    </button>
  );
};

🛠️ Installation Steps:

1. Clone the repository

git clone https://github.com/sandundil2002/Sand-Alerts.git

2. Install dependencies

npm install

🍰 Contribution Guidelines:

Contributions to Sand Alert should use TypeScript for type safety follow React best practices with functional components and hooks and include proper documentation for new features while maintaining the existing project structure and Tailwind CSS styling. The pull request process requires updating documentation when needed ensuring all tests pass adding tests for new functionality requesting maintainer review and addressing feedback. Community members should be respectful and inclusive provide constructive feedback assist others in discussions and issues and adhere to the project's code of conduct.

💻 Built with

Technologies used in the project:

  • React - Core library for building the UI components
  • Next.js - React framework for server-side rendering and routing
  • TypeScript - Used for type-safe JavaScript development
  • Tailwind CSS - Utility-first CSS framework for styling
  • Lucide React - Icon library

🛡️ License:

This project is licensed under the MIT License - see the LICENSE file for details.

About

This repository contains a modern notification system built with next js and TypeScript that provides customizable alert components for web applications. It features multiple alert types (success, error, warning, info, confirm), sound options, and code snippet integration.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages