Interface WizardOptions<WizardFormState>

interface WizardOptions<WizardFormState> {
    pages: {
        component: ComponentType<WizardPageProps<WizardFormState>>;
        estimatedSubPageCount?: number;
        ignoreInProgress?: boolean;
        key: string;
    }[];
    screenMode: "desktop" | "mobile";
    wizardCancelRoute?: string;
    wizardCompleteRoute: string;
}

Type Parameters

  • WizardFormState

Properties

pages screenMode wizardCancelRoute? wizardCompleteRoute

Properties

pages

pages: {
    component: ComponentType<WizardPageProps<WizardFormState>>;
    estimatedSubPageCount?: number;
    ignoreInProgress?: boolean;
    key: string;
}[]

List of pages to show in the wizard

Type declaration

  • component: ComponentType<WizardPageProps<WizardFormState>>

    Component to render for this subpage

  • Optional estimatedSubPageCount?: number

    Number of sub pages inside this page to count in the overall progress. Allows for the initial count to be more accurate if a page has multiple sub pages (if not provided, will default to 1)

  • Optional ignoreInProgress?: boolean

    If true, this page is not included in the overall progress count

  • key: string

    URL key for this sub page

screenMode

screenMode: "desktop" | "mobile"

Screen size for this block

Optional wizardCancelRoute

wizardCancelRoute?: string

Route to redirect to if the wizard is canceled on the first page

wizardCompleteRoute

wizardCompleteRoute: string

Route to redirect to if the wizard is complete.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc