SelectProps

Struct SelectProps 

Source
pub struct SelectProps {
Show 33 fields pub value: Option<String>, pub values: Option<Vec<String>>, pub options: Vec<SelectOption>, pub mode: SelectMode, pub multiple: bool, pub allow_clear: bool, pub placeholder: Option<String>, pub disabled: bool, pub show_search: bool, pub filter_option: Option<Rc<dyn Fn(&str, &SelectOption) -> bool>>, pub token_separators: Option<Vec<String>>, pub status: Option<ControlStatus>, pub size: Option<ComponentSize>, pub variant: Option<Variant>, pub bordered: Option<bool>, pub prefix: Option<Element>, pub suffix_icon: Option<Element>, pub placement: SelectPlacement, pub popup_match_select_width: bool, pub class: Option<String>, pub root_class_name: Option<String>, pub style: Option<String>, pub class_names: Option<SelectClassNames>, pub styles: Option<SelectStyles>, pub dropdown_class: Option<String>, pub dropdown_style: Option<String>, pub dropdown_class_name: Option<String>, pub dropdown_style_deprecated: Option<String>, pub dropdown_match_select_width: Option<bool>, pub popup_render: Option<Rc<dyn Fn(Element) -> Element>>, pub on_change: Option<EventHandler<Vec<String>>>, pub on_dropdown_visible_change: Option<EventHandler<bool>>, pub on_open_change: Option<EventHandler<bool>>,
}
Expand description

Props for the Select component.

Fields§

§value: Option<String>

Controlled value for single-select mode.

§values: Option<Vec<String>>

Controlled values for multi-select mode.

§options: Vec<SelectOption>

Option list rendered in the dropdown.

§mode: SelectMode

Selection mode: single, multiple, or tags.

§multiple: bool

@deprecated Use mode instead. When true, allow selecting multiple options.

§allow_clear: bool

Whether to show a clear icon when there is a selection.

§placeholder: Option<String>

Placeholder text displayed when there is no selection.

§disabled: bool

Disable user interaction.

§show_search: bool

Enable simple client-side search by option label.

§filter_option: Option<Rc<dyn Fn(&str, &SelectOption) -> bool>>

Custom filter function: (input, option) -> bool When provided, overrides the default label-based filtering.

§token_separators: Option<Vec<String>>

Token separators for tags mode (e.g., [“,”, “ “]). When user types these characters, a new tag is created.

§status: Option<ControlStatus>

Optional visual status applied to the wrapper.

§size: Option<ComponentSize>

Override component size; falls back to ConfigProvider when None.

§variant: Option<Variant>

Visual variant (outlined/filled/borderless).

§bordered: Option<bool>

@deprecated Use variant="borderless" instead.

§prefix: Option<Element>

Prefix element displayed before the selection.

§suffix_icon: Option<Element>

Custom suffix icon (defaults to down arrow).

§placement: SelectPlacement

Dropdown placement relative to the select.

§popup_match_select_width: bool

Whether dropdown width should match select width.

§class: Option<String>§root_class_name: Option<String>

Extra class applied to root element.

§style: Option<String>§class_names: Option<SelectClassNames>

Semantic class names for sub-parts.

§styles: Option<SelectStyles>

Semantic styles for sub-parts.

§dropdown_class: Option<String>

Optional extra classes/styles for the dropdown popup.

§dropdown_style: Option<String>§dropdown_class_name: Option<String>

@deprecated Please use dropdown_class instead.

§dropdown_style_deprecated: Option<String>

@deprecated Please use dropdown_style instead.

§dropdown_match_select_width: Option<bool>

@deprecated Please use popup_match_select_width instead.

§popup_render: Option<Rc<dyn Fn(Element) -> Element>>

Custom render function for the dropdown popup: (menu) -> Element

§on_change: Option<EventHandler<Vec<String>>>

Change event emitted with the full set of selected keys.

§on_dropdown_visible_change: Option<EventHandler<bool>>

Called when dropdown visibility changes.

§on_open_change: Option<EventHandler<bool>>

@deprecated Please use on_dropdown_visible_change instead.

Implementations§

Source§

impl SelectProps

Source

pub fn builder() -> SelectPropsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), ())>

Create a builder for building SelectProps. On the builder, call .value(...)(optional), .values(...)(optional), .options(...), .mode(...)(optional), .multiple(...)(optional), .allow_clear(...)(optional), .placeholder(...)(optional), .disabled(...)(optional), .show_search(...)(optional), .filter_option(...)(optional), .token_separators(...)(optional), .status(...)(optional), .size(...)(optional), .variant(...)(optional), .bordered(...)(optional), .prefix(...)(optional), .suffix_icon(...)(optional), .placement(...)(optional), .popup_match_select_width(...)(optional), .class(...)(optional), .root_class_name(...)(optional), .style(...)(optional), .class_names(...)(optional), .styles(...)(optional), .dropdown_class(...)(optional), .dropdown_style(...)(optional), .dropdown_class_name(...)(optional), .dropdown_style_deprecated(...)(optional), .dropdown_match_select_width(...)(optional), .popup_render(...)(optional), .on_change(...)(optional), .on_dropdown_visible_change(...)(optional), .on_open_change(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of SelectProps.

Trait Implementations§

Source§

impl Clone for SelectProps

Source§

fn clone(&self) -> SelectProps

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl PartialEq for SelectProps

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Properties for SelectProps
where Self: Clone,

Source§

type Builder = SelectPropsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), ())>

The type of the builder for this component. Used to create “in-progress” versions of the props.
Source§

fn builder() -> Self::Builder

Create a builder for this component.
Source§

fn memoize(&mut self, new: &Self) -> bool

Make the old props equal to the new props. Return if the props were equal and should be memoized.
Source§

fn into_vcomponent<M>( self, render_fn: impl ComponentFunction<Self, M>, ) -> VComponent
where M: 'static,

Create a component from the props.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> InitializeFromFunction<T> for T

Source§

fn initialize_from_function(f: fn() -> T) -> T

Create an instance of this type from an initialization function
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<Ret> SpawnIfAsync<(), Ret> for Ret

Source§

fn spawn(self) -> Ret

Spawn the value into the dioxus runtime if it is an async block
Source§

impl<T, O> SuperFrom<T> for O
where O: From<T>,

Source§

fn super_from(input: T) -> O

Convert from a type to another type.
Source§

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

Source§

fn super_into(self) -> O

Convert from a type to another type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DependencyElement for T
where T: 'static + PartialEq + Clone,