@microsoft/windows-admin-center-sdk/angular/src/controls/page-alert-bar/models/page-alert.d.ts

Microsoft - Windows Admin Center Shell

/**
 * The levels of severity that are able to be portrayed by an page alert.
 */
export declare enum HealthAlertSeverity {
    Critical = 0,
    Error = 1,
    Warning = 2,
    Progress = 5,
    Info = 3,
    Success = 6,
    Neutral = 4,
    Upsell = 7
}
/**
 * The External Link Interface.
 */
export interface ExternalLink {
    /**
     * The link title.
     */
    title: string;
    /**
     * The link url.
     */
    url: string;
    /**
     * The class for sme-icon.
     */
    iconClass?: string;
}
/**
 * The Page Alert.
 */
export interface PageAlert {
    /**
     * The severity of the alert which dictates how it will be displayed.
     */
    severity: HealthAlertSeverity;
    /**
     * Optional icon class that can be specified to override default set by severity.
     */
    iconClass?: string;
    /**
     * String that will be displayed on the alert.
     */
    message: string;
    /**
     * Optional additional data that will be shown on hover of action.
     */
    detailsCaption?: string;
    /**
     * String that will be the title of the action, defaults to 'Details'.
     */
    detailsLabel?: string;
    /**
     * An optional external link that can be used inplace of a custom action.
     */
    externalLink?: ExternalLink;
    /**
     * A custom action for the details link.
     * @param event any information that needs to be passed into the command.
     */
    detailsCommand?(event: any): void;
}