Struct SwipeToDismissSpec 

pub struct SwipeToDismissSpec {
    pub threshold_fraction: f32,
    pub key: Option<u64>,
    pub state: Option<SwipeDismissState>,
    pub direction: SwipeDismissDirection,
    pub edge_width: Option<f32>,
    pub collapse_after_dismiss: bool,
    pub reset_after_dismiss: bool,
    pub enabled: bool,
    /* private fields */
}

Configuration for SwipeToDismiss.

Fields

threshold_fraction: f32

Fraction of the content width the offset must exceed on release for the row to dismiss (default 0.5). Clamped to (0, 1].

key: Option<u64>

Identity of the wrapped content (e.g. the row’s database id). When a composition slot is reused for a DIFFERENT item — unkeyed lazy-list rows all shift up after a removal — the remembered swipe state must not leak onto the new item: without a key, the next row inherits the dismissed row’s displacement, revealed background and collapsed height (“items go shuffled, red boxes stick”).

Inside a keyed lazy list this is filled in from the item’s own key, so a row states its identity once, where the list already states it. Set it explicitly only for a row that is not a lazy item, or whose identity is not the one the list is keyed by.

state: Option<SwipeDismissState>

Caller-owned swipe state, from rememberSwipeDismissState.

Supply one to read the swipe as it happens — a label that fades in with it, a count of what is about to go, an undo bar after it lands — or to return a row to rest from elsewhere on the screen. Left unset, the row owns its own state.

direction: SwipeDismissDirection

edge_width: Option<f32>

collapse_after_dismiss: bool

reset_after_dismiss: bool

Whether the content returns to rest once on_dismiss has fired (default false).

A dismissed ROW is about to be removed by its host, so it stays off screen and the host drops it. A full-content NAVIGATION dismissal is not that: the gesture means “go up one level”, and the host may legitimately answer by staying composed – back out of a pause overlay and the game underneath resumes in the same root composable. Left off screen, that content never comes back, and since SwipeToDismissBox owns its state internally the application has no handle to call SwipeDismissState::reset on. The screen is then blank, taps land on nothing, and further back gestures neither redraw nor leave.

enabled: bool

Implementations

impl SwipeToDismissSpec

pub fn new() -> SwipeToDismissSpec

pub fn with_key(self, key: u64) -> SwipeToDismissSpec

Declares the identity of the wrapped content. When the key changes, the swipe state resets to rest — the new item starts untouched.

A row inside a keyed lazy list already has an identity and does not need this.

pub fn with_state(self, state: SwipeDismissState) -> SwipeToDismissSpec

Uses caller-owned swipe state, so the swipe can be read and reset from outside the row.

pub fn with_threshold_fraction(self, fraction: f32) -> SwipeToDismissSpec

Sets the dismiss threshold as a fraction of the content width.

pub fn with_background( self, background: impl FnMut(SwipeDismissSide) + 'static, ) -> SwipeToDismissSpec

Sets the background content revealed behind the swiped row. The closure receives the SwipeDismissSide the row is currently being swiped toward, so it can align its label/icon to the revealed edge.

pub fn with_direction( self, direction: SwipeDismissDirection, ) -> SwipeToDismissSpec

pub fn from_edge(self, width: f32) -> SwipeToDismissSpec

pub fn with_reset_after_dismiss(self, reset: bool) -> SwipeToDismissSpec

pub fn with_collapse_after_dismiss(self, collapse: bool) -> SwipeToDismissSpec

pub fn with_enabled(self, enabled: bool) -> SwipeToDismissSpec

Trait Implementations

impl Clone for SwipeToDismissSpec

fn clone(&self) -> SwipeToDismissSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for SwipeToDismissSpec

fn default() -> SwipeToDismissSpec

Returns the “default value” for a type.