@govbr-ds/webcomponents/dist/types/components/radio/radio.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/radio?tab=designer).
 *
 * @slot default - O texto descritivo pode ser passado por propriedade (label) ou por slot.
 */
export declare class Radio {
    /**
     * Referência ao elemento host do componente.
     * Utilize esta propriedade para acessar e manipular o elemento do DOM associado ao componente.
     */
    el: HTMLBrRadioElement;
    elementInternals: ElementInternals;
    /**
     * Define o estado de seleção do radio.
     * Se definido como verdadeiro, o radio estará marcado. Caso contrário, estará desmarcado.
     */
    checked: boolean;
    /**
     * Desativa o radio, tornando-o não interativo.
     */
    readonly disabled: boolean;
    /**
     * Indica a validade do radio.
     * Valores possíveis:
     * - 'valid': O radio é considerado válido.
     * - 'invalid': O radio é considerado inválido.
     * Se não for especificado, o valor padrão é `null`, indicando que a validade não foi definida.
     */
    readonly state: 'valid' | 'invalid';
    /**
     * Define se o label associado ao radio deve ser oculto.
     * Se definido como verdadeiro, o texto do label será oculto, mas o radio ainda estará visível e funcional.
     */
    readonly hasHiddenLabel: boolean;
    /**
     * Identificador único.
     * Caso não seja fornecido, um ID gerado automaticamente será usado.
     */
    readonly customId: string;
    /**
     * Define o nome do radio, que é utilizado para agrupar radios em formulários e identificar o campo.
     * O valor é obrigatório e deve ser fornecido para garantir o correto funcionamento em formulários.
     */
    readonly name: string;
    /**
     * Texto descritivo exibido à direita do radio.
     * Caso um slot seja utilizado para fornecer um texto alternativo, o valor desta propriedade será ignorado.
     */
    readonly label: string;
    /**
     * Define o valor associado ao radio quando ele faz parte de um formulário nativo (`<form>`).
     * Esse valor é enviado com o formulário quando o radio está selecionado.
     * **Nota:** Esta propriedade não deve ser utilizada para determinar se o radio está selecionado; para verificar o estado de seleção, use a propriedade `checked`.
     */
    readonly value: string;
    /**
     * Disparado depois que o valor do `checked` foi alterado
     */
    checkedChange: EventEmitter<boolean>;
    handleCheckedChange(event: CustomEvent): void;
    /**
     * Navega e seleciona o próximo/anterior rádio habilitado no grupo via teclas de seta.
     * Ativado por 'keydown', move a seleção entre rádios do mesmo 'name'
     * usando as setas, partindo do rádio atualmente checado.
     * @param {KeyboardEvent} event O evento de teclado.
     * @listens keydown
     */
    handleKeyDown(event: KeyboardEvent): void;
    /**
     * Inverte o valor da prop `checked`
     */
    toggleChecked(): Promise<void>;
    private getCssClassMap;
    /**
     * Handler para o event `click`
     * @param event Objeto Event
     */
    private readonly onClick;
    /**
     * Handler para o evento `change`
     */
    private readonly onChange;
    render(): any;
}