Skip to content

Replaces native browser dialogs (alert, confirm, prompt) with customizable, modern-looking notifications.

License

Notifications You must be signed in to change notification settings

a-hakim/senangwebs-notices

Repository files navigation

SenangWebs Learn more at SenangWebs.com

SenangWebs Notices (SWN)

SenangWebs Notices (SWN) is a lightweight JavaScript library that replaces native browser dialogs (alert, confirm, prompt) with customizable, modern-looking notifications. It provides a flexible way to create stylish modal dialogs with various positioning options and visual effects.

Features

  • Replace native browser dialogs (alert, confirm, prompt) with customizable alternatives
  • Multiple positioning options (center, top, bottom, corners, etc.)
  • Backdrop blur effect support
  • Customizable overlay colors and opacity
  • Template-based customization
  • Promise-based async/await support
  • Focus management for accessibility
  • No external dependencies

Installation

Using npm

npm install senangwebs-notices

Using a CDN

Include SenangWebs Notices directly in your HTML file using unpkg:

<script src="https://unpkg.com/senangwebs-notices@latest/dist/swn.js"></script>

Usage

  1. Initialize the library:
const notices = new SWN({
    // Optional configuration
    titleText: 'Custom Title',
    buttonText: 'OK',
    cancelText: 'Cancel',
    position: 'center',
    bgColor: '#000000',
    bgOpacity: 0.5,
    bgBlur: 3,
    zIndex: 9999
});

// Replace native dialogs (optional)
notices.install();
  1. Use directly or through native dialog functions:
// Using native functions (after install())
alert('Hello World!');
const confirmed = await confirm('Are you sure?');
const name = await prompt('Enter your name:', 'John Doe');

// Using library methods directly
await notices.show('Hello World!');
const confirmed = await notices.showConfirm('Are you sure?');
const name = await notices.showPrompt('Enter your name:');
  1. Custom template example:
<template id="custom-template">
    <div data-swn class="your-custom-classes">
        <div data-swn-title></div>
        <div data-swn-body></div>
        <div data-swn-buttons>
            <button data-swn-cancel></button>
            <button data-swn-ok></button>
        </div>
    </div>
</template>

<script>
const notices = new SWN({
    template: '#custom-template'
});
</script>

Configuration Options

Initialization Options

const notices = new SWN({
    titleText: 'Notice',           // Default title
    buttonText: 'OK',             // Text for OK button
    cancelText: 'Cancel',         // Text for Cancel button
    template: '#custom-template', // Template selector
    position: 'center',          // Dialog position
    bgColor: '#000000',         // Overlay color
    bgOpacity: 0.5,            // Overlay opacity (0-1)
    bgBlur: 0,                // Background blur in pixels
    zIndex: 9999,            // Base z-index
    inputPlaceholder: 'Enter your response...', // Prompt input placeholder
    defaultValue: ''        // Default value for prompt input
});

Supported Positions

  • center (default): Center of the screen
  • top: Top center
  • top left: Top left corner
  • top right: Top right corner
  • bottom: Bottom center
  • bottom left: Bottom left corner
  • bottom right: Bottom right corner
  • left: Middle left
  • right: Middle right

Data Attributes

The library uses these data attributes for templating:

  • data-swn: Main notice container
  • data-swn-title: Title container
  • data-swn-body: Message body container
  • data-swn-buttons: Buttons container
  • data-swn-ok: OK button
  • data-swn-cancel: Cancel button (for confirm/prompt)
  • data-swn-input: Input field (for prompt)

Methods

  • show(message): Display an alert dialog
  • showConfirm(message): Display a confirmation dialog
  • showPrompt(message): Display a prompt dialog
  • install(): Replace native dialog functions
  • uninstall(): Restore native dialog functions

Browser Support

SenangWebs Notices works on all modern browsers that support:

  • ES6+ features (Promise, async/await)
  • CSS Flexbox
  • backdrop-filter (optional, for blur effects)

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

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

Acknowledgments

  • Inspired by the need for more customizable dialog alternatives
  • Thanks to all contributors who have helped improve this library

Support

If you encounter any issues or have questions, please file an issue on the GitHub repository.

About

Replaces native browser dialogs (alert, confirm, prompt) with customizable, modern-looking notifications.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published