@payfit/unity-components
Version:
39 lines (38 loc) • 1.31 kB
TypeScript
import { ReactNode } from 'react';
export type TimelineStepProps = {
/**
* State of the timeline step
* @default 'pending'
*/
state?: 'completed' | 'current' | 'pending';
/**
* Step number for numbered timelines
*/
stepNumber?: number;
/**
* Additional CSS classes
*/
className?: string;
/**
* Optional status slot to display next to the title (vertical orientation or horizontal mobile)
* or at the bottom of the content (horizontal desktop)
* Typically a Badge component, but can be any ReactNode
*/
statusSlot?: ReactNode;
/**
* Optional action slot for links or actions
* Displayed after the description and statusSlot
* Typically a Link component, but can be any ReactNode
*/
actionSlot?: ReactNode;
/**
* Step content (typically TimelineStepHeader, TimelineStepDescription, etc.)
*/
children?: ReactNode;
};
/**
* TimelineStep represents a single step in the timeline
* Automatically renders the TimelineMarker with the correct state and stepNumber
* Announces the step status to screen readers using i18n translations
*/
export declare const TimelineStep: import('react').ForwardRefExoticComponent<TimelineStepProps & import('react').RefAttributes<HTMLLIElement>>;