@amsterdam/design-system-react/dist/src/ProgressList/ProgressList.d.ts

All React components from the Amsterdam Design System. Use it to compose pages in your website or application.

/**
 * @license EUPL-1.2+
 * Copyright Gemeente Amsterdam
 */
import type { HTMLAttributes, PropsWithChildren } from 'react';
export declare const progressListHeadingLevels: (2 | 3 | 4)[];
type ProgressListHeadingLevel = (typeof progressListHeadingLevels)[number];
export type ProgressListProps = {
    /**
     * Whether the steps can be expanded and collapsed.
     * @default false
     */
    collapsible?: boolean;
    /**
     * An accessible phrase that screen readers announce before a completed step heading.
     * @default Klaar
     */
    completedAccessibleText?: string;
    /**
     * An accessible phrase that screen readers announce before a current step heading.
     * @default Bezig
     */
    currentAccessibleText?: string;
    /**
     * The hierarchical level of this Progress List’s Headings within the document.
     * There is no default value; determine the correct level for this instance.
     */
    headingLevel: ProgressListHeadingLevel;
} & PropsWithChildren<HTMLAttributes<HTMLOListElement>>;
/**
 * @see {@link https://designsystem.amsterdam/?path=/docs/components-containers-progress-list--docs Progress List docs at Amsterdam Design System}
 */
export declare const ProgressList: import("react").ForwardRefExoticComponent<{
    /**
     * Whether the steps can be expanded and collapsed.
     * @default false
     */
    collapsible?: boolean;
    /**
     * An accessible phrase that screen readers announce before a completed step heading.
     * @default Klaar
     */
    completedAccessibleText?: string;
    /**
     * An accessible phrase that screen readers announce before a current step heading.
     * @default Bezig
     */
    currentAccessibleText?: string;
    /**
     * The hierarchical level of this Progress List’s Headings within the document.
     * There is no default value; determine the correct level for this instance.
     */
    headingLevel: ProgressListHeadingLevel;
} & HTMLAttributes<HTMLOListElement> & {
    children?: import("react").ReactNode | undefined;
} & import("react").RefAttributes<HTMLOListElement>> & {
    Step: import("react").ForwardRefExoticComponent<{
        defaultCollapsed?: boolean;
        hasSubsteps?: boolean;
        heading: string;
        onToggle?: (expanded: boolean) => void;
        status?: "current" | "completed";
    } & HTMLAttributes<HTMLElement> & {
        children?: import("react").ReactNode | undefined;
    } & import("react").RefAttributes<HTMLLIElement>>;
    Substep: import("react").ForwardRefExoticComponent<{
        status?: import("./ProgressListStep").ProgressListStepProps["status"];
    } & HTMLAttributes<HTMLElement> & {
        children?: import("react").ReactNode | undefined;
    } & import("react").RefAttributes<HTMLLIElement>>;
    Substeps: import("react").ForwardRefExoticComponent<HTMLAttributes<HTMLOListElement> & {
        children?: import("react").ReactNode | undefined;
    } & import("react").RefAttributes<HTMLOListElement>>;
};
export {};