@kelvininc/ui-components/dist/types/components/step-bar/step-bar.types.d.ts

Kelvin UI Components

import { EventEmitter } from '../../stencil-public-runtime';
import { IStepIndicator } from '../step-indicator/step-indicator.types';
export interface IStepBarStep extends IStepIndicator {
    /** (required) A unique identifier for the step */
    stepKey: number | string;
}
export interface IStepBar {
    /** (optional) Defines the label to display next to the step counter (defaults to: "Progress: ") */
    label?: string;
    /** (required) Defines the steps array to render */
    steps: IStepBarStep[];
    /** (required) Defines the current step index */
    currentStep: number;
    /** (required) Defines the percentage of steps completed */
    progressPercentage: number;
    /** (optional) Defines if the progress bar should be in an error state */
    hasError: boolean;
}
export interface IStepBarEvents {
    /** Fires when a step is clicked and emits the index */
    stepClicked: EventEmitter<number>;
}