Struct SortableListProps 

pub struct SortableListProps {
    pub len: usize,
    pub render: Callback<usize, Element>,
    pub on_sort: EventHandler<SortEvent>,
    pub axis: Axis,
    pub live_preview: bool,
    pub transition_ms: u32,
    pub overlay: Option<Callback<usize, Element>>,
    pub touch_handle: bool,
    pub touch: TouchSense,
    pub handle: Option<Callback<usize, Element>>,
    pub item_key: Option<Callback<usize, String>>,
    pub attributes: Vec<Attribute>,
}

Properties for the SortableList component.

Fields

len: usize

Number of items.

render: Callback<usize, Element>

Renders the item at the given index.

on_sort: EventHandler<SortEvent>

Fired when the user drops an item at a new position.

axis: Axis

List direction: which axis rows are laid out (and shifted) along.

live_preview: bool

Open a live gap where the drop would land, by translating the rows in between. Set false for the plain highlight-only behavior.

transition_ms: u32

Duration (ms) of the row-slide transition during live preview.

overlay: Option<Callback<usize, Element>>

Opt-in floating ghost: renders overlay(index) pinned to the pointer while dragging, and hides the picked-up row in place so its slot reads as the drop gap. Absent → the row itself slides. Keep the ghost lightweight; it is your content, not a clone of the row.

touch_handle: bool

Confine touch/pen drags to a leading grip element instead of the whole row. The grip carries touch-action: none so the rest of the row keeps scrolling by finger - use this inside scrollable lists. Style it via [data-sort-handle].

touch: TouchSense

How a finger shares whole rows with native scrolling (ignored under touch_handle, where the grip owns every touch). TouchSense::Auto (default) keeps vertical swipes scrolling and picks a row up on a short hold or a sideways pull; TouchSense::Immediate makes any 8px travel drag.

handle: Option<Callback<usize, Element>>

Content for the touch_handle grip, keyed by index. Defaults to a braille-dots glyph when unset.

item_key: Option<Callback<usize, String>>

Stable render identity for each item. Supply this whenever rows own hook state or focus and the backing collection can reorder.

attributes: Vec<Attribute>

Implementations

impl SortableListProps

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

Create a builder for building SortableListProps. On the builder, call .len(...), .render(...), .on_sort(...), .axis(...)(optional), .live_preview(...)(optional), .transition_ms(...)(optional), .overlay(...)(optional), .touch_handle(...)(optional), .touch(...)(optional), .handle(...)(optional), .item_key(...)(optional), .attributes(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of SortableListProps.

Trait Implementations

impl Clone for SortableListProps

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl PartialEq for SortableListProps

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

Equality operator ==.

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

Inequality operator !=.

impl Properties for SortableListProps

where Self: Clone,

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

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

fn builder() -> Self::Builder

Create a builder for this component.

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.

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

where M: 'static,

Create a component from the props.