Struct patternfly_yew::components::search_input::SearchInputProperties

pub struct SearchInputProperties {

    pub id: Option<AttrValue>,
    pub aria_label: AttrValue,
    pub class: Classes,
    pub expandable: Option<SearchInputExpandableProperties>,
    pub hint: Option<AttrValue>,
    pub inner_ref: Option<NodeRef>,
    pub disabled: bool,
    pub placeholder: Option<AttrValue>,
    pub reset_button_label: AttrValue,
    pub submit_search_button_label: AttrValue,
    pub utilities_displayed: bool,
    pub value: String,
    pub autofocus: bool,
    pub results_count: Option<ResultsCount>,
    pub previous_navigation_button_aria_label: AttrValue,
    pub previous_navigation_button_disabled: bool,
    pub next_navigation_button_aria_label: AttrValue,
    pub next_navigation_button_disabled: bool,
    pub onchange: Option<Callback<String>>,
    pub onclear: Option<Callback<MouseEvent>>,
    pub onnextclick: Option<Callback<MouseEvent>>,
    pub onpreviousclick: Option<Callback<MouseEvent>>,
    pub onsearch: Option<Callback<(OnSearchEvent, String)>>,
}

The main search input component.

Fields

id: Option<AttrValue>

Id of the outermost element

aria_label: AttrValue

An accessible label for the search input.

class: Classes

Additional classes added to the search input.

expandable: Option<SearchInputExpandableProperties>

Object that makes the search input expandable/collapsable.

hint: Option<AttrValue>

A suggestion for autocompleting

inner_ref: Option<NodeRef>

A reference object to attach to the input box.

disabled: bool

Flag indicating if searchinput is disabled.

placeholder: Option<AttrValue>

Placeholder text of the search input.

reset_button_label: AttrValue

Label for the button which resets the advanced search form and clears the search input.

submit_search_button_label: AttrValue

Label for the button which calls the onSearch event handler.

utilities_displayed: bool

Flag to indicate utilities should be displayed. By default, utilities will only be displayed when the search input has a value.

value: String

Value of the search input.

autofocus: bool

results_count: Option<ResultsCount>

The number of search results returned. View [ResultsCount].

previous_navigation_button_aria_label: AttrValue

Accessible label for the button to navigate to previous result.

previous_navigation_button_disabled: bool

Flag indicating if the previous navigation button is disabled.

next_navigation_button_aria_label: AttrValue

Accessible label for the button to navigate to next result.

next_navigation_button_disabled: bool

Flag indicating if the next navigation button is disabled.

onchange: Option<Callback<String>>

A callback for when the input value changes.

onclear: Option<Callback<MouseEvent>>

A callback for when the user clicks the clear button.

onnextclick: Option<Callback<MouseEvent>>

A callback for when the user clicks to navigate to next result.

onpreviousclick: Option<Callback<MouseEvent>>

A callback for when the user clicks to navigate to previous result.

onsearch: Option<Callback<(OnSearchEvent, String)>>

A callback for when the search button is clicked.

Trait Implementations

impl Clone for SearchInputProperties

fn clone(&self) -> SearchInputProperties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchInputProperties

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

Formats the value using the given formatter.

impl PartialEq for SearchInputProperties

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

type Builder = SearchInputPropertiesBuilder

Builder that will be used to construct properties

fn builder() -> Self::Builder

Entrypoint for building properties

impl StructuralPartialEq for SearchInputProperties