SCION Workbench Client - v1.0.0-beta.35
    Preparing search index...

    Interface WorkbenchNotificationConfig

    Configures the content and appearance of a notification presented to the user.

    A notification is a closable message that appears in the upper-right corner and disappears automatically after a few seconds. It informs the user of a system event, e.g., that a task has been completed or an error has occurred.

    Multiple notifications are stacked vertically. Notifications can be grouped. For each group, only the last notification is displayed at any given time.

    interface WorkbenchNotificationConfig {
        content?: unknown;
        cssClass?: string | string[];
        duration?: number | "short" | "medium" | "long" | "infinite";
        group?: string;
        params?: Map<string, any> | Dictionary<unknown>;
        severity?: "error" | "info" | "warn";
        title?: string;
    }
    Index

    Properties

    content?: unknown

    Specifies the content to be displayed in the notification.

    The content may differ per notification provider, as determined by the qualifier. For example, the built-in notification expects a text message in form of a Translatable. Refer to the documentation of the notification capability provider for more information.

    cssClass?: string | string[]

    Specifies CSS class(es) to add to the notification, e.g., to locate the notification in tests.

    duration?: number | "short" | "medium" | "long" | "infinite"

    Specifies the timeout after which to close the notification automatically. Defaults to medium. Can be either a duration alias, or a number in seconds.

    group?: string

    Specifies the group which this notification belongs to. If specified, the notification will replace any previously displayed notification of the same group.

    params?: Map<string, any> | Dictionary<unknown>

    Passes data to the notification.

    The notification can declare mandatory and optional parameters. No additional parameters are allowed. Refer to the documentation of the capability for more information.

    severity?: "error" | "info" | "warn"

    Specifies the severity of the notification. Defaults to info.

    title?: string

    Specifies the title of the notification.

    Can be text or a translation key. A translation key starts with the percent symbol (%) and may include parameters in matrix notation for text interpolation.