Variable NotificationsConst

Type Declaration

• notify: function

  • notify(
        message: string,
        typeOrOptions?: NotifyType | NotifyOptions,
        duration?: number,
    ): HTMLElement | null | undefined

    Displays a notification toast.

    Supports two call signatures:

    • notify(message, type, duration) — positional, e.g. notify("OK", "success", 3000)
    • notify(message, options) — options object, e.g. notify("OK", { type: "success", duration: 3000 })

    Parameters

    • message: string

      Text to display.

    • OptionaltypeOrOptions: NotifyType | NotifyOptions

      Notification type ("info" | "success" | "warning" | "error") or options object.

    • Optionalduration: number

      Auto-dismiss duration in ms (only when typeOrOptions is a string).

    Returns HTMLElement | null | undefined

    The toast element (null if rejected, undefined if uninitialised).

• show: function

  • show(
        message: string,
        typeOrOptions?: NotifyType | NotifyOptions,
        duration?: number,
    ): HTMLElement | null | undefined

    Displays a notification toast. Alias of Notifications.notify, kept because the renderer, the legacy GeoLeaf.UI.showNotification surface and the plugin documentation all name this method — calling it used to hit undefined and fail silently.

    Parameters

    • message: string

      Text to display.

    • OptionaltypeOrOptions: NotifyType | NotifyOptions

      Notification type or options object.

    • Optionalduration: number

      Auto-dismiss duration in ms (only when typeOrOptions is a string).

    Returns HTMLElement | null | undefined

    The toast element (null if rejected, undefined if uninitialised).

    Example

    GeoLeaf.Notifications.show("Feature is stale", { type: "warning" });
    Copy

• success: function

  • success(
        message: string,
        options?: number | NotifyOptions,
    ): HTMLElement | null | undefined

    Displays a success toast.

    Parameters

    • message: string

      Text to display.

    • Optionaloptions: number | NotifyOptions

      Optional duration (ms) or options object.

    Returns HTMLElement | null | undefined

    The toast element (null if rejected, undefined if uninitialised).

    Example

    Notifications.success("Sauvegarde réussie");
    Notifications.success("Sauvegarde réussie", { duration: 2000 });
    Copy

• error: function

  • error(
        message: string,
        options?: number | NotifyOptions,
    ): HTMLElement | null | undefined

    Displays an error toast (highest priority, longest default duration: 5 s).

    Parameters

    • message: string

      Text to display.

    • Optionaloptions: number | NotifyOptions

      Optional duration (ms) or options object.

    Returns HTMLElement | null | undefined

    The toast element (null if rejected, undefined if uninitialised).

    Example

    Notifications.error("Erreur réseau", { persistent: true, dismissible: true });
    Copy

• warning: function

  • warning(
        message: string,
        options?: number | NotifyOptions,
    ): HTMLElement | null | undefined

    Displays a warning toast.

    Parameters

    • message: string

      Text to display.

    • Optionaloptions: number | NotifyOptions

      Optional duration (ms) or options object.

    Returns HTMLElement | null | undefined

    The toast element (null if rejected, undefined if uninitialised).

    Example

    Notifications.warning("Connexion instable", { duration: 6000 });
    Copy

• info: function

  • info(
        message: string,
        options?: number | NotifyOptions,
    ): HTMLElement | null | undefined

    Displays an informational toast.

    Parameters

    • message: string

      Text to display.

    • Optionaloptions: number | NotifyOptions

      Optional duration (ms) or options object.

    Returns HTMLElement | null | undefined

    The toast element (null if rejected, undefined if uninitialised).

    Example

    Notifications.info("3 nouvelles alertes disponibles");
    Copy

• dismiss: function

  • dismiss(toastEl: HTMLElement): void

    Dismisses a specific toast by its DOM element reference.

    Parameters

    • toastEl: HTMLElement

      The toast HTMLElement returned by a previous call.

    Returns void

    Example

    const toast = Notifications.info("Chargement…", { persistent: true });
    // later:
    if (toast) Notifications.dismiss(toast);
    Copy

• clearAll: function

  • clearAll(): void

    Removes all visible toasts and clears the pending queue.

    Returns void

    Example

    Notifications.clearAll();
    Copy

• getStatus: function

  • getStatus(): NotifyStatus

    Returns a snapshot of the current notification system state. Useful for debugging or building custom status indicators.

    Returns NotifyStatus

    Current system status.

    Example

    const status = Notifications.getStatus();
    console.log(status.activeToasts, status.queued);
    Copy