Struct FormLabelProps 

pub struct FormLabelProps {
    pub children: Children,
    pub class: &'static str,
    pub style: &'static str,
    pub id: &'static str,
    pub html_for: &'static str,
    pub color: Option<Color>,
    pub disabled: bool,
    pub error: bool,
    pub filled: bool,
    pub focused: bool,
    pub required: bool,
    pub data_testid: &'static str,
}

Available on crate feature lep only.

Props for the FormLabel component.

Renders an accessible <label> linked to a form field.

When nested inside Control, it automatically reads error, disabled, focused, required, and color from ControlContext.

Examples

use form_rs::leptos::FormLabel;
use leptos::prelude::*;

#[component]
pub fn MyLabel() -> impl IntoView {
    view! { <FormLabel html_for="username">"Username"</FormLabel> }
}

Required Props

• children: Children
  • Label text or content.

Optional Props

• class: [&'static str]
  • Additional CSS class names on the <label>.
• style: [&'static str]
  • Inline CSS on the <label>.
• id: [&'static str]
  • id attribute on the <label>.
• html_for: [&'static str]
  • The id of the labeled <input>.
• color: Color
  • Color theme override.
• disabled: bool
  • When true, renders in disabled style.
• error: bool
  • When true, renders in error color.
• filled: bool
  • When true, applies the filled modifier.
• focused: bool
  • When true, applies the focused modifier.
• required: bool
  • When true, shows a required asterisk.
• data_testid: [&'static str]
  • data-testid for automated testing.

Fields

children: Children

Label text or content.

class: &'static str

Additional CSS class names on the <label>.

style: &'static str

Inline CSS on the <label>.

id: &'static str

id attribute on the <label>.

html_for: &'static str

The id of the labeled <input>.

color: Option<Color>

Color theme override.

disabled: bool

When true, renders in disabled style.

error: bool

When true, renders in error color.

filled: bool

When true, applies the filled modifier.

focused: bool

When true, applies the focused modifier.

required: bool

When true, shows a required asterisk.

data_testid: &'static str

data-testid for automated testing.

Implementations

impl FormLabelProps

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

Create a builder for building FormLabelProps. On the builder, call .children(...), .class(...)(optional), .style(...)(optional), .id(...)(optional), .html_for(...)(optional), .color(...)(optional), .disabled(...)(optional), .error(...)(optional), .filled(...)(optional), .focused(...)(optional), .required(...)(optional), .data_testid(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of FormLabelProps.

Trait Implementations

impl Props for FormLabelProps

type Builder = FormLabelPropsBuilder

fn builder() -> Self::Builder