Interface WizardSubStep

Type used to define sub-steps.

interface WizardSubStep {
    component?: ReactElement<any, string | JSXElementConstructor<any>>;
    footer?: ReactElement<any, string | JSXElementConstructor<any>> | Partial<WizardFooterProps>;
    id: string | number;
    index: number;
    isDisabled?: boolean;
    isHidden?: boolean;
    isVisited?: boolean;
    name: ReactNode;
    navItem?: WizardNavItemType;
    parentId: string | number;
    status?: "default" | "error";
}

Hierarchy (view full)

Properties

component? footer? id index isDisabled? isHidden? isVisited? name navItem? parentId status?

Properties

Optionalcomponent

component?: ReactElement<any, string | JSXElementConstructor<any>>

Content shown when the step's navigation item is selected. When treated as a parent step, only sub-step content will be shown.

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

index

index: number

Order index of step (starts at 1)

OptionalisDisabled

isDisabled?: boolean

Flag to disable the step's navigation item

OptionalisHidden

isHidden?: boolean

Flag to determine whether the step is hidden

OptionalisVisited

isVisited?: boolean

Flag to represent whether the step has been visited (navigated to)

name

name: ReactNode

Name of the step's navigation item

OptionalnavItem

navItem?: WizardNavItemType

Replaces the step's navigation item or its properties.

parentId

parentId: string | number

Unique identifier of the parent step

Optionalstatus

status?: "default" | "error"

Used to determine icon next to the step's navItem

Settings

Member Visibility

On This Page

Properties