commonMain.androidx.compose.material.SwipeToDismiss.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of material-desktop Show documentation
Show all versions of material-desktop Show documentation
Compose Material Design Components library
/*
* Copyright 2020 The Android Open Source Project
*
* 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.
*/
@file:Suppress("Deprecation") // b/279939308
package androidx.compose.material
import androidx.compose.foundation.gestures.Orientation
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.BoxWithConstraints
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.RowScope
import androidx.compose.foundation.layout.offset
import androidx.compose.material.DismissDirection.EndToStart
import androidx.compose.material.DismissDirection.StartToEnd
import androidx.compose.material.DismissValue.Default
import androidx.compose.material.DismissValue.DismissedToEnd
import androidx.compose.material.DismissValue.DismissedToStart
import androidx.compose.material.SwipeableDefaults.StandardResistanceFactor
import androidx.compose.material.SwipeableDefaults.StiffResistanceFactor
import androidx.compose.runtime.Composable
import androidx.compose.runtime.remember
import androidx.compose.runtime.saveable.Saver
import androidx.compose.runtime.saveable.rememberSaveable
import androidx.compose.ui.Modifier
import androidx.compose.ui.platform.LocalLayoutDirection
import androidx.compose.ui.unit.IntOffset
import androidx.compose.ui.unit.LayoutDirection
import androidx.compose.ui.unit.dp
import kotlin.math.roundToInt
import kotlinx.coroutines.CancellationException
/**
* The directions in which a [SwipeToDismiss] can be dismissed.
*/
enum class DismissDirection {
/**
* Can be dismissed by swiping in the reading direction.
*/
StartToEnd,
/**
* Can be dismissed by swiping in the reverse of the reading direction.
*/
EndToStart
}
/**
* Possible values of [DismissState].
*/
enum class DismissValue {
/**
* Indicates the component has not been dismissed yet.
*/
Default,
/**
* Indicates the component has been dismissed in the reading direction.
*/
DismissedToEnd,
/**
* Indicates the component has been dismissed in the reverse of the reading direction.
*/
DismissedToStart
}
/**
* State of the [SwipeToDismiss] composable.
*
* @param initialValue The initial value of the state.
* @param confirmStateChange Optional callback invoked to confirm or veto a pending state change.
*/
@ExperimentalMaterialApi
class DismissState(
initialValue: DismissValue,
confirmStateChange: (DismissValue) -> Boolean = { true }
) : SwipeableState(initialValue, confirmStateChange = confirmStateChange) {
/**
* The direction (if any) in which the composable has been or is being dismissed.
*
* If the composable is settled at the default state, then this will be null. Use this to
* change the background of the [SwipeToDismiss] if you want different actions on each side.
*/
val dismissDirection: DismissDirection?
get() = if (offset.value == 0f) null else if (offset.value > 0f) StartToEnd else EndToStart
/**
* Whether the component has been dismissed in the given [direction].
*
* @param direction The dismiss direction.
*/
fun isDismissed(direction: DismissDirection): Boolean {
return currentValue == if (direction == StartToEnd) DismissedToEnd else DismissedToStart
}
/**
* Reset the component to the default position with animation and suspend until it if fully
* reset or animation has been cancelled. This method will throw [CancellationException] if
* the animation is interrupted
*
* @return the reason the reset animation ended
*/
suspend fun reset() = animateTo(targetValue = Default)
/**
* Dismiss the component in the given [direction], with an animation and suspend. This method
* will throw [CancellationException] if the animation is interrupted
*
* @param direction The dismiss direction.
*/
suspend fun dismiss(direction: DismissDirection) {
val targetValue = if (direction == StartToEnd) DismissedToEnd else DismissedToStart
animateTo(targetValue = targetValue)
}
companion object {
/**
* The default [Saver] implementation for [DismissState].
*/
fun Saver(
confirmStateChange: (DismissValue) -> Boolean
) = Saver(
save = { it.currentValue },
restore = { DismissState(it, confirmStateChange) }
)
}
}
/**
* Create and [remember] a [DismissState].
*
* @param initialValue The initial value of the state.
* @param confirmStateChange Optional callback invoked to confirm or veto a pending state change.
*/
@Composable
@ExperimentalMaterialApi
fun rememberDismissState(
initialValue: DismissValue = Default,
confirmStateChange: (DismissValue) -> Boolean = { true }
): DismissState {
return rememberSaveable(saver = DismissState.Saver(confirmStateChange)) {
DismissState(initialValue, confirmStateChange)
}
}
/**
* A composable that can be dismissed by swiping left or right.
*
* @sample androidx.compose.material.samples.SwipeToDismissListItems
*
* @param state The state of this component.
* @param modifier Optional [Modifier] for this component.
* @param directions The set of directions in which the component can be dismissed.
* @param dismissThresholds The thresholds the item needs to be swiped in order to be dismissed.
* @param background A composable that is stacked behind the content and is exposed when the
* content is swiped. You can/should use the [state] to have different backgrounds on each side.
* @param dismissContent The content that can be dismissed.
*/
@Composable
@ExperimentalMaterialApi
@Suppress("ReferencesDeprecated")
fun SwipeToDismiss(
state: DismissState,
modifier: Modifier = Modifier,
directions: Set = setOf(EndToStart, StartToEnd),
dismissThresholds: (DismissDirection) -> ThresholdConfig = {
FixedThreshold(DISMISS_THRESHOLD)
},
background: @Composable RowScope.() -> Unit,
dismissContent: @Composable RowScope.() -> Unit
) = BoxWithConstraints(modifier) {
val width = constraints.maxWidth.toFloat()
val isRtl = LocalLayoutDirection.current == LayoutDirection.Rtl
val anchors = mutableMapOf(0f to Default)
if (StartToEnd in directions) anchors += width to DismissedToEnd
if (EndToStart in directions) anchors += -width to DismissedToStart
val thresholds = { from: DismissValue, to: DismissValue ->
dismissThresholds(getDismissDirection(from, to)!!)
}
val minFactor =
if (EndToStart in directions) StandardResistanceFactor else StiffResistanceFactor
val maxFactor =
if (StartToEnd in directions) StandardResistanceFactor else StiffResistanceFactor
Box(
Modifier.swipeable(
state = state,
anchors = anchors,
thresholds = thresholds,
orientation = Orientation.Horizontal,
enabled = state.currentValue == Default,
reverseDirection = isRtl,
resistance = ResistanceConfig(
basis = width,
factorAtMin = minFactor,
factorAtMax = maxFactor
)
)
) {
Row(
content = background,
modifier = Modifier.matchParentSize()
)
Row(
content = dismissContent,
modifier = Modifier.offset { IntOffset(state.offset.value.roundToInt(), 0) }
)
}
}
private fun getDismissDirection(from: DismissValue, to: DismissValue): DismissDirection? {
return when {
// settled at the default state
from == to && from == Default -> null
// has been dismissed to the end
from == to && from == DismissedToEnd -> StartToEnd
// has been dismissed to the start
from == to && from == DismissedToStart -> EndToStart
// is currently being dismissed to the end
from == Default && to == DismissedToEnd -> StartToEnd
// is currently being dismissed to the start
from == Default && to == DismissedToStart -> EndToStart
// has been dismissed to the end but is now animated back to default
from == DismissedToEnd && to == Default -> StartToEnd
// has been dismissed to the start but is now animated back to default
from == DismissedToStart && to == Default -> EndToStart
else -> null
}
}
private val DISMISS_THRESHOLD = 56.dp
© 2015 - 2025 Weber Informatics LLC | Privacy Policy