@nimbus-ds/components 5.11.2 → 5.12.0

package/dist/index.d.ts

@@ -3401,6 +3401,92 @@ export interface SidebarProperties extends SidebarSprinkle {
 }
 export type SidebarProps = SidebarProperties & HTMLAttributes<HTMLDivElement>;
 export declare const Sidebar: React.FC<SidebarProps> & SidebarComponents;
+/**
+ * Represents the visual state of a step
+ */
+export type StepState = "completed" | "started" | "pending";
+export interface StepperItemProperties {
+	/**
+	 * The step number (0-based index) for this item.
+	 * This is automatically assigned by the parent Stepper component.
+	 */
+	step: number;
+	/**
+	 * The label text to display for this step
+	 */
+	label?: string;
+}
+export type StepperItemProps = StepperItemProperties & HTMLAttributes<HTMLDivElement>;
+export interface StepperCardProperties {
+	/**
+	 * The content to be rendered inside the card container
+	 * @TJS-type React.ReactNode
+	 */
+	children: ReactNode;
+}
+export type StepperCardProps = StepperCardProperties;
+export interface StepperComponents {
+	Item: React.FC<Omit<StepperItemProps, "step">>;
+	Card: React.FC<StepperCardProps>;
+}
+export interface BaseStepperProperties {
+	/**
+	 * The currently active step (0-based index).
+	 * Steps before this will be marked as completed.
+	 */
+	activeStep: number;
+	/**
+	 * The content of the stepper (StepperItem components).
+	 * Total steps will be calculated automatically based on the number of children.
+	 * @TJS-type React.ReactNode
+	 */
+	children: ReactNode;
+}
+export interface ControlledStepperProperties extends BaseStepperProperties {
+	/**
+	 * The currently selected step (0-based index).
+	 * This step will be visually highlighted to show user selection.
+	 */
+	selectedStep: number;
+	/**
+	 * Callback called when a step is selected.
+	 * Receives the step number (0-based index) as parameter.
+	 */
+	onSelectStep: (step: number) => void;
+}
+/**
+ * Props for the Stepper component, supporting both controlled and uncontrolled modes
+ */
+export type StepperProps = (BaseStepperProperties | ControlledStepperProperties) & Omit<BoxProps, "display" | "flexWrap" | "gap">;
+export type StepperProperties = BaseStepperProperties & ControlledStepperProperties;
+export declare const Stepper: React.FC<StepperProps> & StepperComponents;
+/**
+ * Context value provided by StepperContext to share state between stepper components
+ */
+export interface StepperContextValue {
+	/**
+	 * The total number of steps in the stepper
+	 */
+	totalSteps: number;
+	/**
+	 * The currently active step (0-based index)
+	 */
+	activeStep: number;
+	/**
+	 * The currently selected step (0-based index)
+	 */
+	selectedStep?: number;
+	/**
+	 * Callback to handle step selection
+	 */
+	onSelect?: (step: number) => void;
+}
+/**
+ * Checks if the stepper is in controlled mode.
+ * @param props - The props of the stepper
+ * @returns True if the stepper is controlled, false otherwise
+ */
+export declare const isControlled: (props: any) => props is ControlledStepperProperties;
 export interface TabsButtonProperties {
 	/**
 	 * Label of the tab button.