@govbr-ds/webcomponents/dist/types/components/message/message.d.ts

Biblioteca de Web Components baseado no GovBR-DS

import { EventEmitter } from '../../stencil-public-runtime';
/**
 * Para uma descrição detalhada, consulte a [documentação do GovBR-DS](https://www.gov.br/ds/components/message?tab=designer).
 *
 * @slot default - Utilizado para inserir qualquer conteúdo que será exibido no corpo da mensagem.
 */
export declare class Message {
    /**
     * Referência ao elemento host do componente.
     * Utilize esta propriedade para acessar e manipular o elemento do DOM associado ao componente.
     */
    el: HTMLBrMessageElement;
    elementInternals: ElementInternals;
    /**
     * Define o título da mensagem, que é exibido no início, acima da mensagem principal.
     * Este título serve para destacar a mensagem textual. Não é aplicável para mensagens do tipo feedback.
     */
    readonly messageTitle: string;
    /**
     * Identificador único.
     * Caso não seja fornecido, um ID gerado automaticamente será usado.
     */
    readonly customId: string;
    /**
     * Define o texto da mensagem que será exibido.
     * Este é o conteúdo principal da mensagem. A propriedade `message` é obrigatória e deve ser fornecida para que a mensagem apareça.
     */
    readonly message: string;
    /**
     * Se definido como verdadeiro, o título da mensagem será exibido na mesma linha que a mensagem principal.
     * Isso pode ser útil para criar um layout onde o título e a mensagem estão alinhados horizontalmente.
     */
    readonly isInline: boolean;
    /**
     * Se definido como verdadeiro, um botão de fechar será exibido para permitir que o usuário feche a mensagem.
     * O fechamento emitirá o evento `brDidClose`, mas não removerá automaticamente o componente do DOM, a menos que a propriedade `autoRemove` também esteja definida como `true`.
     * Este recurso não está disponível para mensagens do tipo feedback.
     */
    readonly isClosable: boolean;
    /**
     * Controla o comportamento do fechamento do componente quando `isClosable` é verdadeiro.
     * - Se definido como `true`, o componente será automaticamente removido do DOM ao clicar no botão de fechar.
     * - Se definido como `false`, o componente permanecerá no DOM e apenas emitirá o evento `brDidClose`.
     *
     * Esta propriedade não tem efeito se `isClosable` for `false`.
     * O valor padrão é `false`.
     */
    autoRemove: boolean;
    /**
     * Se definido como verdadeiro, um ícone associado à mensagem será exibido.
     * Use esta propriedade para mostrar ou ocultar o ícone da mensagem conforme necessário.
     */
    readonly showIcon: boolean;
    /**
     * Define se a mensagem é do tipo feedback, geralmente usada para fornecer contexto adicional sobre ações do usuário.
     * Exemplos incluem mensagens de validação em campos de formulário. Não disponível para mensagens que não sejam de feedback.
     */
    readonly isFeedback: boolean;
    /**
     * Define o estado do message.
     * Os possíveis valores são:
     * - 'info': Mensagem informativa.
     * - 'warning': Mensagem de aviso.
     * - 'danger': Mensagem de erro ou alerta.
     * - 'success': Mensagem de sucesso.
     * O valor padrão é 'info'.
     */
    readonly state: 'info' | 'warning' | 'danger' | 'success';
    /** Evento emitido quando o usuário fecha a mensagem, se closable for true. */
    brDidClose: EventEmitter;
    private readonly dismissHandler;
    private checkIconState;
    private getCssClassMap;
    render(): any;
}