@atlaskit/progress-tracker/dist/types/progress-tracker.d.ts

A progress tracker displays the steps and progress through a journey.

import type { ProgressTrackerStageRenderProp, Spacing, Stages } from './types';
export interface ProgressTrackerProps {
    /**
     * Ordered list of stage data.
     */
    items: Stages;
    /**
     * Sets the amount of spacing between the steps.
     */
    spacing?: Spacing;
    /**
     * @deprecated
     *
     * Render prop to specify custom implementations of components.
     *
     * Note this is deprecated and will be removed in a future version.
     * Links inside progress tracker can be configured using [App Provider](https://atlassian.design/components/app-provider) instead.
     */
    render?: ProgressTrackerStageRenderProp;
    /**
     * Turns off transition animations if set to false.
     */
    animated?: boolean;
    /**
     * A `testId` prop is provided for specified elements, which is a unique string that appears as a data attribute `data-testid` in the rendered code, serving as a hook for automated tests.
     */
    testId?: string;
    /**
     * Use this to provide an aria-label for the overall progress tracker, so that people who use assistive technology get an overview of the tracker's purpose. For example, "Sign up progress".
     */
    label?: string;
}
/**
 * __Progress tracker__
 *
 * A progress tracker displays the steps and progress through a journey.
 *
 * - [Examples](https://atlassian.design/components/progress-tracker/examples)
 * - [Code](https://atlassian.design/components/progress-tracker/code)
 * - [Usage](https://atlassian.design/components/progress-tracker/usage)
 */
declare const ProgressTracker: ({ items, spacing, render, animated, testId, label, }: ProgressTrackerProps) => JSX.Element;
export default ProgressTracker;