Interface WizardStepProps

The primary child component for Wizard. Step props are used for the list of steps managed in context.

interface WizardStepProps {
    body?: Omit<Omit<WizardBodyProps, "children">, "children">;
    children?: ReactNode;
    footer?: ReactElement<any, string | JSXElementConstructor<any>> | Partial<WizardFooterProps>;
    id: string | number;
    isDisabled?: boolean;
    isExpandable?: boolean;
    isHidden?: boolean;
    name: ReactNode;
    navItem?: WizardNavItemType;
    status?: "default" | "error";
    steps?: ReactElement<WizardStepProps, string | JSXElementConstructor<any>>[];
}

Properties

body? children? footer? id isDisabled? isExpandable? isHidden? name navItem? status? steps?

Properties

Optionalbody

body?: Omit<Omit<WizardBodyProps, "children">, "children">

Props for WizardBody that wraps content by default. Can be set to null for exclusion of WizardBody.

Optionalchildren

children?: ReactNode

Optional for when the step is used as a parent to sub-steps

Optionalfooter

footer?: ReactElement<any, string | JSXElementConstructor<any>> | Partial<WizardFooterProps>

Replaces the step's footer. The step's footer takes precedance over the wizard's footer.

id

id: string | number

Unique identifier

OptionalisDisabled

isDisabled?: boolean

Flag to disable the step's navigation item

OptionalisExpandable

isExpandable?: boolean

Flag to determine whether parent steps can expand or not. Defaults to false.

OptionalisHidden

isHidden?: boolean

Flag to determine whether the step is hidden

name

name: ReactNode

Name of the step's navigation item

OptionalnavItem

navItem?: WizardNavItemType

Replaces the step's navigation item or its properties.

Optionalstatus

status?: "default" | "error"

Used to determine icon next to the step's navigation item

Optionalsteps

steps?: ReactElement<WizardStepProps, string | JSXElementConstructor<any>>[]

Optional list of sub-steps

Settings

Member Visibility

On This Page

Properties