centurion-erp-ui
    Preparing search index...

    Interface NotificationActions

    0.9.0

    interface NotificationActions {
        addNewNotification: (
            title: string,
            description: string,
            variant: AlertVariant,
            isAlert?: boolean,
        ) => void;
        buildOverflowMessage: () => void;
        markNotificationRead: (key: string) => void;
        removeAlert: (key: string) => void;
        removeAllAlerts: () => void;
    }
    Index

    Properties

    addNewNotification buildOverflowMessage markNotificationRead removeAlert removeAllAlerts

    Properties

    addNewNotification: (
        title: string,
        description: string,
        variant: AlertVariant,
        isAlert?: boolean,
    ) => void

    Creates both a Notification and an Alert.

    Type Declaration

      • (
            title: string,
            description: string,
            variant: AlertVariant,
            isAlert?: boolean,
        ): void

      • Parameters

        • title: string

          Title to use for the notification.

        • description: string

          Description of the notification.

        • variant: AlertVariant

          Type of notification to use.

        • OptionalisAlert: boolean

          Make the Notification show up as an alert.

        Returns void

    0.9.0

    buildOverflowMessage: () => void

    When the number of alerts hits the max allowed to be displayed, this function will create a "summary message" to show that the alerts displayed have been truncated.

    Truncated alerts will not be displayed and will automagically appear in the Notifications drawer.

    0.9.0

    markNotificationRead: (key: string) => void

    Marks a notification that in the Notifications drawer as read.

    0.9.0

    removeAlert: (key: string) => void

    Removes an alert from the alert state object.

    0.9.0

    removeAllAlerts: () => void

    Removes all alerts from the alert state object.

    0.9.0

    Settings

    Member Visibility

    On This Page

    Properties