Struct Form 

pub struct Form { /* private fields */ }

A form containing multiple groups of fields.

Implementations

impl Form

pub fn new(groups: Vec<Group>) -> Self

Creates a new form with the given groups.

pub fn width(self, width: usize) -> Self

Sets the form width.

pub fn theme(self, theme: Theme) -> Self

Sets the theme.

pub fn keymap(self, keymap: KeyMap) -> Self

Sets the keymap.

pub fn layout<L: Layout + 'static>(self, layout: L) -> Self

Sets the layout for the form.

Example

use huh::{Form, Group, LayoutColumns};

let form = Form::new(vec![group1, group2, group3])
    .layout(LayoutColumns::new(2));

pub fn show_help(self, show: bool) -> Self

Sets whether to show help at the bottom of the form.

pub fn show_errors(self, show: bool) -> Self

Sets whether to show validation errors.

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

Enables or disables accessible mode.

When accessible mode is enabled, the form renders in a more screen-reader-friendly format with simpler styling and clearer field labels. This mode prioritizes accessibility over visual aesthetics.

Example

use huh::Form;

let form = Form::new(groups)
    .with_accessible(true);

pub fn is_accessible(&self) -> bool

Returns whether accessible mode is enabled.

pub fn state(&self) -> FormState

Returns the form state.

pub fn current_group(&self) -> usize

Returns the current group index.

pub fn len(&self) -> usize

Returns the number of groups.

pub fn is_empty(&self) -> bool

Returns whether the form has no groups.

pub fn get_value(&self, key: &str) -> Option<Box<dyn Any>>

Returns the value of a field by key.

pub fn get_string(&self, key: &str) -> Option<String>

Returns the string value of a field by key.

pub fn get_bool(&self, key: &str) -> Option<bool>

Returns the boolean value of a field by key.

pub fn all_errors(&self) -> Vec<String>

Collects all validation errors from all groups.

pub fn group_width(&self, group_index: usize) -> usize

Returns the width allocated to a specific group based on the current layout.

Trait Implementations

impl Default for Form

fn default() -> Self

Returns the “default value” for a type.

impl Model for Form

fn init(&self) -> Option<Cmd>

Initialize the model and return an optional startup command.

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

Process a message and return a new command.

fn view(&self) -> String

Render the model as a string for display.