Skip to main content

SelectionValue

Struct SelectionValue 

Source
#[non_exhaustive]
pub struct SelectionValue<'a> { pub selected_items: &'a [SharedString], pub selected_indices: &'a [usize], pub selected_keys: Option<&'a [SharedString]>, pub selected_text: &'a str, pub is_placeholder: bool, pub default_children: AnyElement, }
Expand description

v3’s value render props, as one value.

Select.Value, Autocomplete.Value and ComboBox.Value all hand their children a function and pass in {defaultChildren, isPlaceholder, selectedItems, selectedText}. defaultChildren is what the slot would have drawn, so a caller can wrap it instead of rebuilding it – which is what v3’s own examples do (if (isPlaceholder) return defaultChildren).

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§selected_items: &'a [SharedString]

selectedItems — the chosen items’ text. The order is the component’s selection order: Select walks the collection, while ComboBox and Autocomplete follow their selection set’s insertion order, the way pinned react-stately 3.49.0’s Set iterates.

§selected_indices: &'a [usize]

Where those items sit in the collection, for a caller keyed by index, in the same order as selected_items.

§selected_keys: Option<&'a [SharedString]>

The chosen items’ keys, in selection insertion order, when the component’s collection is keyed and those keys are distinct from the labels (Autocomplete, ComboBox). Select is index-keyed and carries no distinct key here. selected_items and selected_indices only contain entries for keys that currently resolve to collection items, so async-loaded or missing keys can make their lengths differ from selected_keys.

§selected_text: &'a str

selectedText — the same items joined. Select approximates v3’s en-US list formatter; the other two use plain comma-space in this port.

§is_placeholder: bool

isPlaceholder — nothing is chosen, so the placeholder shows.

§default_children: AnyElement

defaultChildren — the element this slot would have drawn.

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for SelectionValue<'a>

§

impl<'a> !Send for SelectionValue<'a>

§

impl<'a> !Sync for SelectionValue<'a>

§

impl<'a> !UnwindSafe for SelectionValue<'a>

§

impl<'a> Freeze for SelectionValue<'a>

§

impl<'a> Unpin for SelectionValue<'a>

§

impl<'a> UnsafeUnpin for SelectionValue<'a>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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