@spark-ui/progress-tracker
Version:
A progress tracker component is a visual navigation element typically used to display progress or guide user through a multi-step process.
28 lines (27 loc) • 1.02 kB
TypeScript
import { type ComponentPropsWithRef, type PropsWithChildren } from 'react';
import type { StepIndicatorVariantProps } from './ProgressTrackerStepIndicator.styles';
export interface ProgressTrackerProps extends ComponentPropsWithRef<'div'>, Pick<StepIndicatorVariantProps, 'size' | 'intent' | 'design'> {
/**
* The orientation of the progress tracker
* @default 'horizontal"
*/
orientation?: 'horizontal' | 'vertical';
/**
* The index of the current step.
* @default 0
*/
stepIndex?: number;
/**
* Event handler called when clicking on a step.
*/
onStepClick?: (stepIndex: number) => void;
/**
* Sets the component as interactive or not.
* @default false
*/
readOnly?: boolean;
}
export declare const ProgressTracker: {
({ stepIndex, onStepClick, readOnly, intent, size, design, orientation, children, className, ref, ...rest }: PropsWithChildren<ProgressTrackerProps>): import("react").JSX.Element;
displayName: string;
};