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

Biblioteca de Web Components baseado no GovBR-DS

/**
 * Para uma descrição detalhada, consulte a [documentação do GovBR-DS](https://www.gov.br/ds/components/avatar?tab=designer).
 */
export declare class Avatar {
    /**
     * Referência ao elemento host do componente.
     * Utilize esta propriedade para acessar e manipular o elemento do DOM associado ao componente.
     */
    el: HTMLBrAvatarElement;
    /**
     * Ajusta a densidade, alterando o espaçamento interno para um visual mais compacto ou mais expandido.
     */
    density: 'small' | 'medium' | 'large';
    handleDensityChange(newValue: 'small' | 'medium' | 'large'): void;
    /**
     * Executa validações iniciais quando o componente é carregado
     */
    componentWillLoad(): void;
    /**
     * Identificador único.
     * Caso não seja fornecido, um ID gerado automaticamente será usado.
     */
    readonly customId: string;
    /**
     * URL da imagem a ser exibida no avatar do tipo 'fotográfico'.
     * Deve ser uma URL válida que aponta para a imagem desejada.
     */
    readonly src: string;
    /**
     * Texto alternativo (alt) associado à imagem do avatar. Essencial para acessibilidade e SEO.
     * Deve descrever de forma clara e concisa o conteúdo da imagem, por exemplo: "Foto de perfil de João Silva".
     */
    readonly alt = "Imagem do avatar";
    /**
     * Indica se o avatar deve ser exibido como um ícone em vez de uma imagem fotográfica.
     * Se definido como verdadeiro, o avatar será exibido como um ícone.
     */
    readonly isIconic: boolean;
    /**
     * Texto exibido no avatar do tipo 'letra'.
     * Esse texto será mostrado em vez de uma imagem e pode ser usado para representar iniciais ou outras informações textuais.
     */
    readonly text: string;
    /**
     * Largura do ícone no avatar do tipo icônico
     * */
    readonly iconWidth: string;
    /**
     * Altura do ícone no avatar do tipo icônico
     */
    readonly iconHeight: string;
    /**
     * Ajuste para a margem de cima do ícone no avatar do tipo icônico
     */
    readonly iconMarginTop: string;
    /**
     * Define se o avatar está desabilitado
     */
    readonly disabled = false;
    private hasError;
    /**
     * Gera um mapa de classes CSS com base nas propriedades do componente.
     * O mapa de classes determina quais classes CSS devem ser aplicadas
     * ao elemento host do componente, ajustando sua aparência.
     *
     * @returns {CssClassMap} Objeto contendo as classes CSS aplicadas.
     */
    private getCssClassMap;
    private readonly iconSizes;
    private readonly iconMarginTops;
    private readonly handleImageError;
    private renderAvatar;
    render(): any;
}