Struct Form 

pub struct Form {
    pub message: String,
    pub fields: Vec<FormField>,
    /* private fields */
}

Form supports two interaction modes based on field count:

• Single-step mode (0 or 1 fields)
• Multi-step mode (2+ fields)

In both modes, each FormField renders through its backing widget and all values can be serialized with to_json().

Modes

Single-step mode (0 or 1 fields)

The form renders only the active prompt content and footer hints.

• No tab bar
• No review/submit pane
• Enter submits immediately

This mode is ideal for yes/no confirmations and other one-question prompts.

Multi-step mode (2+ fields)

A tab bar is shown with all fields plus a virtual Submit tab.

• Navigate with Tab / BackTab or arrows (for non-text fields)
• Enter advances to the next tab while editing fields
• Enter on the Submit tab emits submit

The Submit tab shows a review summary of all field values.

Messages

Form implements Component with Message = FormMessage:

• FormMessage::Close — Emitted on Esc.
• FormMessage::Submit — Emitted on Enter:
  • immediately in single-step mode
  • only from the Submit tab in multi-step mode

FormField

A single field within the form:

• name — Machine-readable key (used in JSON output).
• label — Human-readable label shown in UI.
• description — Optional help text shown below the field.
• required — If true, an asterisk is shown next to the label.
• kind — The backing widget, as a FormFieldKind.

FormFieldKind

• Text(TextField) — Single-line text input.
• Number(NumberField) — Numeric input.
• Boolean(Checkbox) — Toggle rendered as [x] / [ ].
• SingleSelect(RadioSelect) — Radio button list.
• MultiSelect(MultiSelect) — Checkbox list.

See also

• TextField
• Checkbox
• RadioSelect
• MultiSelect
• FocusRing

Fields

message: String

fields: Vec<FormField>

Implementations

impl Form

pub fn new(message: String, fields: Vec<FormField>) -> Self

pub fn to_json(&self) -> Value

Trait Implementations

impl Component for Form

type Message = FormMessage

The message type emitted by this widget.

async fn on_event(&mut self, event: &Event) -> Option<Vec<Self::Message>>

Process an event and return the outcome.

fn render(&mut self, context: &ViewContext) -> Frame

Render the current state to a frame.