@rhds/elements/elements/rh-alert/rh-alert.d.ts

Red Hat Design System Elements

import { LitElement, type PropertyValues } from 'lit';
import '@rhds/elements/rh-surface/rh-surface.js';
export declare class AlertCloseEvent extends Event {
    constructor();
}
/**
 * An alert is a banner used to notify a user about a change in status
 * or communicate other information. It can be generated with or without
 * a user triggering an action first.
 *
 * @summary Notifies a user without blocking their workflow
 *
 * @fires {AlertCloseEvent} close - when the dismissable alert closes
 *
 * @slot         - Provide a description for the alert message
 * @slot header  - Provide a header for the alert message.
 * @slot actions - Provide actions that the user can take for the alert
 *
 */
export declare class RhAlert extends LitElement {
    #private;
    static readonly version = "{{version}}";
    static readonly styles: CSSStyleSheet;
    private get icon();
    /**
     * Communicates the urgency of a message and is denoted by various styling configurations.
     *
     *  - `default` - Indicates generic information or a message with no severity.
     *  - `info` - Indicates helpful information or a message with very little to no severity.
     *  - `success` - Indicates a success state, like if a process was completed without errors.
     *  - `warning` - Indicates a caution state, like a non-blocking error that might need to be fixed.
     *  - `danger` - Indicates a danger state, like an error that is blocking a user from completing a task.
     */
    state: 'default' | 'error' | 'success' | 'warning' | 'danger' | 'info';
    /**
     * The alternate Inline alert style includes a border instead of a line which
     * can be used to express more urgency or better grab the attention of a user.
     *
     * A Toast alert is used to present a global message about an event,
     * update, or confirmation, like the result of a user action that cannot
     * be presented within a specific layout or component.
     */
    variant?: 'alternate' | 'toast' | 'inline';
    /** @deprecated */
    toast: boolean;
    /**
     * Alert variants have different rules regarding their ability to be dismissed by a user.
     * Default, Info, and Success Inline alerts can be dismissed by a user selecting the close button.
     * Warning and Danger Inline alerts can be dismissed by a user resolving the issues caused by the alert.
     * All Toast alerts can be dismissed by a user selecting the close button or waiting for them to time out.
     */
    dismissable: boolean;
    willUpdate(changed: PropertyValues<this>): void;
    render(): import("lit").TemplateResult<1>;
}
declare global {
    interface HTMLElementTagNameMap {
        'rh-alert': RhAlert;
    }
}