Skip to content

Alerts Mod

Overview

The Alerts Mod plugin enhances the alert system in Aliveforms by offering fully customizable notifications. It replaces the default alert behavior with animated, styled alerts that can be positioned anywhere on the screen. Alerts can be configured to display different styles, include close buttons, and auto-dismiss after a specified timeout. Additionally, alerts can pause their auto-dismiss timer when hovered.

Usage

To use the Alerts Mod plugin, follow these steps:

  1. Apply the plugin to your form by including the plugin's script in your project.
  2. The plugin will automatically replace the default alert system with the new styled alerts.

You can also manually trigger alerts via the $.Alert() API.

API Documentation

The Alerts Mod can be triggered using the following API:

$.Alert(message, options);

Parameters

  • message (string): The message content to display in the alert.

  • options (object, optional): An object containing configuration options for the alert. The available options are:

  • style (string): The style of the alert. Default is 'info'. Possible values:

    • 'info': Blue information alert.
    • 'success': Green success alert.
    • 'warning': Orange warning alert.
    • 'error': Red error alert.
    • 'custom': Grey custom alert.

  • timeout (number): The duration in milliseconds before the alert automatically disappears. Default is 3000 (3 seconds). Set to 0 to disable auto-dismiss.

  • show_close (boolean): Whether to show a close button in the alert. Default is true. If false, the alert will not have a close button.

  • position (string): The position of the alert on the screen. Default is 'top_right'. Possible values:

    • 'top_left': Top-left corner.
    • 'top_center': Top center.
    • 'top_right': Top-right corner.
    • 'center': Center of the screen.
    • 'bottom_left': Bottom-left corner.
    • 'bottom_center': Bottom center.
    • 'bottom_right': Bottom-right corner.

Example

$.Alert("This is an info alert!", {
  style: 'info',
  timeout: 5000,
  show_close: true,
  position: 'top_center'
});

Behavior

  • Positioning: Alerts can be positioned at different corners or the center of the screen, based on the selected position option.

  • Styling: Each alert can have one of the predefined styles (info, success, warning, error, custom) for different types of notifications.

  • Auto-Dismiss: Alerts automatically disappear after the specified timeout. Hovering over an alert will pause the auto-dismiss countdown.

  • Close Button: The close button, when enabled, allows users to dismiss the alert manually. The button is placed in the top-right corner of the alert.

Benefits

  • Customizable alert styles and positions for a more tailored user experience.
  • Support for both automatic dismissal and manual closing of alerts.
  • Pause auto-dismiss behavior on hover to keep alerts visible longer if needed.
  • Easily replace the default alert system with a more dynamic and modern notification system.