Leave Yamada UI a star

Star
Yamada UIYamada UIv1.6.4

Stepper

Stepper is a component that displays the progress of a multi-step process.

Source@yamada-ui/stepper

Props

StepProps

StepDescriptionProps

StepSeparatorProps

StepIconProps

size

Deprecated

Description

The CSS font-size property.

Deprecated

Use fontSize instead.

Type

UIValue<number | "-moz-initial" | "inherit" | "initial" | "revert" | "revert-layer" | "unset" | "large" | "medium" | "small" | "x-large" | "x-small" | "xx-large" | "xx-small" | "xxx-large" | ... 17 more ... | "xs">

StepNumberProps

StepStatusProps

active

Type

string | number | boolean | ((props: Omit<StepContext, "status">) => ReactNode) | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<...> | ReactPortal

complete

Type

string | number | boolean | ((props: Omit<StepContext, "status">) => ReactNode) | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<...> | ReactPortal

incomplete

Type

string | number | boolean | ((props: Omit<StepContext, "status">) => ReactNode) | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<...> | ReactPortal

StepTitleProps

StepperProps

index

Required

Description

The active step index.

Type

number

colorScheme

Description

The visual color appearance of the component.

Type

"blackAlpha" | "whiteAlpha" | "amber" | "blue" | "info" | "link" | "primary" | "cyan" | "emerald" | "flashy" | "fuchsia" | "gray" | "green" | "success" | "indigo" | "lime" | "neutral" | "orange" | "warning" | "pink" | "purple" | "red" | "danger" | "rose" | "sky" | "teal" | "violet" | "secondary" | "yellow"

Default

"primary"

orientation

Description

The orientation of the stepper.

Type

"horizontal" | "vertical"

Default

'horizontal'

showLastSeparator

Description

Whether to show or not the last separator while in vertical orientation.

Type

boolean

Default

false

size

Description

The size of the Stepper.

Type

"sm" | "md" | "lg"

Default

"md"

steps

Description

If provided, generate step components based on steps.

Type

Steps

variant

Description

The variant of the Stepper.

Type

string

UseStepsProps

count

Type

number

index

Type

number

Edit this page on GitHub

PreviousPaginationNextDisclosure