Struct patternfly_yew::components::helper_text::HelperTextProperties

pub struct HelperTextProperties {
    pub aria_label: Option<AttrValue>,
    pub children: ChildrenWithProps<HelperTextItem>,
    pub class: Classes,
    pub component: HelperTextComponent,
    pub id: Option<AttrValue>,
    pub live_region: bool,
    pub hidden: bool,
}

Fields

aria_label: Option<AttrValue>

Adds an accessible label to the helper text when component is HelperTextComponent::Ul.

children: ChildrenWithProps<HelperTextItem>

Content to be rendered inside the HelperText container. This must be a HelperTextItem component.

class: Classes

Additional classes to be applied to the HelperText container.

component: HelperTextComponent

Specify the html element of the HelperText container. Defaults to using a div.

id: Option<AttrValue>

id for the helper text container. The value of this prop can be passed into a form component’s aria-describedby property when you intend for all helper text items to be announced to assistive technologies.

live_region: bool

Flag for indicating whether the helper text container is a live region. Use this prop when you expect or intend for any HelperTextItem within the container to be dynamically updated.

hidden: bool

Hides the HelperText

Trait Implementations

impl Clone for HelperTextProperties

fn clone(&self) -> HelperTextProperties

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HelperTextProperties

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

Formats the value using the given formatter.

impl PartialEq for HelperTextProperties

fn eq(&self, other: &HelperTextProperties) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Properties for HelperTextProperties

type Builder = HelperTextPropertiesBuilder

Builder that will be used to construct properties

fn builder() -> Self::Builder

Entrypoint for building properties

impl StructuralPartialEq for HelperTextProperties