Struct Form 

pub struct Form { /* private fields */ }

HeroUI Form: a vertical field stack that collects a named submission.

Implementations

impl Form

pub fn new() -> Self

Creates an empty form.

pub fn validation_errors(self, errors: ValidationErrors) -> Self

validationErrors — HeroUI v3’s ValidationErrors record: server-side errors mapped by field name (Record<string, string | string[]>).

The form routes the record; the fields display it. Each entry lands in the named field’s own state and error slot — there is no form-level message stack. Delivery is receipted per field: each field’s own state stores the record’s ValidationErrors::revision beside its routed messages, so re-rendering with a clone keeps the per-field state (an edit stays suppressed, and reordering or replacing the registrations re-arms nothing), while any freshly built record re-arms every named field it mentions, content-equal or not. Names no registered field displays neither block nor render.

Identity is the caller’s to preserve: keep one record for as long as the response is current and pass a Clone of it each frame; building a fresh record per frame — ValidationErrors::new() inline, or a re-run builder chain — is a new server response every frame and re-arms every named field it mentions, even with identical content. This is React Stately’s reference identity, unchanged.

pub fn validation_behavior(self, behavior: ValidationBehavior) -> Self

validationBehavior — whether a failed field blocks submission.

pub fn field(self, field: FormField) -> Self

Registers a named field, so its value appears in the submission.

pub fn on_submit( self, f: impl Fn(&FormData, &mut Window, &mut App) + 'static, ) -> Self

onSubmit — receives the collected submission.

pub fn on_reset(self, f: impl Fn(&mut Window, &mut App) + 'static) -> Self

onReset — fires after the registered fields are restored.

pub fn on_invalid( self, f: impl Fn(&FormData, &mut Window, &mut App) + 'static, ) -> Self

onInvalid — runs instead of onSubmit when validation blocks it.

Blocked means a required field with no value, or a field whose own resolved validity is in error (validate, isInvalid, the field’s validationErrors, an HTML5 attribute violation, or a server message routed to it by the form’s validationErrors record) — and only under ValidationBehavior::Native; Allow submits regardless, as v3’s does. Disabled and read-only fields never block.

pub fn data(&self, cx: &App) -> FormData

Collects the registered fields into a submission.

pub fn submit_handler(&self) -> Arc<dyn Fn(&mut Window, &mut App) + 'static>

The handler a submit button calls: collects the submission, then routes it to onSubmit or onInvalid.

gpui gives a child no way to reach its form, so the caller wires this to the button in place of <button type="submit">. The form root’s Enter key handler runs the same implementation, so a submission is decided identically however it arrived.

pub fn reset_handler(&self) -> Arc<dyn Fn(&mut Window, &mut App) + 'static>

The handler a reset button calls: restores every field that declared a default, hides the routed server errors, then fires onReset.

Hiding is a clear, not a rewind: each field keeps its delivery receipt (see SetServerErrors), so a re-render passing a clone keeps the messages hidden, and only a genuinely new record re-arms.

Trait Implementations

impl Default for Form

fn default() -> Self

Returns the “default value” for a type.

impl IntoElement for Form

type Element = ViewElement<Form>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl ParentElement for Form

fn extend(&mut self, elements: impl IntoIterator<Item = AnyElement>)

Extend this element’s children with the given child elements.

fn child(self, child: impl IntoElement) -> Self

where Self: Sized,

Add a single child element to this element.

fn children(self, children: impl IntoIterator<Item = impl IntoElement>) -> Self

where Self: Sized,

Add multiple child elements to this element.

impl RenderOnce for Form

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.