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

Microsoft - Windows Admin Center Shell

import { Injector } from '@angular/core';
import { SpacerBaseDirective } from '../common/spacer-base.component';
import { StatusIconType } from '../icon/layered-icon/status/status-icon.component';
import { PageAlert } from './models/page-alert';
import * as i0 from "@angular/core";
/**
 *
 * @smeDoc {@label Page Alert Bar @id sme-page-alert-bar-component}
 *
 * @overview
 * @file {@filepath ./examples/page-alert-bar-overview.md}
 *
 * @example {@label Basic Usage @id basic-usage}
 * @file {@filename component.html @filepath ./examples/basic-usage.component.html}
 * @file {@filename component.ts @filepath ./examples/basic-usage.component.ts}
 *
 * @example {@label Custom Usage @id custom-usage}
 * @file {@filename component.html @filepath ./examples/custom-usage.component.html}
 * @file {@filename component.ts @filepath ./examples/custom-usage.component.ts}
 */
export declare class PageAlertBarComponent extends SpacerBaseDirective {
    /**
     * The source name to use for logging
     */
    protected get logSourceName(): string;
    defaultDetailsLabel: string;
    /**
     * It indicates whether the alert bar is transparent or not.
     */
    isBackgroundTransparent: boolean;
    /**
     * Critical alerts.
     */
    get isCritical(): boolean;
    /**
     * Error alerts.
     */
    get isError(): boolean;
    /**
     * Warning alerts.
     */
    get isWarning(): boolean;
    /**
     * Progress alerts.
     */
    get isPending(): boolean;
    /**
     * Informational alerts.
     */
    get isInformational(): boolean;
    /**
     * Success alerts.
     */
    get isSuccessful(): boolean;
    /**
     * Upsell alerts.
     */
    get isUpsell(): boolean;
    /**
     * Neutral alerts.
     */
    get isNeutral(): boolean;
    /**
     * Transparent alerts.
     */
    get isTransparent(): boolean;
    /**
     * When the background is transparent, we can optionally remove the left padding for allignment with other UI elements.
     * When with the backgound color, we need to keep the left padding for visually bordering the alert.
     */
    get isNoLeftPadding(): boolean;
    /**
     * An interface that dictates how to display the alert.
     */
    alert: PageAlert;
    get iconClass(): string;
    /**
     * Gets the status icon type based on the alert severity.
     */
    get statusIcon(): StatusIconType;
    constructor(injector: Injector);
    /**
     * Gets the initial host classes to be applied to this element
     */
    protected getInitialHostClasses(): string[];
    static ɵfac: i0.ɵɵFactoryDeclaration<PageAlertBarComponent, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<PageAlertBarComponent, "sme-page-alert-bar", never, { "isBackgroundTransparent": "isBackgroundTransparent"; "alert": "alert"; }, {}, never, never, false, never>;
}