@govbr-ds/webcomponents
Version:
Biblioteca de Web Components baseado no GovBR-DS
58 lines (57 loc) • 2.31 kB
TypeScript
import { EventEmitter } from '../../stencil-public-runtime';
/**
* Para uma descrição detalhada, consulte a [documentação do GovBR-DS](https://www.gov.br/ds/components/modal?tab=designer).
*
* @slot header - Cabeçalho do modal. Se não for usado, o `title-text` será exibido.
* @slot default - Corpo do modal.
* @slot footer - Rodapé do modal.
* @slot close-button - Botão de fechar customizado. Se não for usado, o botão padrão será exibido.
*
*/
export declare class Modal {
/** Referência ao elemento host do componente. */
el: HTMLBrModalElement;
elementInternals: ElementInternals;
/**
* Identificador único.
* Caso não seja fornecido, um ID gerado automaticamente será usado.
*/
readonly customId: string;
/** O texto do título a ser exibido no cabeçalho do modal. Usado quando o slot `header` não é fornecido. */
readonly titleText: string;
/** Controla a visibilidade do modal. */
show: boolean;
/** Se `true`, o modal se fechará automaticamente ao clicar no botão de fechar ou pressionar a tecla 'Escape'. */
autoClose: boolean;
/** Seletor CSS para o elemento que deve receber foco quando o modal é aberto. */
readonly initialFocusSelector: string;
/**
* Define o tamanho (largura) do modal.
* Valores possíveis: 'xsmall', 'small', 'medium', 'large', 'auto'.
*/
readonly size: 'xsmall' | 'small' | 'medium' | 'large' | 'auto';
/** Se `true`, exibe um fundo escurecido (scrim) atrás do modal. */
readonly scrim = false;
/** Se `true`, habilita a rolagem interna do conteúdo do modal. */
readonly scrollable = false;
/**
* Define o alinhamento do conteúdo do rodapé (slot="footer").
* Valores possíveis: 'start', 'end', 'center'.
*/
readonly alignFooter: 'start' | 'end' | 'center';
/** Evento emitido quando o modal solicita ser fechado (pelo botão 'x', tecla 'Escape' ou clique no scrim). */
brModalClose: EventEmitter<void>;
private get titleId();
private get contentId();
private getCssClassMap;
private handleClose;
/**
* Método público para abrir o modal
*/
open(): Promise<void>;
/**
* Método público para fechar o modal
*/
close(): Promise<void>;
render(): any;
}