Skip to main content

Form

Struct Form 

Source
pub struct Form;
Expand description

A dynamic form component with multiple field types.

Form composes text inputs, checkboxes, and select fields into a single navigable component. It manages internal focus between fields and collects values on submission.

  • Tab — Focus next field
  • BackTab (Shift+Tab) — Focus previous field
  • Ctrl+Enter — Submit the form

§Field-specific keys

  • Text fields: Normal typing, Backspace, Delete, Home/End, Left/Right
  • Checkbox: Space or Enter to toggle
  • Select: Enter to open, Up/Down to navigate, Enter to confirm

§Example

use envision::component::{
    Component, Focusable, Form, FormState, FormMessage,
    FormOutput, FormField, FormValue,
};

let mut state = FormState::new(vec![
    FormField::text("username", "Username"),
    FormField::checkbox("remember", "Remember me"),
    FormField::select("role", "Role", vec!["User", "Admin"]),
]);
Form::set_focused(&mut state, true);

// Type username
Form::update(&mut state, FormMessage::Input('A'));
assert_eq!(state.value("username"), Some(FormValue::Text("A".into())));

// Submit the form
let output = Form::update(&mut state, FormMessage::Submit);
assert!(matches!(output, Some(FormOutput::Submitted(_))));

Trait Implementations§

Source§

impl Component for Form

Source§

type State = FormState

The component’s internal state type. Read more
Source§

type Message = FormMessage

Messages this component can receive. Read more
Source§

type Output = FormOutput

Messages this component can emit to its parent. Read more
Source§

fn init() -> Self::State

Initialize the component state. Read more
Source§

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

Maps an input event to a component message. Read more
Source§

fn update(state: &mut Self::State, msg: Self::Message) -> Option<Self::Output>

Update component state based on a message. Read more
Source§

fn view(state: &Self::State, frame: &mut Frame<'_>, area: Rect, theme: &Theme)

Render the component to the given area. Read more
Source§

fn traced_view( state: &Self::State, frame: &mut Frame<'_>, area: Rect, theme: &Theme, )

Renders the component with optional tracing instrumentation. Read more
Source§

fn dispatch_event( state: &mut Self::State, event: &Event, ) -> Option<Self::Output>

Dispatches an event by mapping it to a message and updating state. Read more
Source§

impl Focusable for Form

Source§

fn is_focused(state: &Self::State) -> bool

Returns true if this component is currently focused.
Source§

fn set_focused(state: &mut Self::State, focused: bool)

Sets the focus state of this component.
Source§

fn focus(state: &mut Self::State)

Gives focus to this component. Read more
Source§

fn blur(state: &mut Self::State)

Removes focus from this component. Read more

Auto Trait Implementations§

§

impl Freeze for Form

§

impl RefUnwindSafe for Form

§

impl Send for Form

§

impl Sync for Form

§

impl Unpin for Form

§

impl UnsafeUnpin for Form

§

impl UnwindSafe for Form

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> StateExt for T

Source§

fn updated(self, cmd: Command<impl Clone>) -> UpdateResult<Self, impl Clone>

Updates self and returns a command.
Source§

fn unchanged(self) -> UpdateResult<Self, ()>

Returns self with no command.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.