Name | Type | Default | Description |
---|---|---|---|
id required | string | A unique identifier that will be used to identify the modal in the PlasmaState. Among other things this is the identifer that will be used to open the wizard. | |
cancelButtonLabel | string | "Cancel" | The label of the cancel button |
children | ReactNode | ||
classes | IClassName | ||
closeCallback | () => void | ||
closeTimeout | number | ||
contentClasses | IClassName | Additionnal CSS class to add to the modal container | |
contentRef | (el: HTMLDivElement) => void | ||
docLink | ILinkSvgProps | Props of the link to documentation | |
finishButtonLabel | string | "Finish" | The label of the finish button |
htmlId | string | id for the html element | |
isDirty | boolean | Whether the wizard should warn about unsaved changes when the user unexpectedly closes the modal | |
isPrompt | boolean | false | Wheter this backdrop is for a prompt or not |
modalBodyClasses | IClassName | Additionnal CSS class to add to the body | |
modalFooterChildren | ReactNode | DependsOnStep<ReactNode> | Determines what needs to be rendered in the modal footer. The content of the footer can be dependent on the current step by using a render function | |
modalFooterClasses | IClassName | Additionnal CSS class to add to the footer | |
modalHeaderChildren | ReactNode | React child to add to the header | |
modalHeaderClasses | IClassName | Additionnal CSS class to add to the header | |
nextButtonLabel | string | "Next" | The label of the next button |
onCancel | () => unknown | A callback function that is executed when the user clicks on the cancel button | |
onFinish | (close: () => void) => unknown | A function that is executed when user completes all the steps.
| |
onNext | () => unknown | A callback function that is executed when the user clicks on the next button | |
onPrevious | () => unknown | A callback function that is executed when the user clicks on the previous button | |
openOnMount | boolean | Renders the Modal already opened. | |
previousButtonLabel | string | "Previous" | The label of the previous button |
title | string | DependsOnStep<string> | The title of the modal. The title can be dependent on the current step if needed, to do so pass in a function that accepts the same params as the validateStep prop. | |
validateStep | DependsOnStep<{ isValid: boolean; message?: string; }> | () => ({isValid: true}) | A function that determines whether the current step is valid or not
|
displayFor deprecated | string[] | Do not use |
No guidelines exist for ModalWizard yet.