Struct HelperProps 

pub struct HelperProps {
    pub children: Children,
    pub class: &'static str,
    pub style: &'static str,
    pub id: &'static str,
    pub disabled: bool,
    pub error: bool,
    pub valid: bool,
    pub filled: bool,
    pub focused: bool,
    pub margin: Margin,
    pub data_testid: &'static str,
}

Available on crate feature lep only.

Props for the Helper component.

Renders accessible helper text beneath a form field.

When nested inside Control, it inherits error and disabled from ControlContext. Error text uses role="alert" for immediate screen-reader announcement.

Examples

use form_rs::leptos::Helper;
use leptos::prelude::*;

#[component]
pub fn PasswordHint() -> impl IntoView {
    view! {
        <Helper id="pw-hint">"Must be at least 8 characters."</Helper>
    }
}

Required Props

• children: Children
  • Helper text content.

Optional Props

• class: [&'static str]
  • Additional CSS class names on the <p>.
• style: [&'static str]
  • Inline CSS on the <p>.
• id: [&'static str]
  • id attribute, use as aria-describedby on the input.
• disabled: bool
  • When true, renders in disabled style.
• error: bool
  • When true, renders in error color with role="alert".
• valid: bool
  • When true, renders in success color.
• filled: bool
  • When true, applies the filled modifier.
• focused: bool
  • When true, applies the focused modifier.
• margin: Margin
  • Vertical spacing adjustment.
• data_testid: [&'static str]
  • data-testid for automated testing.

Fields

children: Children

Helper text content.

class: &'static str

Additional CSS class names on the <p>.

style: &'static str

Inline CSS on the <p>.

id: &'static str

id attribute, use as aria-describedby on the input.

disabled: bool

When true, renders in disabled style.

error: bool

When true, renders in error color with role="alert".

valid: bool

When true, renders in success color.

filled: bool

When true, applies the filled modifier.

focused: bool

When true, applies the focused modifier.

margin: Margin

Vertical spacing adjustment.

data_testid: &'static str

data-testid for automated testing.

Implementations

impl HelperProps

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

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

Trait Implementations

impl Props for HelperProps

type Builder = HelperPropsBuilder

fn builder() -> Self::Builder