Interface NotificationMessage

A record of a notification to be shown in the UI.

interface NotificationMessage {
    actionButtonLabel?: string;
    groupID?: string;
    kind:
        | "error"
        | "info"
        | "success"
        | "info-square"
        | "warning"
        | "warning-alt";
    message: string;
    onActionButtonClick?: () => void;
    onCloseButtonClick?: () => void;
    title: string;
}

Properties

actionButtonLabel? groupID? kind message onActionButtonClick? onCloseButtonClick? title

Properties

OptionalactionButtonLabel

actionButtonLabel?: string

An optional action button that a user can click. If there is an action button, we will not auto dismiss.

OptionalgroupID

groupID?: string

The group id that associates notifications together. This can be used to remove the notification later.

kind

kind: "error" | "info" | "success" | "info-square" | "warning" | "warning-alt"

message

message: string

The message to show.

OptionalonActionButtonClick

onActionButtonClick?: () => void

The callback called when someone clicks on the action button.

OptionalonCloseButtonClick

onCloseButtonClick?: () => void

The callback called when someone clicks on the close button.

title

title: string

The title to show in the message.

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR