FloatingAppBarDefaults
Contains default values used for the floating app bar implementations.
Summary
Public functions |
||
|---|---|---|
FloatingAppBarScrollBehavior |
@ExperimentalMaterial3ExpressiveApiReturns a |
Cmn
|
EnterTransition |
@ComposableDefault enter transition used for |
Cmn
|
ExitTransition |
@ComposableDefault exit transition used for |
Cmn
|
EnterTransition |
@ComposableDefault enter transition used for |
Cmn
|
ExitTransition |
@ComposableDefault exit transition used for |
Cmn
|
Public properties |
||
|---|---|---|
Color |
Default color used for |
Cmn
|
Dp |
Default elevation used for |
Cmn
|
Shape |
Default shape used for |
Cmn
|
Dp |
Default size used for |
Cmn
|
PaddingValues |
Default padding used for |
Cmn
|
Dp |
Default offset from the edge of the screen used for |
Cmn
|
Public functions
exitAlwaysScrollBehavior
@ExperimentalMaterial3ExpressiveApi
@Composable
fun exitAlwaysScrollBehavior(
exitDirection: FloatingAppBarExitDirection,
state: FloatingAppBarState = rememberFloatingAppBarState(),
snapAnimationSpec: AnimationSpec<Float> = MotionSchemeKeyTokens.DefaultEffects.value(),
flingAnimationSpec: DecayAnimationSpec<Float> = rememberSplineBasedDecay()
): FloatingAppBarScrollBehavior
Returns a FloatingAppBarScrollBehavior. A floating app bar that is set up with this FloatingAppBarScrollBehavior will immediately collapse when the content is pulled up, and will immediately appear when the content is pulled down.
| Parameters | |
|---|---|
exitDirection: FloatingAppBarExitDirection |
indicates the direction towards which the floating app bar exits the screen |
state: FloatingAppBarState = rememberFloatingAppBarState() |
the state object to be used to control or observe the floating app bar's scroll state. See |
snapAnimationSpec: AnimationSpec<Float> = MotionSchemeKeyTokens.DefaultEffects.value() |
an |
flingAnimationSpec: DecayAnimationSpec<Float> = rememberSplineBasedDecay() |
an |
horizontalEnterTransition
@Composable
fun horizontalEnterTransition(expandFrom: Alignment.Horizontal): EnterTransition
Default enter transition used for HorizontalFloatingAppBar when expanding
horizontalExitTransition
@Composable
fun horizontalExitTransition(shrinkTowards: Alignment.Horizontal): ExitTransition
Default exit transition used for HorizontalFloatingAppBar when shrinking
verticalEnterTransition
@Composable
fun verticalEnterTransition(expandFrom: Alignment.Vertical): EnterTransition
Default enter transition used for VerticalFloatingAppBar when expanding
verticalExitTransition
@Composable
fun verticalExitTransition(shrinkTowards: Alignment.Vertical): ExitTransition
Default exit transition used for VerticalFloatingAppBar when shrinking
Public properties
ContainerColor
val ContainerColor: Color
Default color used for HorizontalFloatingAppBar and VerticalFloatingAppBar container
ContainerElevation
val ContainerElevation: Dp
Default elevation used for HorizontalFloatingAppBar and VerticalFloatingAppBar
ContainerShape
val ContainerShape: Shape
Default shape used for HorizontalFloatingAppBar and VerticalFloatingAppBar
ContainerSize
val ContainerSize: Dp
Default size used for HorizontalFloatingAppBar and VerticalFloatingAppBar container
ContentPadding
val ContentPadding: PaddingValues
Default padding used for HorizontalFloatingAppBar and VerticalFloatingAppBar when content are default size (24dp) icons in IconButton that meet the minimum touch target (48.dp).
ScreenOffset
val ScreenOffset: Dp
Default offset from the edge of the screen used for HorizontalFloatingAppBar and VerticalFloatingAppBar.