/*
* Copyright 2019 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.
*/
package androidx.compose.material
import androidx.compose.animation.asDisposableClock
import androidx.compose.animation.core.AnimationClockObservable
import androidx.compose.animation.core.AnimationEndReason
import androidx.compose.animation.core.TweenSpec
import androidx.compose.foundation.Canvas
import androidx.compose.foundation.gestures.detectTapGestures
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.BoxWithConstraints
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.ColumnScope
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.offset
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.layout.preferredSizeIn
import androidx.compose.runtime.Composable
import androidx.compose.runtime.Stable
import androidx.compose.runtime.remember
import androidx.compose.runtime.savedinstancestate.Saver
import androidx.compose.runtime.savedinstancestate.rememberSavedInstanceState
import androidx.compose.ui.Modifier
import androidx.compose.ui.gesture.nestedscroll.nestedScroll
import androidx.compose.ui.gesture.scrollorientationlocking.Orientation
import androidx.compose.ui.gesture.tapGestureFilter
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.graphics.Shape
import androidx.compose.ui.input.pointer.pointerInput
import androidx.compose.ui.platform.AmbientAnimationClock
import androidx.compose.ui.platform.AmbientDensity
import androidx.compose.ui.platform.AmbientLayoutDirection
import androidx.compose.ui.semantics.dismiss
import androidx.compose.ui.semantics.semantics
import androidx.compose.ui.unit.Dp
import androidx.compose.ui.unit.IntOffset
import androidx.compose.ui.unit.LayoutDirection
import androidx.compose.ui.unit.dp
import androidx.compose.ui.util.lerp
import kotlin.math.roundToInt
/**
* Possible values of [DrawerState].
*/
enum class DrawerValue {
/**
* The state of the drawer when it is closed.
*/
Closed,
/**
* The state of the drawer when it is open.
*/
Open
}
/**
* Possible values of [BottomDrawerState].
*/
enum class BottomDrawerValue {
/**
* The state of the bottom drawer when it is closed.
*/
Closed,
/**
* The state of the bottom drawer when it is open (i.e. at 50% height).
*/
Open,
/**
* The state of the bottom drawer when it is expanded (i.e. at 100% height).
*/
Expanded
}
/**
* State of the [ModalDrawerLayout] composable.
*
* @param initialValue The initial value of the state.
* @param clock The animation clock that will be used to drive the animations.
* @param confirmStateChange Optional callback invoked to confirm or veto a pending state change.
*/
@Suppress("NotCloseable")
@OptIn(ExperimentalMaterialApi::class)
@Stable
class DrawerState(
initialValue: DrawerValue,
clock: AnimationClockObservable,
confirmStateChange: (DrawerValue) -> Boolean = { true }
) : SwipeableState<DrawerValue>(
initialValue = initialValue,
clock = clock,
animationSpec = AnimationSpec,
confirmStateChange = confirmStateChange
) {
/**
* Whether the drawer is open.
*/
val isOpen: Boolean
get() = value == DrawerValue.Open
/**
* Whether the drawer is closed.
*/
val isClosed: Boolean
get() = value == DrawerValue.Closed
/**
* Open the drawer with an animation.
*
* @param onOpened Optional callback invoked when the drawer has finished opening.
*/
fun open(onOpened: (() -> Unit)? = null) {
animateTo(
DrawerValue.Open,
onEnd = { endReason, endValue ->
if (endReason != AnimationEndReason.Interrupted && endValue == DrawerValue.Open) {
onOpened?.invoke()
}
}
)
}
/**
* Close the drawer with an animation.
*
* @param onClosed Optional callback invoked when the drawer has finished closing.
*/
fun close(onClosed: (() -> Unit)? = null) {
animateTo(
DrawerValue.Closed,
onEnd = { endReason, endValue ->
if (endReason != AnimationEndReason.Interrupted && endValue == DrawerValue.Closed) {
onClosed?.invoke()
}
}
)
}
companion object {
/**
* The default [Saver] implementation for [DrawerState].
*/
fun Saver(
clock: AnimationClockObservable,
confirmStateChange: (DrawerValue) -> Boolean
) = Saver<DrawerState, DrawerValue>(
save = { it.value },
restore = { DrawerState(it, clock, confirmStateChange) }
)
}
}
/**
* State of the [BottomDrawerLayout] composable.
*
* @param initialValue The initial value of the state.
* @param clock The animation clock that will be used to drive the animations.
* @param confirmStateChange Optional callback invoked to confirm or veto a pending state change.
*/
@Suppress("NotCloseable")
@OptIn(ExperimentalMaterialApi::class)
class BottomDrawerState(
initialValue: BottomDrawerValue,
clock: AnimationClockObservable,
confirmStateChange: (BottomDrawerValue) -> Boolean = { true }
) : SwipeableState<BottomDrawerValue>(
initialValue = initialValue,
clock = clock,
animationSpec = AnimationSpec,
confirmStateChange = confirmStateChange
) {
/**
* Whether the drawer is open.
*/
val isOpen: Boolean
get() = value == BottomDrawerValue.Open
/**
* Whether the drawer is closed.
*/
val isClosed: Boolean
get() = value == BottomDrawerValue.Closed
/**
* Whether the drawer is expanded.
*/
val isExpanded: Boolean
get() = value == BottomDrawerValue.Expanded
/**
* Open the drawer with an animation.
*
* @param onOpened Optional callback invoked when the drawer has finished opening.
*/
fun open(onOpened: (() -> Unit)? = null) {
animateTo(
BottomDrawerValue.Open,
onEnd = { endReason, endValue ->
if (endReason != AnimationEndReason.Interrupted &&
endValue == BottomDrawerValue.Open
) {
onOpened?.invoke()
}
}
)
}
/**
* Close the drawer with an animation.
*
* @param onClosed Optional callback invoked when the drawer has finished closing.
*/
fun close(onClosed: (() -> Unit)? = null) {
animateTo(
BottomDrawerValue.Closed,
onEnd = { endReason, endValue ->
if (endReason != AnimationEndReason.Interrupted &&
endValue == BottomDrawerValue.Closed
) {
onClosed?.invoke()
}
}
)
}
/**
* Expand the drawer with an animation.
*
* @param onExpanded Optional callback invoked when the drawer has finished expanding.
*/
fun expand(onExpanded: (() -> Unit)? = null) {
animateTo(
BottomDrawerValue.Expanded,
onEnd = { endReason, endValue ->
if (endReason != AnimationEndReason.Interrupted &&
endValue == BottomDrawerValue.Expanded
) {
onExpanded?.invoke()
}
}
)
}
internal val nestedScrollConnection = this.PreUpPostDownNestedScrollConnection
companion object {
/**
* The default [Saver] implementation for [BottomDrawerState].
*/
fun Saver(
clock: AnimationClockObservable,
confirmStateChange: (BottomDrawerValue) -> Boolean
) = Saver<BottomDrawerState, BottomDrawerValue>(
save = { it.value },
restore = { BottomDrawerState(it, clock, confirmStateChange) }
)
}
}
/**
* Create and [remember] a [DrawerState] with the default animation clock.
*
* @param initialValue The initial value of the state.
* @param confirmStateChange Optional callback invoked to confirm or veto a pending state change.
*/
@Composable
fun rememberDrawerState(
initialValue: DrawerValue,
confirmStateChange: (DrawerValue) -> Boolean = { true }
): DrawerState {
val clock = AmbientAnimationClock.current.asDisposableClock()
return rememberSavedInstanceState(
clock,
saver = DrawerState.Saver(clock, confirmStateChange)
) {
DrawerState(initialValue, clock, confirmStateChange)
}
}
/**
* Create and [remember] a [BottomDrawerState] with the default animation clock.
*
* @param initialValue The initial value of the state.
* @param confirmStateChange Optional callback invoked to confirm or veto a pending state change.
*/
@Composable
fun rememberBottomDrawerState(
initialValue: BottomDrawerValue,
confirmStateChange: (BottomDrawerValue) -> Boolean = { true }
): BottomDrawerState {
val clock = AmbientAnimationClock.current.asDisposableClock()
return rememberSavedInstanceState(
clock,
saver = BottomDrawerState.Saver(clock, confirmStateChange)
) {
BottomDrawerState(initialValue, clock, confirmStateChange)
}
}
/**
* Navigation drawers provide access to destinations in your app.
*
* Modal navigation drawers block interaction with the rest of an app’s content with a scrim.
* They are elevated above most of the app’s UI and don’t affect the screen’s layout grid.
*
* See [BottomDrawerLayout] for a layout that introduces a bottom drawer, suitable when
* using bottom navigation.
*
* @sample androidx.compose.material.samples.ModalDrawerSample
*
* @param drawerContent composable that represents content inside the drawer
* @param modifier optional modifier for the drawer
* @param drawerState state of the drawer
* @param gesturesEnabled whether or not drawer can be interacted by gestures
* @param drawerShape shape of the drawer sheet
* @param drawerElevation drawer sheet elevation. This controls the size of the shadow below the
* drawer sheet
* @param drawerBackgroundColor background color to be used for the drawer sheet
* @param drawerContentColor color of the content to use inside the drawer sheet. Defaults to
* either the matching `onFoo` color for [drawerBackgroundColor], or, if it is not a color from
* the theme, this will keep the same value set above this Surface.
* @param scrimColor color of the scrim that obscures content when the drawer is open
* @param bodyContent content of the rest of the UI
*
* @throws IllegalStateException when parent has [Float.POSITIVE_INFINITY] width
*/
@Composable
@OptIn(ExperimentalMaterialApi::class)
fun ModalDrawerLayout(
drawerContent: @Composable ColumnScope.() -> Unit,
modifier: Modifier = Modifier,
drawerState: DrawerState = rememberDrawerState(DrawerValue.Closed),
gesturesEnabled: Boolean = true,
drawerShape: Shape = MaterialTheme.shapes.large,
drawerElevation: Dp = DrawerDefaults.Elevation,
drawerBackgroundColor: Color = MaterialTheme.colors.surface,
drawerContentColor: Color = contentColorFor(drawerBackgroundColor),
scrimColor: Color = DrawerDefaults.scrimColor,
bodyContent: @Composable () -> Unit
) {
BoxWithConstraints(modifier.fillMaxSize()) {
val modalDrawerConstraints = constraints
// TODO : think about Infinite max bounds case
if (!modalDrawerConstraints.hasBoundedWidth) {
throw IllegalStateException("Drawer shouldn't have infinite width")
}
val minValue = -modalDrawerConstraints.maxWidth.toFloat()
val maxValue = 0f
val anchors = mapOf(minValue to DrawerValue.Closed, maxValue to DrawerValue.Open)
val isRtl = AmbientLayoutDirection.current == LayoutDirection.Rtl
val blockClicks = if (drawerState.isOpen) {
Modifier.pointerInput { detectTapGestures {} }
} else {
Modifier
}
Box(
Modifier.swipeable(
state = drawerState,
anchors = anchors,
thresholds = { _, _ -> FractionalThreshold(0.5f) },
orientation = Orientation.Horizontal,
enabled = gesturesEnabled,
reverseDirection = isRtl,
velocityThreshold = DrawerVelocityThreshold,
resistance = null
)
) {
Box {
bodyContent()
}
Scrim(
open = drawerState.isOpen,
onClose = { drawerState.close() },
fraction = { calculateFraction(minValue, maxValue, drawerState.offset.value) },
color = scrimColor
)
Surface(
modifier = with(AmbientDensity.current) {
Modifier
.preferredSizeIn(
minWidth = modalDrawerConstraints.minWidth.toDp(),
minHeight = modalDrawerConstraints.minHeight.toDp(),
maxWidth = modalDrawerConstraints.maxWidth.toDp(),
maxHeight = modalDrawerConstraints.maxHeight.toDp()
)
}
.semantics {
if (drawerState.isOpen) {
dismiss(action = { drawerState.close(); true })
}
}
.offset { IntOffset(drawerState.offset.value.roundToInt(), 0) }
.padding(end = EndDrawerPadding),
shape = drawerShape,
color = drawerBackgroundColor,
contentColor = drawerContentColor,
elevation = drawerElevation
) {
Column(Modifier.fillMaxSize().then(blockClicks), content = drawerContent)
}
}
}
}
/**
* Navigation drawers provide access to destinations in your app.
*
* Bottom navigation drawers are modal drawers that are anchored
* to the bottom of the screen instead of the left or right edge.
* They are only used with bottom app bars.
*
* These drawers open upon tapping the navigation menu icon in the bottom app bar.
* They are only for use on mobile.
*
* See [ModalDrawerLayout] for a layout that introduces a classic from-the-side drawer.
*
* @sample androidx.compose.material.samples.BottomDrawerSample
*
* @param drawerState state of the drawer
* @param modifier optional modifier for the drawer
* @param gesturesEnabled whether or not drawer can be interacted by gestures
* @param drawerShape shape of the drawer sheet
* @param drawerElevation drawer sheet elevation. This controls the size of the shadow below the
* drawer sheet
* @param drawerContent composable that represents content inside the drawer
* @param drawerBackgroundColor background color to be used for the drawer sheet
* @param drawerContentColor color of the content to use inside the drawer sheet. Defaults to
* either the matching `onFoo` color for [drawerBackgroundColor], or, if it is not a color from
* the theme, this will keep the same value set above this Surface.
* @param scrimColor color of the scrim that obscures content when the drawer is open
* @param bodyContent content of the rest of the UI
*
* @throws IllegalStateException when parent has [Float.POSITIVE_INFINITY] height
*/
@Composable
@OptIn(ExperimentalMaterialApi::class)
fun BottomDrawerLayout(
drawerContent: @Composable ColumnScope.() -> Unit,
modifier: Modifier = Modifier,
drawerState: BottomDrawerState = rememberBottomDrawerState(BottomDrawerValue.Closed),
gesturesEnabled: Boolean = true,
drawerShape: Shape = MaterialTheme.shapes.large,
drawerElevation: Dp = DrawerDefaults.Elevation,
drawerBackgroundColor: Color = MaterialTheme.colors.surface,
drawerContentColor: Color = contentColorFor(drawerBackgroundColor),
scrimColor: Color = DrawerDefaults.scrimColor,
bodyContent: @Composable () -> Unit
) {
BoxWithConstraints(modifier.fillMaxSize()) {
val modalDrawerConstraints = constraints
// TODO : think about Infinite max bounds case
if (!modalDrawerConstraints.hasBoundedHeight) {
throw IllegalStateException("Drawer shouldn't have infinite height")
}
val minValue = 0f
val maxValue = modalDrawerConstraints.maxHeight.toFloat()
// TODO: add proper landscape support
val isLandscape = modalDrawerConstraints.maxWidth > modalDrawerConstraints.maxHeight
val openValue = if (isLandscape) minValue else lerp(
minValue,
maxValue,
BottomDrawerOpenFraction
)
val anchors =
if (isLandscape) {
mapOf(
maxValue to BottomDrawerValue.Closed,
minValue to BottomDrawerValue.Open
)
} else {
mapOf(
maxValue to BottomDrawerValue.Closed,
openValue to BottomDrawerValue.Open,
minValue to BottomDrawerValue.Expanded
)
}
val blockClicks = if (drawerState.isClosed) {
Modifier
} else {
Modifier.pointerInput { detectTapGestures {} }
}
Box(
Modifier
.nestedScroll(drawerState.nestedScrollConnection)
.swipeable(
state = drawerState,
anchors = anchors,
orientation = Orientation.Vertical,
enabled = gesturesEnabled,
resistance = null
)
) {
Box {
bodyContent()
}
Scrim(
open = drawerState.isOpen,
onClose = { drawerState.close() },
fraction = {
// as we scroll "from height to 0" , need to reverse fraction
1 - calculateFraction(openValue, maxValue, drawerState.offset.value)
},
color = scrimColor
)
Surface(
modifier = with(AmbientDensity.current) {
Modifier.preferredSizeIn(
minWidth = modalDrawerConstraints.minWidth.toDp(),
minHeight = modalDrawerConstraints.minHeight.toDp(),
maxWidth = modalDrawerConstraints.maxWidth.toDp(),
maxHeight = modalDrawerConstraints.maxHeight.toDp()
)
}
.semantics {
if (drawerState.isOpen) {
dismiss(action = { drawerState.close(); true })
}
}.offset { IntOffset(0, drawerState.offset.value.roundToInt()) },
shape = drawerShape,
color = drawerBackgroundColor,
contentColor = drawerContentColor,
elevation = drawerElevation
) {
Column(Modifier.fillMaxSize().then(blockClicks), content = drawerContent)
}
}
}
}
/**
* Object to hold default values for [ModalDrawerLayout] and [BottomDrawerLayout]
*/
object DrawerDefaults {
/**
* Default Elevation for drawer sheet as specified in material specs
*/
val Elevation = 16.dp
val scrimColor: Color
@Composable
get() = MaterialTheme.colors.onSurface.copy(alpha = ScrimOpacity)
/**
* Default alpha for scrim color
*/
const val ScrimOpacity = 0.32f
}
private fun calculateFraction(a: Float, b: Float, pos: Float) =
((pos - a) / (b - a)).coerceIn(0f, 1f)
@Composable
private fun Scrim(
open: Boolean,
onClose: () -> Unit,
fraction: () -> Float,
color: Color
) {
val dismissDrawer = if (open) {
Modifier.tapGestureFilter { onClose() }
} else {
Modifier
}
Canvas(
Modifier
.fillMaxSize()
.then(dismissDrawer)
) {
drawRect(color, alpha = fraction())
}
}
private val EndDrawerPadding = 56.dp
private val DrawerVelocityThreshold = 400.dp
// TODO: b/177571613 this should be a proper decay settling
// this is taken from the DrawerLayout's DragViewHelper as a min duration.
private val AnimationSpec = TweenSpec<Float>(durationMillis = 256)
internal const val BottomDrawerOpenFraction = 0.5f