Questionnaire

1.0.0

A multi-step questionnaire with single-choice, multiple-choice, freeform, and skippable questions.

Component data

ID
questionnaire
Category
atoms
Version
1.0.0
Added
2026-09-17
Type
component
Keyboard nav
Yes
Reduced motion
Yes
questionnaireformsurveymulti-stepchoicesatom

Dependencies

  • lucide-react
  • clsx
  • tailwind-merge

Registry

  • button

Examples

Default

<Questionnaire
      className="mx-auto w-[min(100%,28rem)]"
      defaultItem="direction"
      items={questionnaireMocks.defaultItems}
      onSubmit={(event) => event.preventDefault()}
      shortcuts="letters"
    >
      <QuestionnaireProgress />
      {questionnaireMocks.defaultItems.map((question) => (
        <QuestionnaireItem
          key={question.name}
          multiple={"multiple" in question && question.multiple}
          name={question.name}
          required={question.required}
        >
          <QuestionnaireTitle>{question.title}</QuestionnaireTitle>
          <QuestionnaireDescription>
            {question.description}
          </QuestionnaireDescription>
          <QuestionnaireChoices>
            {question.choices.map((choice) => (
              <QuestionnaireChoice key={choice.value} value={choice.value}>
                <span className="font-medium">{choice.label}</span>
                {"description" in choice ? (
                  <span
                    className="text-muted-foreground"
                    data-slot="questionnaire-choice-description"
                  >
                    {choice.description}
                  </span>
                ) : null}
              </QuestionnaireChoice>
            ))}
            {"input" in question ? (
              <QuestionnaireInput
                aria-label={question.input.label}
                placeholder={question.input.placeholder}
              />
            ) : null}
          </QuestionnaireChoices>
          <QuestionnaireError />
        </QuestionnaireItem>
      ))}
      <QuestionnaireActions>
        <QuestionnairePrevious />
        <QuestionnaireSkip />
        <QuestionnaireNext>Next</QuestionnaireNext>
        <QuestionnaireSubmit>Save plan</QuestionnaireSubmit>
      </QuestionnaireActions>
    </Questionnaire>

WithSkip

<Questionnaire
      className="mx-auto w-[min(100%,28rem)]"
      defaultItem="kind"
      items={questionnaireMocks.skipItems}
      onSubmit={(event) => event.preventDefault()}
    >
      <QuestionnaireProgress />
      {questionnaireMocks.skipItems.map((question) => (
        <QuestionnaireItem
          key={question.name}
          name={question.name}
          required={question.required}
        >
          <QuestionnaireTitle>{question.title}</QuestionnaireTitle>
          <QuestionnaireDescription>
            {question.description}
          </QuestionnaireDescription>
          <QuestionnaireChoices>
            {question.choices.map((choice) => (
              <QuestionnaireChoice key={choice.value} value={choice.value}>
                <span className="font-medium">{choice.label}</span>
              </QuestionnaireChoice>
            ))}
          </QuestionnaireChoices>
          <QuestionnaireError />
        </QuestionnaireItem>
      ))}
      <QuestionnaireActions>
        <QuestionnairePrevious />
        <QuestionnaireSkip />
        <QuestionnaireNext />
        <QuestionnaireSubmit />
      </QuestionnaireActions>
    </Questionnaire>

Related