FloatingAppBarDefaults

Artifact: androidx.compose.material3:material3

View Source

Added in 1.4.0-alpha03

Common/AllAndroid/JVM

• Cmn

  @ExperimentalMaterial3ExpressiveApi
  object FloatingAppBarDefaults

---

Contains default values used for the floating app bar implementations.

Summary

Public functions
FloatingAppBarScrollBehavior	@ExperimentalMaterial3ExpressiveApi @Composable exitAlwaysScrollBehavior(     exitDirection: FloatingAppBarExitDirection,     state: FloatingAppBarState,     snapAnimationSpec: AnimationSpec<Float>,     flingAnimationSpec: DecayAnimationSpec<Float> ) Returns a FloatingAppBarScrollBehavior.	Cmn
EnterTransition	@Composable horizontalEnterTransition(expandFrom: Alignment.Horizontal) Default enter transition used for HorizontalFloatingAppBar when expanding	Cmn
ExitTransition	@Composable horizontalExitTransition(shrinkTowards: Alignment.Horizontal) Default exit transition used for HorizontalFloatingAppBar when shrinking	Cmn
EnterTransition	@Composable verticalEnterTransition(expandFrom: Alignment.Vertical) Default enter transition used for VerticalFloatingAppBar when expanding	Cmn
ExitTransition	@Composable verticalExitTransition(shrinkTowards: Alignment.Vertical) Default exit transition used for VerticalFloatingAppBar when shrinking	Cmn

Public properties
Color	ContainerColor Default color used for HorizontalFloatingAppBar and VerticalFloatingAppBar container	Cmn
Dp	ContainerElevation Default elevation used for HorizontalFloatingAppBar and VerticalFloatingAppBar	Cmn
Shape	ContainerShape Default shape used for HorizontalFloatingAppBar and VerticalFloatingAppBar	Cmn
Dp	ContainerSize Default size used for HorizontalFloatingAppBar and VerticalFloatingAppBar container	Cmn
PaddingValues	ContentPadding Default padding used for HorizontalFloatingAppBar and VerticalFloatingAppBar when content are default size (24dp) icons in IconButton that meet the minimum touch target (48.dp).	Cmn
Dp	ScreenOffset Default offset from the edge of the screen used for HorizontalFloatingAppBar and VerticalFloatingAppBar.	Cmn

Public functions

exitAlwaysScrollBehavior

Cmn

@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 rememberFloatingAppBarState for a state that is remembered across compositions.
snapAnimationSpec: AnimationSpec<Float> = MotionSchemeKeyTokens.DefaultEffects.value()	an AnimationSpec that defines how the floating app bar snaps to either fully collapsed or fully extended state when a fling or a drag scrolled it into an intermediate position
flingAnimationSpec: DecayAnimationSpec<Float> = rememberSplineBasedDecay()	an DecayAnimationSpec that defines how to fling the floating app bar when the user flings the app bar itself, or the content below it

horizontalEnterTransition

Cmn

Added in 1.4.0-alpha03

@Composable
fun horizontalEnterTransition(expandFrom: Alignment.Horizontal): EnterTransition

Default enter transition used for HorizontalFloatingAppBar when expanding

horizontalExitTransition

Cmn

Added in 1.4.0-alpha03

@Composable
fun horizontalExitTransition(shrinkTowards: Alignment.Horizontal): ExitTransition

Default exit transition used for HorizontalFloatingAppBar when shrinking

verticalEnterTransition

Cmn

Added in 1.4.0-alpha03

@Composable
fun verticalEnterTransition(expandFrom: Alignment.Vertical): EnterTransition

Default enter transition used for VerticalFloatingAppBar when expanding

verticalExitTransition

Cmn

Added in 1.4.0-alpha03

@Composable
fun verticalExitTransition(shrinkTowards: Alignment.Vertical): ExitTransition

Default exit transition used for VerticalFloatingAppBar when shrinking

Public properties

ContainerColor

Cmn

Added in 1.4.0-alpha03

val ContainerColor: Color

Default color used for HorizontalFloatingAppBar and VerticalFloatingAppBar container

ContainerElevation

Cmn

Added in 1.4.0-alpha03

val ContainerElevation: Dp

Default elevation used for HorizontalFloatingAppBar and VerticalFloatingAppBar

ContainerShape

Cmn

Added in 1.4.0-alpha03

val ContainerShape: Shape

Default shape used for HorizontalFloatingAppBar and VerticalFloatingAppBar

ContainerSize

Cmn

Added in 1.4.0-alpha03

val ContainerSize: Dp

Default size used for HorizontalFloatingAppBar and VerticalFloatingAppBar container

ContentPadding

Cmn

Added in 1.4.0-alpha03

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

Cmn

Added in 1.4.0-alpha03

val ScreenOffset: Dp

Default offset from the edge of the screen used for HorizontalFloatingAppBar and VerticalFloatingAppBar.