govbr-ds-angular/lib/components/alert/alert.service.d.ts

Implementação em Angular do Design System GovBR.

import { StateType } from '../../utils';
import * as i0 from "@angular/core";
/**
 * Representa um evento de alerta.
 */
export type AlertEvent = {
    /** Tipo do estado do alerta. */
    type: StateType;
    /** Mensagem do alerta. */
    message: string;
    /** Título opcional do alerta. */
    title?: string;
    /** Duração opcional do alerta em milissegundos. */
    duration?: number;
    /** Indica se o alerta deve fechar automaticamente. */
    autoClose?: boolean;
    /** ID do timeout para fechamento automático do alerta. */
    closeTimeId?: any;
    /** Indica se o alerta pode ser fechado manualmente. */
    closable?: boolean;
};
/**
 * Serviço para exibir alertas na aplicação.
 * @public
 * @example
 * // Exemplo de uso do serviço de alerta.
 * private alertService = inject(AlertService);
 * alertService.showAlert('success', 'Operação realizada com sucesso.');
 */
export declare class AlertService {
    private readonly _alert;
    private readonly _clear;
    /** Observable para eventos de alerta. */
    get alertEvents$(): import("rxjs").Observable<AlertEvent>;
    /**
     * Define e emite um novo evento de alerta.
     * @internal
     * */
    private set alertEvents(value);
    /**
     * Observable para eventos de limpeza de alerta.
     * @internal
     * */
    get clearEvent$(): import("rxjs").Observable<void>;
    /**
     * Exibe um alerta com as propriedades especificadas.
     * @param type - Tipo do estado do alerta.
     * @param message - Mensagem do alerta.
     * @param title - Título opcional do alerta.
     * @param autoClose - Indica se o alerta deve fechar automaticamente.
     * @param duration - Duração opcional do alerta em milissegundos.
     * @param closable - Indica se o alerta pode ser fechado manualmente.
     * @param delay - Atraso opcional antes de exibir o alerta.
     */
    showAlert(type: StateType, message: string, title?: string, autoClose?: boolean, duration?: number, closable?: boolean, delay?: number): void;
    /** Limpa todos os alertas emitindo um evento de limpeza. */
    clearAlerts(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<AlertService, never>;
    static ɵprov: i0.ɵɵInjectableDeclaration<AlertService>;
}