https://github.com/saket/swipe
Swipe gesture actions for Compose UI
https://github.com/saket/swipe
android compose gestures swipe
Last synced: 13 days ago
JSON representation
Swipe gesture actions for Compose UI
- Host: GitHub
- URL: https://github.com/saket/swipe
- Owner: saket
- License: apache-2.0
- Created: 2022-03-10T16:21:09.000Z (about 3 years ago)
- Default Branch: trunk
- Last Pushed: 2024-05-11T00:51:59.000Z (about 1 year ago)
- Last Synced: 2025-04-03T20:10:26.631Z (about 2 months ago)
- Topics: android, compose, gestures, swipe
- Language: Kotlin
- Homepage:
- Size: 483 KB
- Stars: 738
- Watchers: 3
- Forks: 37
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-list - saket/swipe - Swipe gesture actions for Compose UI (Kotlin)
README
# swipe
https://user-images.githubusercontent.com/2387680/157795117-3a343625-4a34-4303-bb28-d2deea7f9b68.mp4
`swipe` builds composables that can be swiped left or right for revealing actions. Unlike [SwipeToDismiss](https://developer.android.com/reference/kotlin/androidx/compose/material/package-summary#SwipeToDismiss(androidx.compose.material.DismissState,androidx.compose.ui.Modifier,kotlin.collections.Set,kotlin.Function1,kotlin.Function1,kotlin.Function1)), it is designed for swipe actions that _do not_ dismiss their composable.
```groovy
implementation "me.saket.swipe:swipe:1.3.0"
```
```kotlin
val archive = SwipeAction(
icon = rememberVectorPainter(Icons.TwoTone.Archive),
background = Color.Green,
onSwipe = { … }
)
val snooze = SwipeAction(
icon = { Text("Snooze") },
background = Color.Yellow,
isUndo = true,
onSwipe = { … },
)
SwipeableActionsBox(
startActions = listOf(archive),
endActions = listOf(snooze)
) {
// Swipeable content goes here.
}
```
## License
```
Copyright 2022 Saket Narayan.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```