Highly customizable swipeable component with REVEAL/DISMISS modes, directional control, 15+ built-in animations, gradient backgrounds, threshold-based triggers, real-time progress and flexible theming.
A highly customizable, modern swipeable component for Compose Multiplatform
Supporting Android, iOS, Desktop, and Web (WASM) with beautiful animations and intuitive gestures
Experience the full range of swipe behaviors and animations
Add to your commonMain dependencies:
-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black){kind=icon}
implementation("com.stevdza-san:swipeable-kmp:1.0.4")Add to your libs.versions.toml:
[versions]
swipeableKmp = "1.0.4"
[libraries]
swipeable-kmp = { module = "com.stevdza-san:swipeable-kmp", version.ref = "swipeableKmp" }Then in your commonMain dependencies:
implementation(libs.swipeable.kmp)Note: For haptic feedback on Android, the library automatically adds the
VIBRATEpermission via manifest merger. No additional setup required!
Swipeable(
behavior = SwipeBehavior.REVEAL,
rightRevealActions = listOf(
SwipeAction(
customization = ActionCustomization(
icon = Icons.Default.Delete,
iconColor = Color.White,
containerColor = Color.Red
),
onAction = { /* Delete item */ }
)
),
// Add gradient background
rightBackground = SwipeBackground.linearGradient(
colors = listOf(Color.Red, Color.Pink)
),
// Add haptic feedback
hapticFeedbackConfig = HapticFeedbackConfig.Default
) {
// Your content here
Card {
Text("Swipe me!")
}
}Perfect for multiple actions - swipe to reveal persistent action buttons.
Swipeable(
behavior = SwipeBehavior.REVEAL,
rightRevealActions = listOf(
SwipeAction(/* Edit action */),
SwipeAction(/* Share action */),
SwipeAction(/* Delete action */)
)
) { /* content */ }Great for quick actions - swipe to trigger and automatically return.
Swipeable(
behavior = SwipeBehavior.DISMISS,
rightDismissAction = SwipeAction(
customization = ActionCustomization(
icon = Icons.Default.Archive,
containerColor = Color.Blue
),
onAction = { /* Archive item */ }
)
) { /* content */ }The threshold parameter controls both the maximum drag distance and when actions trigger:
Swipeable(
threshold = 0.3f // 30% of screen width
) { /* content */ }How it works:
screenWidth × threshold
0.3 = content can drag up to 30% of screen width0.5 = content can drag up to 50% of screen width0.2) = shorter drags, easier to trigger0.5) = longer drags, more effort requiredExamples:
threshold = 0.2 → Max drag: 20% of screen, triggers at full 20%threshold = 0.3 → Max drag: 30% of screen, triggers at full 30%threshold = 0.4 → Max drag: 40% of screen, triggers at full 40%Swipeable(
// Choose from 15+ built-in animations
actionAnimation = ActionAnimationConfig.Quantum,
// Or create custom animations
animationSpec = spring(
dampingRatio = Spring.DampingRatioMediumBouncy,
stiffness = Spring.StiffnessMedium
)
) { /* content */ }var swipeProgress by remember { mutableStateOf(0f) }
Swipeable(
onSwipeProgress = { progress, direction ->
swipeProgress = progress
// Create custom animations based on swipe progress
}
) {
Box(
modifier = Modifier
.scale(1f - swipeProgress * 0.1f) // Shrink as user swipes
.background(
lerp(Color.Blue, Color.Red, swipeProgress)
)
) {
Text("Progress: ${(swipeProgress * 100).toInt()}%")
}
}Create stunning visual effects with solid colors or gradients:
Swipeable(
// Solid color backgrounds
leftBackground = SwipeBackground.solid(Color.Blue),
rightBackground = SwipeBackground.solid(Color.Red),
// Linear gradient backgrounds
leftBackground = SwipeBackground.linearGradient(
colors = listOf(Color.Blue, Color.Cyan, Color.Green)
),
// Radial gradient backgrounds
rightBackground = SwipeBackground.radialGradient(
colors = listOf(Color.Red, Color.Orange, Color.Yellow)
)
) { /* content */ }Add tactile feedback to enhance the swipe experience with platform-native haptic effects.
Platform Support:
VibrationEffect API with fallback to legacy Vibrator (requires VIBRATE permission - auto-added by library)UIImpactFeedbackGenerator with prepared generators for optimal performanceSwipeable(
hapticFeedbackConfig = HapticFeedbackConfig.Default, // Medium haptic at threshold
rightDismissAction = SwipeAction(/* ... */)
) { /* content */ }Three distinct modes control when haptic feedback triggers:
// 1. THRESHOLD_ONCE - Single feedback at threshold (default)
// Perfect for clear "action ready" indication
Swipeable(
hapticFeedbackConfig = HapticFeedbackConfig(
mode = HapticFeedbackMode.THRESHOLD_ONCE,
intensity = HapticFeedbackIntensity.MEDIUM
)
) { /* content */ }
// 2. CONTINUOUS - Feedback while swiping
// Creates immersive tactile experience (throttled to ~5% progress intervals)
Swipeable(
hapticFeedbackConfig = HapticFeedbackConfig(
mode = HapticFeedbackMode.CONTINUOUS,
intensity = HapticFeedbackIntensity.LIGHT
)
) { /* content */ }
// 3. PROGRESS_STEPS - Feedback at 25%, 50%, 75%, 100%
// Provides incremental progress indicators
Swipeable(
hapticFeedbackConfig = HapticFeedbackConfig(
mode = HapticFeedbackMode.PROGRESS_STEPS,
intensity = HapticFeedbackIntensity.HEAVY
)
) { /* content */ }Three intensity levels for different use cases:
| Intensity | Android | iOS | Best For |
|---|---|---|---|
LIGHT |
TEXT_HANDLE_MOVE |
UIImpactFeedbackStyleLight |
Subtle, frequent feedback |
MEDIUM |
CLOCK_TICK |
UIImpactFeedbackStyleMedium |
Balanced, general use |
HEAVY |
CONTEXT_CLICK |
UIImpactFeedbackStyleHeavy |
Destructive actions, warnings |
Customize haptic feedback separately for left and right swipes - perfect for differentiating between destructive and non-destructive actions:
Swipeable(
// Light continuous feedback for archive (non-destructive)
leftHapticFeedbackConfig = HapticFeedbackConfig(
mode = HapticFeedbackMode.CONTINUOUS,
intensity = HapticFeedbackIntensity.LIGHT
),
// Heavy milestone feedback for delete (destructive)
rightHapticFeedbackConfig = HapticFeedbackConfig(
mode = HapticFeedbackMode.PROGRESS_STEPS,
intensity = HapticFeedbackIntensity.HEAVY
),
leftDismissAction = SwipeAction(label = "Archive", /* ... */),
rightDismissAction = SwipeAction(label = "Delete", /* ... */)
) { /* content */ }Note: leftHapticFeedbackConfig applies when swiping RIGHT (revealing left actions), and rightHapticFeedbackConfig applies when swiping LEFT (revealing right actions).
// Predefined configurations for common use cases
HapticFeedbackConfig.Default // Threshold once, medium intensity
HapticFeedbackConfig.Disabled // No haptic feedback
HapticFeedbackConfig.Continuous // Continuous, medium intensity
HapticFeedbackConfig.ProgressSteps // Progress steps, medium intensity// Email app - Different feedback for archive vs delete
Swipeable(
leftHapticFeedbackConfig = HapticFeedbackConfig(
mode = HapticFeedbackMode.THRESHOLD_ONCE,
intensity = HapticFeedbackIntensity.LIGHT
),
rightHapticFeedbackConfig = HapticFeedbackConfig(
mode = HapticFeedbackMode.THRESHOLD_ONCE,
intensity = HapticFeedbackIntensity.HEAVY
),
leftDismissAction = SwipeAction(label = "Archive", /* ... */),
rightDismissAction = SwipeAction(label = "Delete", /* ... */)
) { EmailCard() }
// Social media - Continuous feedback for interactive swipe
Swipeable(
hapticFeedbackConfig = HapticFeedbackConfig.Continuous,
leftRevealActions = listOf(
SwipeAction(label = "Like", /* ... */),
SwipeAction(label = "Share", /* ... */)
)
) { PostCard() }
// Settings - No haptic for subtle interactions
Swipeable(
hapticFeedbackConfig = HapticFeedbackConfig.Disabled,
rightRevealActions = listOf(
SwipeAction(label = "Edit", /* ... */)
)
) { SettingsRow() }Swipeable(
direction = SwipeDirection.RIGHT, // Only allow right swipes
threshold = 0.3f, // 30% of screen width for both drag distance & trigger
shape = RoundedCornerShape(16.dp), // Custom shape
leftBackground = SwipeBackground.solid(Color.Green), // Background styling
rightBackground = SwipeBackground.linearGradient(
colors = listOf(Color.Red, Color.Pink)
)
) { /* content */ }| Animation | Description | Best For |
|---|---|---|
Default |
Scale & fade in | General UI |
SlideUp |
Slide from bottom | Lists, sheets |
SlideDown |
Slide from top | Toolbars |
SlideLeft |
Slide to the left | Navigation |
SlideRight |
Slide to the right | Navigation |
Rotate |
Rotate with scale | Attention grab |
Bounce |
Elastic pop-in | Feedback |
Flip |
3D card flip | Cards |
Elastic |
Overshoot scaling | Playful UI |
Spring |
Springy entrance | Dynamic motion |
Pendulum |
Swinging motion | Playful actions |
Wave |
Fluid distortion | Organic UI |
Magnetic |
Pull & snap | Attraction effects |
Origami |
Folding reveal | Creative UI |
Materialize |
Particle assembly | Magical effects |
Quantum |
Glitch teleport | Futuristic UI |
Morph |
Shape morphing | Creative UI |
Custom |
User-defined | Advanced use |
// Try different animations with gradient backgrounds
Swipeable(
actionAnimation = ActionAnimationConfig.Quantum,
rightBackground = SwipeBackground.linearGradient(
colors = listOf(Color.Magenta, Color.Blue)
)
) { /* content */ }
Swipeable(
actionAnimation = ActionAnimationConfig.Pendulum,
leftBackground = SwipeBackground.radialGradient(
colors = listOf(Color.Green, Color.Yellow)
)
) { /* content */ }
Swipeable(
actionAnimation = ActionAnimationConfig.Wave,
rightBackground = SwipeBackground.solid(Color.Red)
) { /* content */ }val customAnimation = ActionAnimationConfig.custom(
enableScale = true,
enableFade = true,
animationModifier = { progress ->
Modifier
.rotate(progress * 360f)
.offset(y = (50.dp * (1f - progress)))
}
)The main composable component.
| Parameter | Type | Default | Description |
|---|---|---|---|
behavior |
SwipeBehavior |
DISMISS |
Interaction mode (DISMISS/REVEAL) |
direction |
SwipeDirection |
BOTH |
Allowed swipe directions |
threshold |
Float |
0.3f |
Controls both max drag distance and trigger point (0.0-1.0). Max drag = screenWidth × threshold. Action triggers at 100% of max drag. |
leftBackground |
SwipeBackground |
solid(Color.Gray) |
Left side background (solid/gradient) |
rightBackground |
SwipeBackground |
solid(Color.Red) |
Right side background (solid/gradient) |
actionAnimation |
ActionAnimationConfig |
Default |
Action button animations |
animationSpec |
AnimationSpec<Float> |
tween(300) |
Swipe transition animations |
hapticFeedbackConfig |
HapticFeedbackConfig |
Default |
Default haptic feedback for both directions |
leftHapticFeedbackConfig |
HapticFeedbackConfig? |
null |
Haptic config for left swipe (overrides default) |
rightHapticFeedbackConfig |
HapticFeedbackConfig? |
null |
Haptic config for right swipe (overrides default) |
onSwipeProgress |
((Float, SwipeDirection?) -> Unit)? |
null |
Real-time progress callback |
Defines an individual action button.
SwipeAction(
customization = ActionCustomization(
icon = Res.drawable.delete, // Action icon
iconSize = 24.dp, // Icon size
iconColor = Color.White, // Icon tint
containerColor = Color.Red, // Button background
shape = CircleShape, // Button shape
padding = 48.dp // Button size
),
onAction = { /* Handle action */ }, // Action callback
label = "Delete" // Accessibility label
)Configures background styling with solid colors or gradients.
// Solid color background
SwipeBackground.solid(Color.Red)
// Linear gradient background
SwipeBackground.linearGradient(
colors = listOf(Color.Blue, Color.Purple, Color.Pink),
startX = 0.0f, // Start position X
startY = 0.0f, // Start position Y
endX = Float.POSITIVE_INFINITY, // End position X
endY = 0.0f // End position Y
)
// Radial gradient background
SwipeBackground.radialGradient(
colors = listOf(Color.Yellow, Color.Orange, Color.Red),
centerX = Float.POSITIVE_INFINITY, // Center position X
centerY = Float.POSITIVE_INFINITY, // Center position Y
radius = Float.POSITIVE_INFINITY // Gradient radius
)Configures haptic feedback behavior and intensity.
HapticFeedbackConfig(
enabled = true, // Enable/disable haptic feedback
mode = HapticFeedbackMode.THRESHOLD_ONCE, // When to trigger (THRESHOLD_ONCE, CONTINUOUS, PROGRESS_STEPS)
intensity = HapticFeedbackIntensity.MEDIUM // How strong (LIGHT, MEDIUM, HEAVY)
)
// Convenient presets
HapticFeedbackConfig.Default // enabled, THRESHOLD_ONCE, MEDIUM
HapticFeedbackConfig.Disabled // disabled
HapticFeedbackConfig.Continuous // enabled, CONTINUOUS, MEDIUM
HapticFeedbackConfig.ProgressSteps // enabled, PROGRESS_STEPS, MEDIUMHapticFeedbackMode Options:
THRESHOLD_ONCE - Single feedback when threshold is reachedCONTINUOUS - Feedback throughout swipe (throttled every ~5% progress)PROGRESS_STEPS - Feedback at 25%, 50%, 75%, 100% milestonesHapticFeedbackIntensity Options:
LIGHT - Subtle, frequent interactionsMEDIUM - Balanced, general purposeHEAVY - Destructive actions, important eventsPlatform Requirements:
VIBRATE permission (automatically added by library manifest)Swipeable(
rightRevealActions = listOf(
SwipeAction(
customization = ActionCustomization(
icon = Icons.Default.Delete,
iconColor = MaterialTheme.colorScheme.onError,
containerColor = MaterialTheme.colorScheme.error,
shape = MaterialTheme.shapes.medium
)
)
),
shape = MaterialTheme.shapes.large,
rightBackground = SwipeBackground.linearGradient(
colors = listOf(
MaterialTheme.colorScheme.errorContainer,
MaterialTheme.colorScheme.error.copy(alpha = 0.7f)
)
)
) { /* content */ }// Define your design tokens
object SwipeTheme {
val dangerAction = ActionCustomization(
containerColor = Color(0xFFFF3B30),
iconColor = Color.White,
shape = RoundedCornerShape(12.dp)
)
val primaryAction = ActionCustomization(
containerColor = Color(0xFF007AFF),
iconColor = Color.White,
shape = CircleShape
)
// Gradient backgrounds
val dangerBackground = SwipeBackground.linearGradient(
colors = listOf(Color(0xFFFF3B30), Color(0xFFFF6B6B))
)
val successBackground = SwipeBackground.radialGradient(
colors = listOf(Color(0xFF34C759), Color(0xFF30D158), Color(0xFF32D74B))
)
}Made with ❤️ by Stevdza-San
A highly customizable, modern swipeable component for Compose Multiplatform
Supporting Android, iOS, Desktop, and Web (WASM) with beautiful animations and intuitive gestures
Experience the full range of swipe behaviors and animations
Add to your commonMain dependencies:
implementation("com.stevdza-san:swipeable-kmp:1.0.4")Add to your libs.versions.toml:
[versions]
swipeableKmp = "1.0.4"
[libraries]
swipeable-kmp = { module = "com.stevdza-san:swipeable-kmp", version.ref = "swipeableKmp" }Then in your commonMain dependencies:
implementation(libs.swipeable.kmp)Note: For haptic feedback on Android, the library automatically adds the
VIBRATEpermission via manifest merger. No additional setup required!
Swipeable(
behavior = SwipeBehavior.REVEAL,
rightRevealActions = listOf(
SwipeAction(
customization = ActionCustomization(
icon = Icons.Default.Delete,
iconColor = Color.White,
containerColor = Color.Red
),
onAction = { /* Delete item */ }
)
),
// Add gradient background
rightBackground = SwipeBackground.linearGradient(
colors = listOf(Color.Red, Color.Pink)
),
// Add haptic feedback
hapticFeedbackConfig = HapticFeedbackConfig.Default
) {
// Your content here
Card {
Text("Swipe me!")
}
}Perfect for multiple actions - swipe to reveal persistent action buttons.
Swipeable(
behavior = SwipeBehavior.REVEAL,
rightRevealActions = listOf(
SwipeAction(/* Edit action */),
SwipeAction(/* Share action */),
SwipeAction(/* Delete action */)
)
) { /* content */ }Great for quick actions - swipe to trigger and automatically return.
Swipeable(
behavior = SwipeBehavior.DISMISS,
rightDismissAction = SwipeAction(
customization = ActionCustomization(
icon = Icons.Default.Archive,
containerColor = Color.Blue
),
onAction = { /* Archive item */ }
)
) { /* content */ }The threshold parameter controls both the maximum drag distance and when actions trigger:
Swipeable(
threshold = 0.3f // 30% of screen width
) { /* content */ }How it works:
screenWidth × threshold
0.3 = content can drag up to 30% of screen width0.5 = content can drag up to 50% of screen width0.2) = shorter drags, easier to trigger0.5) = longer drags, more effort requiredExamples:
threshold = 0.2 → Max drag: 20% of screen, triggers at full 20%threshold = 0.3 → Max drag: 30% of screen, triggers at full 30%threshold = 0.4 → Max drag: 40% of screen, triggers at full 40%Swipeable(
// Choose from 15+ built-in animations
actionAnimation = ActionAnimationConfig.Quantum,
// Or create custom animations
animationSpec = spring(
dampingRatio = Spring.DampingRatioMediumBouncy,
stiffness = Spring.StiffnessMedium
)
) { /* content */ }var swipeProgress by remember { mutableStateOf(0f) }
Swipeable(
onSwipeProgress = { progress, direction ->
swipeProgress = progress
// Create custom animations based on swipe progress
}
) {
Box(
modifier = Modifier
.scale(1f - swipeProgress * 0.1f) // Shrink as user swipes
.background(
lerp(Color.Blue, Color.Red, swipeProgress)
)
) {
Text("Progress: ${(swipeProgress * 100).toInt()}%")
}
}Create stunning visual effects with solid colors or gradients:
Swipeable(
// Solid color backgrounds
leftBackground = SwipeBackground.solid(Color.Blue),
rightBackground = SwipeBackground.solid(Color.Red),
// Linear gradient backgrounds
leftBackground = SwipeBackground.linearGradient(
colors = listOf(Color.Blue, Color.Cyan, Color.Green)
),
// Radial gradient backgrounds
rightBackground = SwipeBackground.radialGradient(
colors = listOf(Color.Red, Color.Orange, Color.Yellow)
)
) { /* content */ }Add tactile feedback to enhance the swipe experience with platform-native haptic effects.
Platform Support:
VibrationEffect API with fallback to legacy Vibrator (requires VIBRATE permission - auto-added by library)UIImpactFeedbackGenerator with prepared generators for optimal performanceSwipeable(
hapticFeedbackConfig = HapticFeedbackConfig.Default, // Medium haptic at threshold
rightDismissAction = SwipeAction(/* ... */)
) { /* content */ }Three distinct modes control when haptic feedback triggers:
// 1. THRESHOLD_ONCE - Single feedback at threshold (default)
// Perfect for clear "action ready" indication
Swipeable(
hapticFeedbackConfig = HapticFeedbackConfig(
mode = HapticFeedbackMode.THRESHOLD_ONCE,
intensity = HapticFeedbackIntensity.MEDIUM
)
) { /* content */ }
// 2. CONTINUOUS - Feedback while swiping
// Creates immersive tactile experience (throttled to ~5% progress intervals)
Swipeable(
hapticFeedbackConfig = HapticFeedbackConfig(
mode = HapticFeedbackMode.CONTINUOUS,
intensity = HapticFeedbackIntensity.LIGHT
)
) { /* content */ }
// 3. PROGRESS_STEPS - Feedback at 25%, 50%, 75%, 100%
// Provides incremental progress indicators
Swipeable(
hapticFeedbackConfig = HapticFeedbackConfig(
mode = HapticFeedbackMode.PROGRESS_STEPS,
intensity = HapticFeedbackIntensity.HEAVY
)
) { /* content */ }Three intensity levels for different use cases:
| Intensity | Android | iOS | Best For |
|---|---|---|---|
LIGHT |
TEXT_HANDLE_MOVE |
UIImpactFeedbackStyleLight |
Subtle, frequent feedback |
MEDIUM |
CLOCK_TICK |
UIImpactFeedbackStyleMedium |
Balanced, general use |
HEAVY |
CONTEXT_CLICK |
UIImpactFeedbackStyleHeavy |
Destructive actions, warnings |
Customize haptic feedback separately for left and right swipes - perfect for differentiating between destructive and non-destructive actions:
Swipeable(
// Light continuous feedback for archive (non-destructive)
leftHapticFeedbackConfig = HapticFeedbackConfig(
mode = HapticFeedbackMode.CONTINUOUS,
intensity = HapticFeedbackIntensity.LIGHT
),
// Heavy milestone feedback for delete (destructive)
rightHapticFeedbackConfig = HapticFeedbackConfig(
mode = HapticFeedbackMode.PROGRESS_STEPS,
intensity = HapticFeedbackIntensity.HEAVY
),
leftDismissAction = SwipeAction(label = "Archive", /* ... */),
rightDismissAction = SwipeAction(label = "Delete", /* ... */)
) { /* content */ }Note: leftHapticFeedbackConfig applies when swiping RIGHT (revealing left actions), and rightHapticFeedbackConfig applies when swiping LEFT (revealing right actions).
// Predefined configurations for common use cases
HapticFeedbackConfig.Default // Threshold once, medium intensity
HapticFeedbackConfig.Disabled // No haptic feedback
HapticFeedbackConfig.Continuous // Continuous, medium intensity
HapticFeedbackConfig.ProgressSteps // Progress steps, medium intensity// Email app - Different feedback for archive vs delete
Swipeable(
leftHapticFeedbackConfig = HapticFeedbackConfig(
mode = HapticFeedbackMode.THRESHOLD_ONCE,
intensity = HapticFeedbackIntensity.LIGHT
),
rightHapticFeedbackConfig = HapticFeedbackConfig(
mode = HapticFeedbackMode.THRESHOLD_ONCE,
intensity = HapticFeedbackIntensity.HEAVY
),
leftDismissAction = SwipeAction(label = "Archive", /* ... */),
rightDismissAction = SwipeAction(label = "Delete", /* ... */)
) { EmailCard() }
// Social media - Continuous feedback for interactive swipe
Swipeable(
hapticFeedbackConfig = HapticFeedbackConfig.Continuous,
leftRevealActions = listOf(
SwipeAction(label = "Like", /* ... */),
SwipeAction(label = "Share", /* ... */)
)
) { PostCard() }
// Settings - No haptic for subtle interactions
Swipeable(
hapticFeedbackConfig = HapticFeedbackConfig.Disabled,
rightRevealActions = listOf(
SwipeAction(label = "Edit", /* ... */)
)
) { SettingsRow() }Swipeable(
direction = SwipeDirection.RIGHT, // Only allow right swipes
threshold = 0.3f, // 30% of screen width for both drag distance & trigger
shape = RoundedCornerShape(16.dp), // Custom shape
leftBackground = SwipeBackground.solid(Color.Green), // Background styling
rightBackground = SwipeBackground.linearGradient(
colors = listOf(Color.Red, Color.Pink)
)
) { /* content */ }| Animation | Description | Best For |
|---|---|---|
Default |
Scale & fade in | General UI |
SlideUp |
Slide from bottom | Lists, sheets |
SlideDown |
Slide from top | Toolbars |
SlideLeft |
Slide to the left | Navigation |
SlideRight |
Slide to the right | Navigation |
Rotate |
Rotate with scale | Attention grab |
Bounce |
Elastic pop-in | Feedback |
Flip |
3D card flip | Cards |
Elastic |
Overshoot scaling | Playful UI |
Spring |
Springy entrance | Dynamic motion |
Pendulum |
Swinging motion | Playful actions |
Wave |
Fluid distortion | Organic UI |
Magnetic |
Pull & snap | Attraction effects |
Origami |
Folding reveal | Creative UI |
Materialize |
Particle assembly | Magical effects |
Quantum |
Glitch teleport | Futuristic UI |
Morph |
Shape morphing | Creative UI |
Custom |
User-defined | Advanced use |
// Try different animations with gradient backgrounds
Swipeable(
actionAnimation = ActionAnimationConfig.Quantum,
rightBackground = SwipeBackground.linearGradient(
colors = listOf(Color.Magenta, Color.Blue)
)
) { /* content */ }
Swipeable(
actionAnimation = ActionAnimationConfig.Pendulum,
leftBackground = SwipeBackground.radialGradient(
colors = listOf(Color.Green, Color.Yellow)
)
) { /* content */ }
Swipeable(
actionAnimation = ActionAnimationConfig.Wave,
rightBackground = SwipeBackground.solid(Color.Red)
) { /* content */ }val customAnimation = ActionAnimationConfig.custom(
enableScale = true,
enableFade = true,
animationModifier = { progress ->
Modifier
.rotate(progress * 360f)
.offset(y = (50.dp * (1f - progress)))
}
)The main composable component.
| Parameter | Type | Default | Description |
|---|---|---|---|
behavior |
SwipeBehavior |
DISMISS |
Interaction mode (DISMISS/REVEAL) |
direction |
SwipeDirection |
BOTH |
Allowed swipe directions |
threshold |
Float |
0.3f |
Controls both max drag distance and trigger point (0.0-1.0). Max drag = screenWidth × threshold. Action triggers at 100% of max drag. |
leftBackground |
SwipeBackground |
solid(Color.Gray) |
Left side background (solid/gradient) |
rightBackground |
SwipeBackground |
solid(Color.Red) |
Right side background (solid/gradient) |
actionAnimation |
ActionAnimationConfig |
Default |
Action button animations |
animationSpec |
AnimationSpec<Float> |
tween(300) |
Swipe transition animations |
hapticFeedbackConfig |
HapticFeedbackConfig |
Default |
Default haptic feedback for both directions |
leftHapticFeedbackConfig |
HapticFeedbackConfig? |
null |
Haptic config for left swipe (overrides default) |
rightHapticFeedbackConfig |
HapticFeedbackConfig? |
null |
Haptic config for right swipe (overrides default) |
onSwipeProgress |
((Float, SwipeDirection?) -> Unit)? |
null |
Real-time progress callback |
Defines an individual action button.
SwipeAction(
customization = ActionCustomization(
icon = Res.drawable.delete, // Action icon
iconSize = 24.dp, // Icon size
iconColor = Color.White, // Icon tint
containerColor = Color.Red, // Button background
shape = CircleShape, // Button shape
padding = 48.dp // Button size
),
onAction = { /* Handle action */ }, // Action callback
label = "Delete" // Accessibility label
)Configures background styling with solid colors or gradients.
// Solid color background
SwipeBackground.solid(Color.Red)
// Linear gradient background
SwipeBackground.linearGradient(
colors = listOf(Color.Blue, Color.Purple, Color.Pink),
startX = 0.0f, // Start position X
startY = 0.0f, // Start position Y
endX = Float.POSITIVE_INFINITY, // End position X
endY = 0.0f // End position Y
)
// Radial gradient background
SwipeBackground.radialGradient(
colors = listOf(Color.Yellow, Color.Orange, Color.Red),
centerX = Float.POSITIVE_INFINITY, // Center position X
centerY = Float.POSITIVE_INFINITY, // Center position Y
radius = Float.POSITIVE_INFINITY // Gradient radius
)Configures haptic feedback behavior and intensity.
HapticFeedbackConfig(
enabled = true, // Enable/disable haptic feedback
mode = HapticFeedbackMode.THRESHOLD_ONCE, // When to trigger (THRESHOLD_ONCE, CONTINUOUS, PROGRESS_STEPS)
intensity = HapticFeedbackIntensity.MEDIUM // How strong (LIGHT, MEDIUM, HEAVY)
)
// Convenient presets
HapticFeedbackConfig.Default // enabled, THRESHOLD_ONCE, MEDIUM
HapticFeedbackConfig.Disabled // disabled
HapticFeedbackConfig.Continuous // enabled, CONTINUOUS, MEDIUM
HapticFeedbackConfig.ProgressSteps // enabled, PROGRESS_STEPS, MEDIUMHapticFeedbackMode Options:
THRESHOLD_ONCE - Single feedback when threshold is reachedCONTINUOUS - Feedback throughout swipe (throttled every ~5% progress)PROGRESS_STEPS - Feedback at 25%, 50%, 75%, 100% milestonesHapticFeedbackIntensity Options:
LIGHT - Subtle, frequent interactionsMEDIUM - Balanced, general purposeHEAVY - Destructive actions, important eventsPlatform Requirements:
VIBRATE permission (automatically added by library manifest)Swipeable(
rightRevealActions = listOf(
SwipeAction(
customization = ActionCustomization(
icon = Icons.Default.Delete,
iconColor = MaterialTheme.colorScheme.onError,
containerColor = MaterialTheme.colorScheme.error,
shape = MaterialTheme.shapes.medium
)
)
),
shape = MaterialTheme.shapes.large,
rightBackground = SwipeBackground.linearGradient(
colors = listOf(
MaterialTheme.colorScheme.errorContainer,
MaterialTheme.colorScheme.error.copy(alpha = 0.7f)
)
)
) { /* content */ }// Define your design tokens
object SwipeTheme {
val dangerAction = ActionCustomization(
containerColor = Color(0xFFFF3B30),
iconColor = Color.White,
shape = RoundedCornerShape(12.dp)
)
val primaryAction = ActionCustomization(
containerColor = Color(0xFF007AFF),
iconColor = Color.White,
shape = CircleShape
)
// Gradient backgrounds
val dangerBackground = SwipeBackground.linearGradient(
colors = listOf(Color(0xFFFF3B30), Color(0xFFFF6B6B))
)
val successBackground = SwipeBackground.radialGradient(
colors = listOf(Color(0xFF34C759), Color(0xFF30D158), Color(0xFF32D74B))
)
}Made with ❤️ by Stevdza-San