BottomAppBarDefaults
-
Cmn
object BottomAppBarDefaults
Contains default values used for the bottom app bar implementations.
Summary
Public functions |
||
|---|---|---|
BottomAppBarScrollBehavior |
@ExperimentalMaterial3ApiReturns a |
Cmn
|
Public properties |
||
|---|---|---|
Dp |
Default elevation used for |
Cmn
|
PaddingValues |
Default padding used for |
Cmn
|
Dp |
Default height of a flexible |
Cmn
|
PaddingValues |
Default padding used for |
Cmn
|
Arrangement.Horizontal |
An |
Cmn
|
Arrangement.Horizontal |
A default |
Cmn
|
Color |
The color of a |
Cmn
|
Color |
Default color used for |
Cmn
|
DecayAnimationSpec<Float> |
Default |
Cmn
|
AnimationSpec<Float> |
Default |
Cmn
|
WindowInsets |
Default insets that will be used and consumed by |
Cmn
|
Public functions
exitAlwaysScrollBehavior
@ExperimentalMaterial3Api
@Composable
fun exitAlwaysScrollBehavior(
state: BottomAppBarState = rememberBottomAppBarState(),
canScroll: () -> Boolean = { true },
snapAnimationSpec: AnimationSpec<Float>? = BottomAppBarDefaults.snapAnimationSpec,
flingAnimationSpec: DecayAnimationSpec<Float>? = BottomAppBarDefaults.flingAnimationSpec
): BottomAppBarScrollBehavior
Returns a BottomAppBarScrollBehavior. A bottom app bar that is set up with this BottomAppBarScrollBehavior will immediately collapse when the content is pulled up, and will immediately appear when the content is pulled down.
The returned BottomAppBarScrollBehavior is remembered across compositions.
| Parameters | |
|---|---|
state: BottomAppBarState = rememberBottomAppBarState() |
the state object to be used to control or observe the bottom app bar's scroll state. See |
canScroll: () -> Boolean = { true } |
a callback used to determine whether scroll events are to be handled by this |
snapAnimationSpec: AnimationSpec<Float>? = BottomAppBarDefaults.snapAnimationSpec |
an optional |
flingAnimationSpec: DecayAnimationSpec<Float>? = BottomAppBarDefaults.flingAnimationSpec |
an optional |
Public properties
ContentPadding
val ContentPadding: PaddingValues
Default padding used for BottomAppBar when content are default size (24dp) icons in IconButton that meet the minimum touch target (48.dp).
FlexibleBottomAppBarHeight
val FlexibleBottomAppBarHeight: Dp
Default height of a flexible FlexibleBottomAppBar. The height here represents the height of the bottom app bar in its expanded state.
FlexibleContentPadding
val FlexibleContentPadding: PaddingValues
Default padding used for FlexibleBottomAppBar.
FlexibleFixedHorizontalArrangement
val FlexibleFixedHorizontalArrangement: Arrangement.Horizontal
An Arrangement that will be used to space FlexibleBottomAppBar's with a fixed spacing.
FlexibleHorizontalArrangement
val FlexibleHorizontalArrangement: Arrangement.Horizontal
A default Arrangement that will be used to space a FlexibleBottomAppBar's content.
bottomAppBarFabColor
val bottomAppBarFabColor: Color
The color of a BottomAppBar's FloatingActionButton
flingAnimationSpec
val flingAnimationSpec: DecayAnimationSpec<Float>
Default DecayAnimationSpec that defines how to fling the bottom app bar when the user flings the app bar itself, or the scrollable content.
snapAnimationSpec
val snapAnimationSpec: AnimationSpec<Float>
Default AnimationSpec that defines how the bottom app bar snaps to either fully collapsed or fully extended state when a fling or a drag scrolled it into an intermediate position.
windowInsets
val windowInsets: WindowInsets
Default insets that will be used and consumed by BottomAppBar.