Struct patternfly_yew::components::helper_text::HelperText

pub struct HelperText { /* private fields */ }

HelperText component

HelperText is an on-screen field guideline that helps provide context regarding field inputs.

See: https://www.patternfly.org/components/helper-text

Properties

Defined by HelperTextProperties.

Children

This component may contain one or more HelperTextItem components.

Example

use yew::prelude::*;
use patternfly_yew::prelude::*;

#[function_component(Example)]
fn example() -> Html {
    html!(
        <HelperText>
            <HelperTextItem>{"This is default helper text"}</HelperTextItem>
        </HelperText>
    )
}

Trait Implementations

impl BaseComponent for HelperText

where Self: 'static,

type Message = ()

The Component’s Message.

type Properties = HelperTextProperties

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 HelperText

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

Formats the value using the given formatter.

impl FunctionProvider for HelperText

type Properties = HelperTextProperties

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.