Interface IWizardModalProps<Data, Payload>

Interface for props of the WizardModal component.

interface IWizardModalProps<
    Data extends {} = Record<string, any>,
    Payload = IAnything,
> {
    AfterTitle?: any;
    BeforeTitle?: any;
    data?: null | Data;
    fallback?: (e: Error) => void;
    fetchState?:
        | TupleState<object, any, any, any, any, any, any, any, any, any, any>
        | ObjectState<object, any>;
    fullScreen?: boolean;
    hidden?: boolean;
    mapInitialData?: (data: Record<string, any>[]) => Data | Promise<Data>;
    mapPayload?: (data: Record<string, any>[]) => Payload | Promise<Payload>;
    onClose?: () => void;
    onLoadEnd?: (isOk: boolean) => void;
    onLoadStart?: () => void;
    onMount?: () => void;
    onSubmit?: (
        data: null | Data,
        payload: Payload,
    ) => boolean | Promise<boolean>;
    onUnmount?: () => void;
    openSubject: TBehaviorSubject<boolean>;
    reloadSubject?: TSubject<void>;
    routes: IWizardModal<Data, Payload>[];
    sizeRequest?: (size: ISize) => { height: number; sx?: any; width: number };
    submitIcon?: any;
    submitLabel?: string;
    throwError?: boolean;
    title?: string;
    withActionButton?: boolean;
    withStaticAction?: boolean;
    [key: string]: BoxProps;
    [key: number]: BoxProps;
    [key: symbol]: BoxProps;
}

Type Parameters

  • Data extends {} = Record<string, any>

    The type of data passed to the wizard.

  • Payload = IAnything

    The type of payload passed to the wizard.

Hierarchy

  • Omit<
        IWizardViewProps<Data, Payload>,
        keyof {
            data: never;
            id: never;
            initialData: never;
            onSubmit: never;
            otherProps: never;
            outlinePaper: never;
            params: never;
            payload: never;
            routes: never;
            transparentPaper: never;
        },
    >
    • IWizardModalProps

Indexable

  • [key: string]: BoxProps
  • [key: number]: BoxProps
  • [key: symbol]: BoxProps

Properties

AfterTitle? BeforeTitle? data? fallback? fetchState? fullScreen? hidden? mapInitialData? mapPayload? onClose? onLoadEnd? onLoadStart? onMount? onSubmit? onUnmount? openSubject reloadSubject? routes sizeRequest? submitIcon? submitLabel? throwError? title? withActionButton? withStaticAction?

Properties

OptionalAfterTitle

AfterTitle?: any

OptionalBeforeTitle

BeforeTitle?: any

Optionaldata

data?: null | Data

Optionalfallback

fallback?: (e: Error) => void

OptionalfetchState

fetchState?:
    | TupleState<object, any, any, any, any, any, any, any, any, any, any>
    | ObjectState<object, any>

OptionalfullScreen

fullScreen?: boolean

Optionalhidden

hidden?: boolean

OptionalmapInitialData

mapInitialData?: (data: Record<string, any>[]) => Data | Promise<Data>

OptionalmapPayload

mapPayload?: (data: Record<string, any>[]) => Payload | Promise<Payload>

OptionalonClose

onClose?: () => void

OptionalonLoadEnd

onLoadEnd?: (isOk: boolean) => void

OptionalonLoadStart

onLoadStart?: () => void

OptionalonMount

onMount?: () => void

OptionalonSubmit

onSubmit?: (data: null | Data, payload: Payload) => boolean | Promise<boolean>

OptionalonUnmount

onUnmount?: () => void

openSubject

openSubject: TBehaviorSubject<boolean>

OptionalreloadSubject

reloadSubject?: TSubject<void>

routes

routes: IWizardModal<Data, Payload>[]

OptionalsizeRequest

sizeRequest?: (size: ISize) => { height: number; sx?: any; width: number }

OptionalsubmitIcon

submitIcon?: any

OptionalsubmitLabel

submitLabel?: string

OptionalthrowError

throwError?: boolean

Optionaltitle

title?: string

OptionalwithActionButton

withActionButton?: boolean

OptionalwithStaticAction

withStaticAction?: boolean

Settings

Member Visibility

On This Page

Properties