Struct FormProps 

pub struct FormProps {

    pub children: Children,
    pub class: &'static str,
    pub style: &'static str,
    pub id: &'static str,
    pub action: &'static str,
    pub method: Method,
    pub enc_type: EncType,
    pub target: Target,
    pub novalidate: bool,
    pub autocomplete: &'static str,
    pub name: &'static str,
    pub validation_behavior: ValidationBehavior,
    pub on_submit: Option<Callback<SubmitEvent>>,
    pub on_reset: Option<Callback<Event>>,
    pub aria_label: &'static str,
    pub aria_labelledby: &'static str,
    pub data_testid: &'static str,
}

Available on crate feature lep only.

Props for the Form component.

A semantic <form> wrapper that provides validation context to descendant fields.

Propagates FormContext via Leptos context so that Control, FormLabel, and Helper can read validation mode and submission state without prop drilling.

Accessibility

• Renders as a native <form> element (implicit "form" ARIA role).
• Supply aria_label or aria_labelledby to create a named form landmark.

Examples

use form_rs::leptos::{Form, Control, FormLabel};
use leptos::prelude::*;
use leptos::ev::SubmitEvent;

#[component]
pub fn LoginForm() -> impl IntoView {
    view! {
        <Form aria_label="Login" on_submit=Callback::new(|e: SubmitEvent| e.prevent_default())>
            <Control input_id="email">
                <FormLabel html_for="email">"Email"</FormLabel>
            </Control>
        </Form>
    }
}

Required Props

• children: Children
  • Form content: fields, buttons, and other interactive controls.

Optional Props

• class: [&'static str]
  • Additional CSS class names on the <form> element.
• style: [&'static str]
  • Inline CSS on the <form> element.
• id: [&'static str]
  • id attribute on the <form> element.
• action: [&'static str]
  • URL that processes the form submission.
• method: Method
  • HTTP method for form submission.
• enc_type: EncType
  • MIME encoding type for submitted data.
• target: Target
  • Where to display the form response.
• novalidate: bool
  • When true, disables native browser validation.
• autocomplete: [&'static str]
  • Browser autocomplete hint.
• name: [&'static str]
  • Name of the form.
• validation_behavior: ValidationBehavior
  • Controls whether validation is native or ARIA-based.
• on_submit: Callback<SubmitEvent>
  • Handler called when the form is submitted.
• on_reset: Callback<Event>
  • Handler called when the form is reset.
• aria_label: [&'static str]
  • Accessible label for screen readers.
• aria_labelledby: [&'static str]
  • ID of element that labels this form.
• data_testid: [&'static str]
  • data-testid for automated testing.

Fields

children: Children

Form content: fields, buttons, and other interactive controls.

class: &'static str

Additional CSS class names on the <form> element.

style: &'static str

Inline CSS on the <form> element.

id: &'static str

id attribute on the <form> element.

action: &'static str

URL that processes the form submission.

method: Method

HTTP method for form submission.

enc_type: EncType

MIME encoding type for submitted data.

target: Target

Where to display the form response.

novalidate: bool

When true, disables native browser validation.

autocomplete: &'static str

Browser autocomplete hint.

name: &'static str

Name of the form.

validation_behavior: ValidationBehavior

Controls whether validation is native or ARIA-based.

on_submit: Option<Callback<SubmitEvent>>

Handler called when the form is submitted.

on_reset: Option<Callback<Event>>

Handler called when the form is reset.

aria_label: &'static str

Accessible label for screen readers.

aria_labelledby: &'static str

ID of element that labels this form.

data_testid: &'static str

data-testid for automated testing.

Implementations

impl FormProps

pub fn builder() -> FormPropsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), ())>

Create a builder for building FormProps. On the builder, call .children(...), .class(...)(optional), .style(...)(optional), .id(...)(optional), .action(...)(optional), .method(...)(optional), .enc_type(...)(optional), .target(...)(optional), .novalidate(...)(optional), .autocomplete(...)(optional), .name(...)(optional), .validation_behavior(...)(optional), .on_submit(...)(optional), .on_reset(...)(optional), .aria_label(...)(optional), .aria_labelledby(...)(optional), .data_testid(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of FormProps.

Trait Implementations

impl Props for FormProps

type Builder = FormPropsBuilder

fn builder() -> Self::Builder