UNPKG

@front10/landing-page-book

Version:
1 lines 3.77 kB
{"description":"","displayName":"Wizard","methods":[{"name":"onStepChange","docblock":null,"modifiers":[],"params":[{"name":"step","type":null}],"returns":null}],"props":{"className":{"type":{"name":"string"},"required":false,"description":"Class name of header.","defaultValue":{"value":"''","computed":false}},"showHeader":{"type":{"name":"bool"},"required":false,"description":"Show or hide the header with steps.","defaultValue":{"value":"true","computed":false}},"showHeaderBorder":{"type":{"name":"bool"},"required":false,"description":"Show or hide the header bottom border.","defaultValue":{"value":"true","computed":false}},"showNavigation":{"type":{"name":"bool"},"required":false,"description":"Hide or show Next and Previous Buttons at the bottom.","defaultValue":{"value":"true","computed":false}},"prevBtnOnLastStep":{"type":{"name":"bool"},"required":false,"description":"Show or hide the previous button in the last step (maybe the last step is a thank you message and you don't want them to go back).","defaultValue":{"value":"true","computed":false}},"dontValidate":{"type":{"name":"bool"},"required":false,"description":"Dev control to disable validation rules called in step components.","defaultValue":{"value":"true","computed":false}},"preventEnterSubmission":{"type":{"name":"bool"},"required":false,"description":"By default if you hit the Enter key on any element it validates the form and moves to next step if validation passes. Use this to prevent this behaviour.","defaultValue":{"value":"true","computed":false}},"startAtStep":{"type":{"name":"number"},"required":false,"description":"Specify what step to start from in the case you need to skip steps (send in a 0 based index for the item in the steps array. e.g. 2 will load <Step3 /> initially).","defaultValue":{"value":"0","computed":false}},"nextButtonText":{"type":{"name":"string"},"required":false,"description":"Specify the next button text.","defaultValue":{"value":"'Next'","computed":false}},"backButtonText":{"type":{"name":"string"},"required":false,"description":"Specify the back button text.","defaultValue":{"value":"'Back'","computed":false}},"nextButtonCls":{"type":{"name":"string"},"required":false,"description":"Specify the next button class.","defaultValue":{"value":"'btn btn-primary pull-right'","computed":false}},"backButtonCls":{"type":{"name":"string"},"required":false,"description":"Specify the back button class.","defaultValue":{"value":"'btn btn-primary pull-left'","computed":false}},"nextTextOnFinalActionStep":{"type":{"name":"string"},"required":false,"description":"Specify what the next button text should be in the step before the last.","defaultValue":{"value":"'Next'","computed":false}},"contentAlign":{"type":{"name":"string"},"required":false,"description":"Specify the align of wizard components. Can be <code>'left'</code>, <code>'right'</code> and <code>'center'</code>","defaultValue":{"value":"'left'","computed":false}},"hocValidationAppliedTo":{"type":{"name":"arrayOf","value":{"name":"number"}},"required":false,"description":"Its recommended that you use basic javascript validation.","defaultValue":{"value":"[]","computed":false}},"steps":{"type":{"name":"arrayOf","value":{"name":"shape","value":{"name":{"name":"string","required":true},"component":{"name":"element","required":true}}}},"required":true,"description":"List of steps."},"onStepChange":{"type":{"name":"func"},"required":false,"description":"Called when 'Back' or 'Next' button is clicked.","defaultValue":{"value":"() => {}","computed":false}},"style":{"type":{"name":"objectOf","value":{"name":"any"}},"required":false,"description":"Css style applied to the component","defaultValue":{"value":"null","computed":false}}},"filename":"/components/Wizard/Wizard.jsx"}