diff --git a/types/FormWizard.ts b/types/FormWizard.ts index cba14d0..a392cb6 100644 --- a/types/FormWizard.ts +++ b/types/FormWizard.ts @@ -3,31 +3,116 @@ export type LayoutType = 'vertical' | 'horizontal' export type StepSizeType = 'xs' | 'sm' | 'md' | 'lg' export declare class Wizard { - /** Wizard title */ + /** + * Wizard identifier. + * + * Default value: 'fw_' + */ + id: string + + /** + * Wizard title. + * + * Default value: 'Awesome Wizard' + */ title: string - /** Wizard subtitle */ + + /** + * Wizard subtitle. + * + * Default value: 'Split a complicated flow in multiple steps' + */ subtitle: string + + /** + * Text to display on next button. + * + * Default value: 'Next' + */ nextButtonText: string + + /** + * Text to display on back button. + * + * Default value: 'Back' + */ backButtonText: string + + /** + * Text to display on finish button. + * + * Default value: 'Finish' + */ finishButtonText: string - /** Whether to hide footer buttons */ + + /** + * Whether or not buttons should be hidden. + * + * Default value: false + */ hideButtons: boolean - /** Whether to trigger beforeChange function when navigating back */ + + /** + * Whether or not to trigger `beforeChange` function when navigating back. + * + * Default value: false + */ validateOnBack: boolean - /** Active step and button color */ + + /** + * Color to apply to text, border and circle. + * + * Default value: '#e74c3c' + */ color: string - /** Step color when the current step is not valid */ + + /** + * Step color when the current step is not valid. + * + * Default value: '#8b0000' + */ errorColor: string - /** Main step shape */ + + /** + * Shape of steps. + * + * Default value: 'circle' + */ shape: ShapeType - /** Wizard layout */ + + /** + * Layout of wizard. + * + * Default value: 'horizontal' + */ layout: LayoutType - /** Additional css classes for steps */ + + /** + * Additional CSS classes to apply to steps. + * + * Default value: '' + */ stepsClasses: string[] - /** Step size */ + + /** + * Size of steps. + * + * Default value: 'md' + */ stepSize: StepSizeType - /** Step transition from inactive to active */ + + + /** + * Name of the transition when transitioning between steps. + * + * Default value: '' + */ transition: string - /** Tab index where the wizard should start */ + + /** + * Zero-based index of the initial tab to be displayed. + * + * Default value: 0 + */ startIndex: number }