ReferenceComponentsNavigation
StepperProps
StepperProps component contract.
Type
export interface StepperProps
extends CommonComponentProps,
SlottedComponentProps<NavigationListSlots> {
readonly steps: readonly StepperItem[];
readonly current?: string;
readonly orientation?: "horizontal" | "vertical";
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
steps | readonly StepperItem[] | Yes | The steps member uses the readonly StepperItem[] contract. | — |
current | string | undefined | No | The current member uses the string | undefined contract. | — |
orientation | "horizontal" | "vertical" | undefined | No | The orientation member uses the "horizontal" | "vertical" | undefined contract. | — |
variant | string | undefined | No | The variant member uses the string | undefined contract. | — |
size | "sm" | "md" | "lg" | undefined | No | The size member uses the "sm" | "md" | "lg" | undefined contract. | — |
unstyled | boolean | undefined | No | The unstyled member uses the boolean | undefined contract. | — |
className | string | undefined | No | The className member uses the string | undefined contract. | — |
layout | Partial<Omit<LayoutNodeInput, "children" | "id" | "semantics">> | undefined | No | The layout member uses the Partial<Omit<LayoutNodeInput, "children" | "id" | "semantics">> | undefined contract. | — |
id | string | undefined | No | The id member uses the string | undefined contract. | — |
testId | string | undefined | No | The testId member uses the string | undefined contract. | — |
role | SemanticRole | undefined | No | The role member uses the SemanticRole | undefined contract. | SemanticRole |
label | string | undefined | No | The label member uses the string | undefined contract. | — |
description | string | undefined | No | The description member uses the string | undefined contract. | — |
disabled | boolean | undefined | No | The disabled member uses the boolean | undefined contract. | — |
readOnly | boolean | undefined | No | The readOnly member uses the boolean | undefined contract. | — |
selected | boolean | undefined | No | The selected member uses the boolean | undefined contract. | — |
checked | boolean | undefined | No | The checked member uses the boolean | undefined contract. | — |
expanded | boolean | undefined | No | The expanded member uses the boolean | undefined contract. | — |
valueText | string | undefined | No | The valueText member uses the string | undefined contract. | — |
slots | Partial<SlotComponents<{ root: import("ink").BoxProps; list: import("ink").BoxProps; item: import("ink").TextProps; }>> | undefined | No | The slots member uses the Partial<SlotComponents<{ root: import("ink").BoxProps; list: import("ink").BoxProps; item: import("ink").TextProps; }>> | undefined contract. | BoxProps, SlotComponents, TextProps |
slotProps | Partial<SlotProps<{ root: import("ink").BoxProps; list: import("ink").BoxProps; item: import("ink").TextProps; }, object>> | undefined | No | The slotProps member uses the Partial<SlotProps<{ root: import("ink").BoxProps; list: import("ink").BoxProps; item: import("ink").TextProps; }, object>> | undefined contract. | BoxProps, SlotProps, TextProps |