Struct patternfly_yew::components::helper_text::HelperTextItemProperties

pub struct HelperTextItemProperties {
    pub children: Html,
    pub class: Classes,
    pub component: HelperTextItemComponent,
    pub dynamic: bool,
    pub icon: HelperTextItemIcon,
    pub id: Option<AttrValue>,
    pub screen_reader_text: AttrValue,
    pub variant: HelperTextItemVariant,
}

Fields

children: Html

Content to be rendered inside the HelperTextItem.

class: Classes

Additional classes to be applied to the HelperTextItem.

component: HelperTextItemComponent

Set the type of html element to use. When HelperTextItem is used as a child of HelperText this property is set automatically.

dynamic: bool

Flag to modifies a HelperTextItem to be dynamic. For use when the item changes state as the form field the text is associated with is updated.

icon: HelperTextItemIcon

Controls the icon prefixing the helper text. The default is to show an icon when the dynamic property is true

id: Option<AttrValue>

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

screen_reader_text: AttrValue

Text that is only accessible to screen readers in order to announce the status of the HelperTextItem. This property is only used when the dynamic is true.

variant: HelperTextItemVariant

Variant styling of the helper text item

Trait Implementations

impl Clone for HelperTextItemProperties

fn clone(&self) -> HelperTextItemProperties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HelperTextItemProperties

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

Formats the value using the given formatter.

impl PartialEq for HelperTextItemProperties

fn eq(&self, other: &HelperTextItemProperties) -> 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 HelperTextItemProperties

type Builder = HelperTextItemPropertiesBuilder

Builder that will be used to construct properties

fn builder() -> Self::Builder

Entrypoint for building properties

impl StructuralPartialEq for HelperTextItemProperties