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

    Interface WorkbenchNotificationOptions

    Controls the appearance and behavior of a notification.

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

    Properties

    cssClass? duration? group? params? severity? title?

    Properties

    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"

    Controls how long to display the notification.

    Can be a duration alias, or milliseconds.

    group?: string

    Specifies the group to which the notification belongs. Only the most recent notification within a group is displayed.

    params?: Map<string, unknown> | { [param: string]: 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.

    Settings

    Member Visibility

    On This Page

    Properties