@govbr-ds/webcomponents/dist/types/components/step/step.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/step?tab=designer).
 *
 * @slot default - Slot que abriga o componente step-item. Este slot tem a particularidade de aceitar somente o componente step-item em sua composição. Caso outro elemento ou componente seja incluído dentro dele, o componente Step não será renderizado, e uma mensagem de erro será exibida no console.
 */
export declare class Step {
    /**
     * Referência ao elemento host do componente.
     * Utilize esta propriedade para acessar e manipular o elemento do DOM associado ao componente.
     */
    el: HTMLBrStepElement;
    elementInternals: ElementInternals;
    /**
     * propriedade responsável por definir a orientação do componente Step
     */
    layout: 'horizontal' | 'vertical';
    /**
     *
     * define o passo que começará destacado
     */
    initialStep: string;
    /**
     *
     * Propriedade que  define a posição onde o texto de destaque,label, ficará localizado no stepItem
     */
    labelPosition?: 'top' | 'right' | 'bottom' | 'left';
    /**
     *
     * Propriedade que define o tipo de conteúdo a ser exibido dentro do componente step  e stepItem
     */
    contentType: 'default' | 'br-icon' | 'no-content' | 'slotted';
    /**
     *
     * Propriedade que define o tipo de comportamento que o componente Step deverá seguir
     */
    mode: 'controller' | 'step';
    /**
     *
     * Propriedade que define o tipo de progressão de etapas que o step vai executar
     */
    progressionType: 'linear' | 'nonlinear';
    activeStep: number;
    stepItems: Element[];
    /**
     * Emite um evento após o componente ter sido carregado pela primeira vez.
     * Utilize este evento para realizar ações que devem ocorrer depois que o componente foi totalmente carregado.
     * Consulte a documentação do [Stencil](https://stenciljs.com/docs/component-lifecycle#componentdidload) para mais detalhes.
     */
    brDidLoad: EventEmitter<void>;
    componentDidLoad(): void;
    /**
     * Emite um evento antes do componente ser renderizado pela primeira vez, permitindo a preparação de dados ou inicializações necessárias.
     * Utilize este evento para realizar ações que devem ocorrer depois que o componente foi totalmente carregado.
     * Consulte a documentação do [Stencil](https://stenciljs.com/docs/component-lifecycle#componentdwillLoad) para mais detalhes.
     */
    brWilLoad: EventEmitter<void>;
    componentWillLoad(): void;
    /**
     * Emite um evento para indicar se o componente deve ser atualizado ou não.
     * Este evento é chamado antes de qualquer atualização do componente para decidir se a atualização deve prosseguir.
     * Consulte a documentação do [Stencil](https://stenciljs.com/docs/component-lifecycle#componentshouldupdate) para mais detalhes.
     */
    brShouldUpdate: EventEmitter<void>;
    componentShouldUpdate(newValue: any, oldValue: any, stateName: any): void;
    /**
     * listener para ouvir o evento de click no componente step
     * Através desse listener o componente define qual será o proximo passo do step que terá o estado ativo
     */
    handleClick(event: any): void;
    private getStepItemsElements;
    private setStepItemsLabelPosition;
    private setStepItemsDefaultContent;
    private setStepItemsContentType;
    private setStepItemsMode;
    private getStepItemPosition;
    private configureTimeLine;
    private configureLinearProgression;
    /**
     *
     * Método disponibilizado via API do elemento que controla o componente Step, responsável por avançar para o próximo passo e atualizar o valor do estado activeStep
     */
    ProceedToNextStep(): Promise<void>;
    /**
     *
     * Método disponibilizado via API do elemento que controla o componente Step, responsável por retornar ao passo anterior e atualizar o valor do estado activeStep
     */
    BackToPreviousStep(): Promise<void>;
    /**
     *
     * Método disponibilizado via API do elemento que integra um componente externo ao componente Step, permitindo sinalizar validações ou destacar a etapa com estado ativo.
     */
    StepValidation(validationStatus: 'success' | 'info' | 'danger' | 'warning'): Promise<void>;
    /**
     *
     * Método disponibilizado via API do elemento que permite a um componente externo obter a etapa com o estado ativo do componente Step.
     */
    GetActiveStep(): Promise<number>;
    private getCssClassMap;
    private AriaObjectContent;
    private getAreaLabel;
    render(): any;
}