Skip to main content
Version: 0.25.0

Interface: SelectStep<T>

Defined in: tui/ink/wizard.tsx:29

A choice among choices; the answer is the chosen value.

Extends​

  • BaseStep

Type Parameters​

Type ParameterDefault type
Tunknown

Properties​

PropertyTypeDescriptionInherited fromDefined in
choicesFromAnswers<object[]>--tui/ink/wizard.tsx:31
default?FromAnswers<T>Preselects the choice with this value.-tui/ink/wizard.tsx:33
messageFromAnswers<string>-BaseStep.messagetui/ink/wizard.tsx:23
namestringKey of this step's answer in the result.BaseStep.nametui/ink/wizard.tsx:22
type"select"--tui/ink/wizard.tsx:30
when?(answers) => booleanSkips the step (leaving no answer) when it returns false.BaseStep.whentui/ink/wizard.tsx:25