Jenga/io.github.joelkanyi.jenga.component.swipe

Package-level declarations

JengaSwipeToDismiss.

Types

JengaSwipeDirection

enum JengaSwipeDirection : Enum<JengaSwipeDirection>

Which way a JengaSwipeToDismiss row can be swiped to trigger its action.

JengaSwipeToDismissColors

@Immutable

class JengaSwipeToDismissColors(val container: Color, val content: Color)

Resolved colors for a JengaSwipeToDismiss reveal panel.

JengaSwipeToDismissDefaults

object JengaSwipeToDismissDefaults

Defaults and token mappings for JengaSwipeToDismiss.

Functions

JengaSwipeToDismiss

@Composable

fun JengaSwipeToDismiss(onDismiss: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, direction: JengaSwipeDirection = JengaSwipeDirection.EndToStart, icon: ImageVector = JengaTheme.icons.trash, actionContentDescription: String? = null, colors: JengaSwipeToDismissColors = JengaSwipeToDismissDefaults.colors(), background: @Composable () -> Unit? = null, content: @Composable () -> Unit)

A row wrapper that reveals an action panel as it is swiped and triggers onDismiss once dragged past the threshold: the standard swipe-to-delete gesture. Generic and token-driven: by default it shows a destructive error panel with a icon glyph at the swiped end, but supply your own background slot for a different action.