Questionnaire
Multi-step form and survey flow with progress tracking.
Generated from the package's public source.
API
Navigationcomponent
Navigation(props: QuestionnaireNavigationProps): Element
Props
class?string
children: Element
NextButtoncomponent
NextButton(props: QuestionnaireNextButtonProps): Element
Props
class?stringvalidate?() => boolean— Optional validation function. Return true to allow advance.
children: Element
PrevButtoncomponent
PrevButton(props: QuestionnairePrevButtonProps): Element
Props
class?string
children: Element
Progresscomponent
Progress(props: QuestionnaireProgressProps): Element
Props
class?string
children: Element
QuestionnaireNavigationPropsinterface
Props
class?string
children: Element
QuestionnaireNextButtonPropsinterface
Props
class?stringvalidate?() => boolean— Optional validation function. Return true to allow advance.
children: Element
QuestionnairePrevButtonPropsinterface
Props
class?string
children: Element
QuestionnaireProgressPropsinterface
Props
class?string
children: Element
QuestionnaireRootPropsinterface
Props
class?stringcurrentStep?Accessor<number>— Controlled current step (0-indexed).defaultStep?number— Default starting step (0-indexed).onComplete?(data: Record<string, unknown>) => void— Called when the questionnaire is submitted on the last step.onStepChange?(step: number) => void— Called when step changes.stepsnumber— Total number of steps.
children: Element
QuestionnaireStepContentPropsinterface
Props
class?string
children: Element
QuestionnaireStepPropsinterface
Props
indexnumber— The step index this content belongs to (0-indexed).
children: Element
QuestionnaireStepTitlePropsinterface
Props
class?string
children: Element
QuestionnaireSubmitPropsinterface
Props
class?string
children: Element
Rootcomponent
Root(props: QuestionnaireRootProps): Element
Props
class?stringcurrentStep?Accessor<number>— Controlled current step (0-indexed).defaultStep?number— Default starting step (0-indexed).onComplete?(data: Record<string, unknown>) => void— Called when the questionnaire is submitted on the last step.onStepChange?(step: number) => void— Called when step changes.stepsnumber— Total number of steps.
children: Element
Stepcomponent
Step(props: QuestionnaireStepProps): Element
Props
indexnumber— The step index this content belongs to (0-indexed).
children: Element
StepContentcomponent
StepContent(props: QuestionnaireStepContentProps): Element
Props
class?string
children: Element
StepTitlecomponent
StepTitle(props: QuestionnaireStepTitleProps): Element
Props
class?string
children: Element
Submitcomponent
Submit(props: QuestionnaireSubmitProps): Element
Props
class?string
children: Element