Struct Helper 

pub struct Helper { /* private fields */ }

Available on crate feature yew only.

Renders accessible helper text beneath a form field.

When nested inside Control, it inherits error, disabled, focused, and filled states from ControlContext. Error text is announced to screen readers via role="alert".

Accessibility

• role="alert" is added automatically when error is true.
• Assign its id to the input’s aria-describedby attribute.

Examples

use form_rs::yew::Helper;
use yew::prelude::*;

#[function_component(PasswordHint)]
pub fn password_hint() -> Html {
    html! {
        <Helper id="pw-hint">
            {"Must be at least 8 characters."}
        </Helper>
    }
}

Trait Implementations

impl BaseComponent for Helper

where Self: 'static,

type Message = ()

The Component’s Message.

type Properties = HelperProps

The Component’s Properties.

fn create(ctx: &Context<Self>) -> Self

Creates a component.

fn update(&mut self, _ctx: &Context<Self>, _msg: Self::Message) -> bool

Updates component’s internal state.

fn changed( &mut self, _ctx: &Context<Self>, _old_props: &Self::Properties, ) -> bool

React to changes of component properties.

fn view(&self, ctx: &Context<Self>) -> HtmlResult

Returns a component layout to be rendered.

fn rendered(&mut self, _ctx: &Context<Self>, _first_render: bool)

Notified after a layout is rendered.

fn destroy(&mut self, _ctx: &Context<Self>)

Notified before a component is destroyed.

fn prepare_state(&self) -> Option<String>

Prepares the server-side state.

impl Debug for Helper

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FunctionProvider for Helper

type Properties = HelperProps

Properties for the Function Component.

fn run(ctx: &mut HookContext, props: &Self::Properties) -> HtmlResult

Render the component. This function returns the Html to be rendered for the component.