pub struct ReorderGroup<K>(/* private fields */);Expand description
Retain in the view. Owns order, stable-key geometry and pointer gesture lifetime. Supports one-dimensional lists, variable item sizes, keyboard Alt+Arrow reorder, Escape/deactivation cancellation, and release outside item bounds. Supply native roles/labels/click handlers on each card. Host owns persistence, removal focus restoration and scrolling/autoscroll policy; multi-column sorting is not implied.
Implementations§
Source§impl<K: Clone + Eq + Hash + 'static> ReorderGroup<K>
impl<K: Clone + Eq + Hash + 'static> ReorderGroup<K>
Sourcepub fn new(order: Vec<K>, axis: Axis) -> Result<Self, AnimationError>
pub fn new(order: Vec<K>, axis: Axis) -> Result<Self, AnimationError>
Creates a group, rejecting duplicate keys transactionally.
use gpui_kit::{div, prelude::*};
use gpui_motion_kit::{Axis, ReorderGroup};
let group = ReorderGroup::new(vec![1usize, 2, 3], Axis::Y)?; // persistent view field
let mut list = div().flex().flex_col();
for &key in group.order().iter() {
list = list.child(group.item(("row", key), key, div().id(("card", key)).child(key.to_string())));
}Sourcepub fn order(&self) -> Ref<'_, [K]>
pub fn order(&self) -> Ref<'_, [K]>
Current logical order. Drop this borrow before processing input or updating.
Sourcepub fn on_change(
self,
callback: impl Fn(&[K], &mut Window, &mut App) + 'static,
) -> Self
pub fn on_change( self, callback: impl Fn(&[K], &mut Window, &mut App) + 'static, ) -> Self
Registers a callback after pointer commit or keyboard reorder. The callback runs without borrowing group state and may update application entities.
Sourcepub fn set_order(&self, order: Vec<K>) -> Result<(), AnimationError>
pub fn set_order(&self, order: Vec<K>) -> Result<(), AnimationError>
Updates membership/order and cancels an active gesture. Duplicate keys fail without mutation. Invoke on model changes, not every render. Notify the view.
Sourcepub fn item<E: IntoElement + StatefulInteractiveElement + 'static>(
&self,
id: impl Into<ElementId>,
key: K,
child: E,
) -> ReorderElement<K, E>
pub fn item<E: IntoElement + StatefulInteractiveElement + 'static>( &self, id: impl Into<ElementId>, key: K, child: E, ) -> ReorderElement<K, E>
Wraps a styled item in measured position interpolation and native handlers. The key must belong to this group. Preserve the same Kit ID through reorder.
Sourcepub fn is_dragging(&self) -> bool
pub fn is_dragging(&self) -> bool
Whether a pointer currently owns a reorder gesture.
Trait Implementations§
Auto Trait Implementations§
impl<K> !RefUnwindSafe for ReorderGroup<K>
impl<K> !Send for ReorderGroup<K>
impl<K> !Sync for ReorderGroup<K>
impl<K> !UnwindSafe for ReorderGroup<K>
impl<K> Freeze for ReorderGroup<K>
impl<K> Unpin for ReorderGroup<K>
impl<K> UnsafeUnpin for ReorderGroup<K>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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