@govbr-ds/webcomponents/dist/types/components/switch/switch.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/switch?tab=designer).
 *
 * @slot default - Descreve o que o switch faz quando a alternância estiver ativada. A label passada por slot tem precedência sobre a propriedade 'label'.
 */
export declare class Switch {
    /**
     * Referência ao elemento host do componente.
     * Utilize esta propriedade para acessar e manipular o elemento do DOM associado ao componente.
     */
    el: HTMLBrSwitchElement;
    elementInternals: ElementInternals;
    /**
     * Desativa o switch, tornando-o não interativo.
     */
    readonly disabled: 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;
    /**
     * Texto descritivo.
     * Caso um slot seja utilizado para fornecer um texto alternativo, o valor desta propriedade será ignorado.
     */
    readonly label: string;
    /**
     * Posição do rótulo em relação ao switch.
     */
    readonly labelPosition: 'right' | 'left' | 'top';
    /**
     * Texto exibido quando o switch está ativado.
     */
    readonly labelOn: string;
    /**
     * Texto exibido quando o switch está desativado.
     */
    readonly labelOff: string;
    /**
     * Adiciona um ícone ao switch para indicar a mudança de estado.
     */
    readonly hasIcon: boolean;
    /**
     * Define o nome do switch, que é utilizado para agrupar switches 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;
    /**
     * Define o valor associado ao switch quando ele faz parte de um formulário nativo (`<form>`).
     * Esse valor é enviado com o formulário quando o switch está selecionado.
     * **Nota:** Esta propriedade não deve ser utilizada para determinar se o switch está selecionado; para verificar o estado de seleção, use a propriedade `checked`.
     */
    readonly value: string;
    /** O ajuste da densidade consiste em aumentar ou reduzir a área de interação do switch. Quanto menor for a densidade, maior a área de interação. */
    readonly density: 'large' | 'medium' | 'small';
    _slotDefault: boolean;
    componentWillLoad(): void;
    /**
     * Disparado depois que o valor do `checked` foi alterado
     */
    checkedChange: EventEmitter<boolean>;
    private _hasSlotContentDefault;
    /**
     * Determina o texto a ser usado para acessibilidade quando não há label visível
     */
    private getAccessibilityLabel;
    private readonly handleCheckedChange;
    private readonly handleClick;
    /**
     * Inverte o valor da prop `checked`
     */
    toggleChecked(): Promise<void>;
    /**
     * Verifica se o componente tem texto visível (via slot ou label)
     */
    private hasVisibleText;
    private getCssClassMap;
    render(): any;
}