Mixins / foldkit-mixins-ui

QuestionnaireView

interface · packages/mixins-ui/src/questionnaire.ts:417

interface QuestionnaireView<Message> {
  readonly model: Model
  readonly onMessage: (message: typeof Message.Type) => NoInfer<Message>
  readonly title?: string | undefined
  readonly submitLabel?: string | undefined
  readonly nextLabel?: string | undefined
  readonly backLabel?: string | undefined
  readonly missingText?: string | undefined
  readonly skippedText?: string | undefined
  readonly progressText?: ((page: number, total: number) => string) | undefined
  readonly style?: NamedStyle<typeof QuestionnaireSlots> | undefined
  readonly mixins?: MixinList<Message> | undefined
  readonly radioGroup?: NamedStyle<typeof RadioGroupSlots> | undefined
  readonly checkboxGroup?: NamedStyle<typeof CheckboxGroupSlots> | undefined
  readonly input?: NamedStyle<typeof InputSlots> | undefined
  readonly textarea?: NamedStyle<typeof TextareaSlots> | undefined
  readonly button?: NamedStyle<typeof ButtonSlots> | undefined
  readonly submitButton?: NamedStyle<typeof ButtonSlots> | undefined
}

Members

QuestionnaireView.model

property · packages/mixins-ui/src/questionnaire.ts:418

readonly model: Model

QuestionnaireView.onMessage

property · packages/mixins-ui/src/questionnaire.ts:420

readonly onMessage: (message: typeof Message.Type) => NoInfer<Message>

Lifts the questionnaire's own Messages into the application's.

QuestionnaireView.title

property · packages/mixins-ui/src/questionnaire.ts:422

readonly title?: string | undefined

A heading over the questions, which names the form.

QuestionnaireView.submitLabel

property · packages/mixins-ui/src/questionnaire.ts:424

readonly submitLabel?: string | undefined

Default Submit.

QuestionnaireView.nextLabel

property · packages/mixins-ui/src/questionnaire.ts:426

readonly nextLabel?: string | undefined

Default Next.

QuestionnaireView.backLabel

property · packages/mixins-ui/src/questionnaire.ts:428

readonly backLabel?: string | undefined

Default Back.

QuestionnaireView.missingText

property · packages/mixins-ui/src/questionnaire.ts:430

readonly missingText?: string | undefined

Said beside a question a submit found unanswered; default Answer this question.

QuestionnaireView.skippedText

property · packages/mixins-ui/src/questionnaire.ts:432

readonly skippedText?: string | undefined

Said in the summary for an optional question left blank; default Skipped.

QuestionnaireView.progressText

property · packages/mixins-ui/src/questionnaire.ts:434

readonly progressText?: ((page: number, total: number) => string) | undefined

One at a time, where the reader is; default Question 2 of 3.

QuestionnaireView.style

property · packages/mixins-ui/src/questionnaire.ts:436

readonly style?: NamedStyle<typeof QuestionnaireSlots> | undefined

A style of QuestionnaireSlots, for the questionnaire's own parts.

QuestionnaireView.mixins

property · packages/mixins-ui/src/questionnaire.ts:438

readonly mixins?: MixinList<Message> | undefined

Mixins beside the style.

QuestionnaireView.radioGroup

property · packages/mixins-ui/src/questionnaire.ts:440

readonly radioGroup?: NamedStyle<typeof RadioGroupSlots> | undefined

The single choices' look.

QuestionnaireView.checkboxGroup

property · packages/mixins-ui/src/questionnaire.ts:442

readonly checkboxGroup?: NamedStyle<typeof CheckboxGroupSlots> | undefined

The multiple choices' look.

QuestionnaireView.input

property · packages/mixins-ui/src/questionnaire.ts:444

readonly input?: NamedStyle<typeof InputSlots> | undefined

The one-line answers' and the other fields' look.

QuestionnaireView.textarea

property · packages/mixins-ui/src/questionnaire.ts:446

readonly textarea?: NamedStyle<typeof TextareaSlots> | undefined

The multi-line answers' look.

QuestionnaireView.button

property · packages/mixins-ui/src/questionnaire.ts:448

readonly button?: NamedStyle<typeof ButtonSlots> | undefined

Back's look.

QuestionnaireView.submitButton

property · packages/mixins-ui/src/questionnaire.ts:450

readonly submitButton?: NamedStyle<typeof ButtonSlots> | undefined

Next's and Submit's look.