@govbr-ds/webcomponents/dist/types/components/checkbox/checkbox.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/checkbox?tab=designer).
 *
 * @slot default - O texto descritivo pode ser passado por propriedade (label) ou por slot.
 *
 * @example
 * ```html
 * <br-checkbox label="Aceito os termos"></br-checkbox>
 * ```
 */
export declare class Checkbox {
    /**
     * Referência ao elemento host do componente.
     * Utilize esta propriedade para acessar e manipular o elemento do DOM associado ao componente.
     */
    el: HTMLBrCheckboxElement;
    elementInternals: ElementInternals;
    /**
     * Define o estado intermediário do checkbox.
     * Quando verdadeiro, exibe uma marcação parcial visual que indica seleção parcial.
     * Útil para representar grupos onde alguns itens estão selecionados, mas não todos.
     * Ao clicar no checkbox neste estado, ele será automaticamente alterado para marcado.
     */
    indeterminate: boolean;
    /**
     * Define o estado de seleção do checkbox.
     * Se definido como verdadeiro, o checkbox estará marcado. Caso contrário, estará desmarcado.
     */
    checked: boolean;
    /**
     * Identificador único.
     * Caso não seja fornecido, um ID gerado automaticamente será usado.
     */
    readonly customId: string;
    /**
     * Desativa o checkbox, tornando-o não interativo.
     */
    readonly disabled: boolean;
    /**
     * Define se o label associado ao checkbox deve ser oculto.
     * Se definido como verdadeiro, o texto do label será oculto, mas o checkbox ainda estará visível e funcional.
     */
    readonly hasHiddenLabel: boolean;
    /**
     * Texto descritivo exibido à direita do checkbox.
     * Caso um slot seja utilizado para fornecer um texto alternativo, o valor desta propriedade será ignorado.
     */
    readonly label: string;
    /**
     * Define o nome do checkbox, que é utilizado para agrupar checkboxes 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;
    /**
     * Indica a validade do checkbox.
     * Valores possíveis:
     * 'valid': O checkbox é considerado válido.
     * 'invalid': O checkbox é 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 o valor associado ao checkbox quando ele faz parte de um formulário nativo (`<form>`).
     * Esse valor é enviado com o formulário quando o checkbox está selecionado.
     * **Nota:** Esta propriedade não deve ser utilizada para determinar se o checkbox está selecionado; para verificar o estado de seleção, use a propriedade `checked`.
     */
    readonly value: string;
    slotDefault: boolean;
    /**
     * Disparado depois que o valor do `checked` foi alterado
     */
    checkedChange: EventEmitter<boolean>;
    /**
     * Disparado depois que o valor do `indeterminate` foi alterado.
     */
    indeterminateChange: EventEmitter<boolean>;
    updateIndeterminate(newValue: boolean): void;
    componentWillLoad(): void;
    private hasSlotContentDefault;
    private getCssClassMap;
    private getAriaCheckedValue;
    private readonly handleCheckedChange;
    /**
     * Define o estado indeterminado do checkbox.
     * @param value Novo valor para o estado indeterminado.
     */
    setIndeterminate(value: boolean): Promise<void>;
    /**
     * Inverte o valor da prop `checked`
     */
    toggleChecked(): Promise<void>;
    render(): any;
}