Struct Form 

pub struct Form { /* private fields */ }

A form with multiple groups of fields.

Implementations

impl Form

pub fn new() -> Self

Create a new empty form.

pub fn title(self, title: impl Into<String>) -> Self

Set the form title.

pub fn description(self, desc: impl Into<String>) -> Self

Set the form description.

pub fn group(self, group: Group) -> Self

Add a group to the form.

pub fn accessible(self, accessible: bool) -> Self

Enable accessible mode.

pub fn layout(self, layout: FormLayout) -> Self

Set the form layout.

• FormLayout::Default - Show one group at a time (default)
• FormLayout::Stack - Show all groups stacked vertically
• FormLayout::Columns(n) - Show groups in n columns

pub fn get_layout(&self) -> FormLayout

Get the current layout.

pub fn is_submitted(&self) -> bool

Check if the form is submitted.

pub fn is_cancelled(&self) -> bool

Check if the form is cancelled.

pub fn results(&self) -> FormResults

Get the form results.

pub fn current_group(&self) -> Option<&Group>

Get the current group.

pub fn current_group_mut(&mut self) -> Option<&mut Group>

Get the current group mutably.

pub fn init_form(&mut self)

Initialize the form.

impl Form

pub fn run_accessible(&mut self) -> Result<Option<FormResults>>

Run the form in accessible mode.

This method handles the complete accessible flow, prompting for each field and advancing through groups automatically.

Returns the form results on success, or None if cancelled.

Trait Implementations

impl Accessible for Form

type Message = FormMsg

The message type for accessible input.

fn accessible_prompt(&self) -> String

Render the accessible prompt.

fn parse_accessible_input(&self, input: &str) -> Option<Self::Message>

Parse accessible input and return a message.

fn is_accessible_complete(&self) -> bool

Check if the component is complete (submitted or cancelled).

impl Clone for Form

fn clone(&self) -> Form

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Form

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Form

fn default() -> Self

Returns the “default value” for a type.

impl Model for Form

type Message = FormMsg

The message type for this model.

fn init(&self) -> Option<Cmd<Self::Message>>

Initialize the model, returning an optional startup command.

fn update(&mut self, msg: Self::Message) -> Option<Cmd<Self::Message>>

Handle a message and update the model state.

fn view(&self) -> String

Render the model as a string for display.

fn handle_event(&self, event: Event) -> Option<Self::Message>

Convert terminal events to messages.

fn subscriptions(&self) -> Sub<Self::Message>

Declare subscriptions for recurring events.

fn wants_tick(&self) -> bool

Whether this model should receive tick updates.