Skip to main content

RowSelectionState

yew_datatable::prelude

Struct RowSelectionState 

Source 
pub struct RowSelectionState { /* private fields */ }
Expand description

Complete row selection state for the table.

Tracks selected rows and provides methods for selection management with mode-aware behavior.

Implementations§

Source§

impl RowSelectionState

Source

pub fn new() -> RowSelectionState

Creates a new empty selection state.

§Returns
  • RowSelectionState: A new multi-selection state with row click enabled.
Source

pub fn with_mode(mode: RowSelectionMode) -> RowSelectionState

Creates a selection state with the given mode.

§Parameters
  • mode: The selection mode to use.
§Returns
  • RowSelectionState: A new selection state with the specified mode.
Source

pub fn with_row_click(self, enable: bool) -> RowSelectionState

Sets whether row click selection is enabled.

§Parameters
  • enable: Whether clicking a row selects it.
§Returns
  • Self: The modified selection state.
Source

pub fn with_sub_row_selection(self, enable: bool) -> RowSelectionState

Sets whether sub-row selection is enabled.

§Parameters
  • enable: Whether sub-rows can be selected.
§Returns
  • Self: The modified selection state.
Source

pub fn mode(&self) -> RowSelectionMode

Returns the selection mode.

§Returns
  • RowSelectionMode: The current selection mode.
Source

pub fn is_row_click_enabled(&self) -> bool

Returns whether row click selection is enabled.

§Returns
  • bool: Whether clicking a row selects it.
Source

pub fn is_enabled(&self) -> bool

Returns whether selection is enabled.

§Returns
  • bool: Whether any selection mode is active.
Source

pub fn is_selected(&self, row_id: &DataTableRowId) -> bool

Returns whether the given row is selected.

§Parameters
  • row_id: The row identifier to check.
§Returns
  • bool: Whether the row is currently selected.
Source

pub fn selected_count(&self) -> usize

Returns the number of selected rows.

§Returns
  • usize: The count of selected rows.
Source

pub fn has_selection(&self) -> bool

Returns whether any rows are selected.

§Returns
  • bool: Whether at least one row is selected.
Source

pub fn selected_ids(&self) -> impl Iterator<Item = &DataTableRowId>

Returns the selected row IDs.

§Returns
  • impl Iterator<Item = &DataTableRowId>: An iterator over selected row IDs.
Source

pub fn selected_ids_vec(&self) -> Vec<DataTableRowId>

Returns the selected row IDs as a vector.

§Returns
  • Vec<DataTableRowId>: A vector of selected row IDs.
Source

pub fn is_all_selected(&self, row_ids: &[DataTableRowId]) -> bool

Checks if all provided rows are selected.

§Parameters
  • row_ids: The row identifiers to check.
§Returns
  • bool: Whether all provided rows are selected.
Source

pub fn is_some_selected(&self, row_ids: &[DataTableRowId]) -> bool

Checks if some (but not all) provided rows are selected.

§Parameters
  • row_ids: The row identifiers to check.
§Returns
  • bool: Whether some but not all rows are selected.
Source

pub fn select(&mut self, row_id: DataTableRowId)

Selects a row.

§Parameters
  • row_id: The row identifier to select.
Source

pub fn deselect(&mut self, row_id: &DataTableRowId)

Deselects a row.

§Parameters
  • row_id: The row identifier to deselect.
Source

pub fn toggle(&mut self, row_id: DataTableRowId)

Toggles the selection state of a row.

§Parameters
  • row_id: The row identifier to toggle.
Source

pub fn select_many(&mut self, row_ids: impl IntoIterator<Item = DataTableRowId>)

Selects multiple rows.

§Parameters
  • row_ids: The row identifiers to select.
Source

pub fn deselect_many( &mut self, row_ids: impl IntoIterator<Item = DataTableRowId>, )

Deselects multiple rows.

§Parameters
  • row_ids: The row identifiers to deselect.
Source

pub fn select_all(&mut self, row_ids: impl IntoIterator<Item = DataTableRowId>)

Selects all provided rows.

§Parameters
  • row_ids: The row identifiers to select.
Source

pub fn toggle_all(&mut self, row_ids: Vec<DataTableRowId>)

Toggles selection of all provided rows.

§Parameters
  • row_ids: The row identifiers to toggle.
Source

pub fn clear(&mut self)

Clears all selections.

Source

pub fn set_mode(&mut self, mode: RowSelectionMode)

Sets the selection mode.

§Parameters
  • mode: The new selection mode.
Source

pub fn reset(&mut self)

Resets to initial state.

Trait Implementations§

Source§

impl Clone for RowSelectionState

Source§

fn clone(&self) -> RowSelectionState

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 Debug for RowSelectionState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RowSelectionState

Source§

fn default() -> RowSelectionState

Returns the “default value” for a type. Read more
Source§

impl PartialEq for RowSelectionState

Source§

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

Source§

impl StructuralPartialEq for RowSelectionState

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> IntoPropValue<Option<T>> for T

Source§

fn into_prop_value(self) -> Option<T>

Convert self to a value of a Properties struct.
Source§

impl<T> IntoPropValue<T> for T

Source§

fn into_prop_value(self) -> T

Convert self to a value of a Properties struct.
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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
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<Token, Builder, How> AllPropsFor<Builder, How> for Token
where Builder: Buildable<Token>, <Builder as Buildable<Token>>::WrappedToken: HasAllProps<<Builder as Buildable<Token>>::Output, How>,

Source§

impl<T> HasAllProps<(), T> for T