TopAppBarDefaults

Artifact: androidx.compose.material3:material3

Added in 1.0.0

Cmn

@ExperimentalMaterial3Api
object TopAppBarDefaults

Contains default values used for the top app bar implementations.

Summary

Public functions
`TopAppBarColors`	`@Composable centerAlignedTopAppBarColors()` Creates a `TopAppBarColors` for `CenterAlignedTopAppBar`s.	Cmn
`TopAppBarColors`	`@Composable centerAlignedTopAppBarColors( containerColor: Color, scrolledContainerColor: Color, navigationIconContentColor: Color, titleContentColor: Color, actionIconContentColor: Color )` Creates a `TopAppBarColors` for `CenterAlignedTopAppBar`s.	Cmn
`TopAppBarScrollBehavior`	`@ExperimentalMaterial3Api @Composable enterAlwaysScrollBehavior( state: TopAppBarState, canScroll: () -> Boolean, snapAnimationSpec: AnimationSpec<Float>?, flingAnimationSpec: DecayAnimationSpec<Float>?, reverseLayout: Boolean )` Returns a `TopAppBarScrollBehavior`.	Cmn
`TopAppBarScrollBehavior`	`@ExperimentalMaterial3Api @Composable exitUntilCollapsedScrollBehavior( state: TopAppBarState, canScroll: () -> Boolean, snapAnimationSpec: AnimationSpec<Float>?, flingAnimationSpec: DecayAnimationSpec<Float>? )` Returns a `TopAppBarScrollBehavior` that adjusts its properties to affect the colors and height of the top app bar.	Cmn
`TopAppBarColors`	`@Composable largeTopAppBarColors()` Creates a `TopAppBarColors` for `LargeTopAppBar`s.	Cmn
`TopAppBarColors`	`@Composable largeTopAppBarColors( containerColor: Color, scrolledContainerColor: Color, navigationIconContentColor: Color, titleContentColor: Color, actionIconContentColor: Color )` Creates a `TopAppBarColors` for `LargeTopAppBar`s.	Cmn
`TopAppBarColors`	`@Composable mediumTopAppBarColors()` Creates a `TopAppBarColors` for `MediumTopAppBar`s.	Cmn
`TopAppBarColors`	`@Composable mediumTopAppBarColors( containerColor: Color, scrolledContainerColor: Color, navigationIconContentColor: Color, titleContentColor: Color, actionIconContentColor: Color )` Creates a `TopAppBarColors` for `MediumTopAppBar`s.	Cmn
`TopAppBarScrollBehavior`	`@ExperimentalMaterial3Api @Composable pinnedScrollBehavior(state: TopAppBarState, canScroll: () -> Boolean)` Returns a pinned `TopAppBarScrollBehavior` that tracks nested-scroll callbacks and updates its `TopAppBarState.contentOffset` accordingly.	Cmn
`TopAppBarColors`	`@Composable topAppBarColors()` Creates a `TopAppBarColors` for small `TopAppBar`.	Cmn
`TopAppBarColors`	`@Composable topAppBarColors( containerColor: Color, scrolledContainerColor: Color, navigationIconContentColor: Color, titleContentColor: Color, actionIconContentColor: Color )` Creates a `TopAppBarColors` for small `TopAppBar`.	Cmn

Public properties
`Dp`	`LargeAppBarCollapsedHeight` The default height of a `LargeTopAppBar` when collapsed by a `TopAppBarScrollBehavior`.	Cmn
`Dp`	`LargeAppBarExpandedHeight` The default expanded height of a `LargeTopAppBar`.	Cmn
`Dp`	`LargeAppBarWithSubtitleExpandedHeight` The default expanded height of a `LargeTopAppBar` with subtitle.	Cmn
`Dp`	`LargeAppBarWithoutSubtitleExpandedHeight` The default expanded height of a `LargeTopAppBar` without subtitle.	Cmn
`Dp`	`MediumAppBarCollapsedHeight` The default height of a `MediumTopAppBar` when collapsed by a `TopAppBarScrollBehavior`.	Cmn
`Dp`	`MediumAppBarExpandedHeight` The default expanded height of a `MediumTopAppBar`.	Cmn
`Dp`	`MediumAppBarWithSubtitleExpandedHeight` The default expanded height of a `MediumTopAppBar` with subtitle.	Cmn
`Dp`	`MediumAppBarWithoutSubtitleExpandedHeight` The default expanded height of a `MediumTopAppBar` without subtitle.	Cmn
`Dp`	`TopAppBarExpandedHeight` The default expanded height of a `TopAppBar` and the `CenterAlignedTopAppBar`.	Cmn
`WindowInsets`	`windowInsets` Default insets to be used and consumed by the top app bars	Cmn

Public functions

centerAlignedTopAppBarColors

Cmn

Added in 1.2.0

@Composable
fun centerAlignedTopAppBarColors(): TopAppBarColors

Creates a TopAppBarColors for CenterAlignedTopAppBars. The default implementation animates between the provided colors according to the Material Design specification.

centerAlignedTopAppBarColors

Cmn

@Composable
fun centerAlignedTopAppBarColors(
    containerColor: Color = Color.Unspecified,
    scrolledContainerColor: Color = Color.Unspecified,
    navigationIconContentColor: Color = Color.Unspecified,
    titleContentColor: Color = Color.Unspecified,
    actionIconContentColor: Color = Color.Unspecified
): TopAppBarColors

Creates a TopAppBarColors for CenterAlignedTopAppBars. The default implementation animates between the provided colors according to the Material Design specification.

Parameters
`containerColor: Color = Color.Unspecified`	the container color
`scrolledContainerColor: Color = Color.Unspecified`	the container color when content is scrolled behind it
`navigationIconContentColor: Color = Color.Unspecified`	the content color used for the navigation icon
`titleContentColor: Color = Color.Unspecified`	the content color used for the title
`actionIconContentColor: Color = Color.Unspecified`	the content color used for actions

Returns
`TopAppBarColors`	the resulting `TopAppBarColors` used for the top app bar

enterAlwaysScrollBehavior

Cmn

Added in 1.4.0-alpha05

@ExperimentalMaterial3Api
@Composable
fun enterAlwaysScrollBehavior(
    state: TopAppBarState = rememberTopAppBarState(),
    canScroll: () -> Boolean = { true },
    snapAnimationSpec: AnimationSpec<Float>? = MotionSchemeKeyTokens.DefaultEffects.value(),
    flingAnimationSpec: DecayAnimationSpec<Float>? = rememberSplineBasedDecay(),
    reverseLayout: Boolean = false
): TopAppBarScrollBehavior

Returns a TopAppBarScrollBehavior. A top app bar that is set up with this TopAppBarScrollBehavior will immediately collapse when the content is pulled up, and will immediately appear when the content is pulled down.

The returned TopAppBarScrollBehavior is remembered across compositions.

Parameters
`state: TopAppBarState = rememberTopAppBarState()`	the state object to be used to control or observe the top app bar's scroll state. See `rememberTopAppBarState` for a state that is remembered across compositions.
`canScroll: () -> Boolean = { true }`	a callback used to determine whether scroll events are to be handled by this `EnterAlwaysScrollBehavior`
`snapAnimationSpec: AnimationSpec<Float>? = MotionSchemeKeyTokens.DefaultEffects.value()`	an optional `AnimationSpec` that defines how the top 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 optional `DecayAnimationSpec` that defined how to fling the top app bar when the user flings the app bar itself, or the content below it
`reverseLayout: Boolean = false`	indicates that this behavior is applied to a scrollable content that has a reversed direction of scrolling and layout

exitUntilCollapsedScrollBehavior

Cmn

Added in 1.0.0

@ExperimentalMaterial3Api
@Composable
fun exitUntilCollapsedScrollBehavior(
    state: TopAppBarState = rememberTopAppBarState(),
    canScroll: () -> Boolean = { true },
    snapAnimationSpec: AnimationSpec<Float>? = MotionSchemeKeyTokens.DefaultEffects.value(),
    flingAnimationSpec: DecayAnimationSpec<Float>? = rememberSplineBasedDecay()
): TopAppBarScrollBehavior

Returns a TopAppBarScrollBehavior that adjusts its properties to affect the colors and height of the top app bar.

A top app bar that is set up with this TopAppBarScrollBehavior will immediately collapse when the nested content is pulled up, and will expand back the collapsed area when the content is pulled all the way down.

The returned TopAppBarScrollBehavior is remembered across compositions.

Parameters
`state: TopAppBarState = rememberTopAppBarState()`	the state object to be used to control or observe the top app bar's scroll state. See `rememberTopAppBarState` for a state that is remembered across compositions.
`canScroll: () -> Boolean = { true }`	a callback used to determine whether scroll events are to be handled by this `ExitUntilCollapsedScrollBehavior`
`snapAnimationSpec: AnimationSpec<Float>? = MotionSchemeKeyTokens.DefaultEffects.value()`	an optional `AnimationSpec` that defines how the top 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 optional `DecayAnimationSpec` that defined how to fling the top app bar when the user flings the app bar itself, or the content below it

largeTopAppBarColors

Cmn

Added in 1.2.0

@Composable
fun largeTopAppBarColors(): TopAppBarColors

Creates a TopAppBarColors for LargeTopAppBars. The default implementation interpolates between the provided colors as the top app bar scrolls according to the Material Design specification.

largeTopAppBarColors

Cmn

@Composable
fun largeTopAppBarColors(
    containerColor: Color = Color.Unspecified,
    scrolledContainerColor: Color = Color.Unspecified,
    navigationIconContentColor: Color = Color.Unspecified,
    titleContentColor: Color = Color.Unspecified,
    actionIconContentColor: Color = Color.Unspecified
): TopAppBarColors

Creates a TopAppBarColors for LargeTopAppBars. The default implementation interpolates between the provided colors as the top app bar scrolls according to the Material Design specification.

Parameters
`containerColor: Color = Color.Unspecified`	the container color
`scrolledContainerColor: Color = Color.Unspecified`	the container color when content is scrolled behind it
`navigationIconContentColor: Color = Color.Unspecified`	the content color used for the navigation icon
`titleContentColor: Color = Color.Unspecified`	the content color used for the title
`actionIconContentColor: Color = Color.Unspecified`	the content color used for actions

Returns
`TopAppBarColors`	the resulting `TopAppBarColors` used for the top app bar

mediumTopAppBarColors

Cmn

Added in 1.2.0

@Composable
fun mediumTopAppBarColors(): TopAppBarColors

Creates a TopAppBarColors for MediumTopAppBars. The default implementation interpolates between the provided colors as the top app bar scrolls according to the Material Design specification.

mediumTopAppBarColors

Cmn

@Composable
fun mediumTopAppBarColors(
    containerColor: Color = Color.Unspecified,
    scrolledContainerColor: Color = Color.Unspecified,
    navigationIconContentColor: Color = Color.Unspecified,
    titleContentColor: Color = Color.Unspecified,
    actionIconContentColor: Color = Color.Unspecified
): TopAppBarColors

Creates a TopAppBarColors for MediumTopAppBars. The default implementation interpolates between the provided colors as the top app bar scrolls according to the Material Design specification.

Parameters
`containerColor: Color = Color.Unspecified`	the container color
`scrolledContainerColor: Color = Color.Unspecified`	the container color when content is scrolled behind it
`navigationIconContentColor: Color = Color.Unspecified`	the content color used for the navigation icon
`titleContentColor: Color = Color.Unspecified`	the content color used for the title
`actionIconContentColor: Color = Color.Unspecified`	the content color used for actions

Returns
`TopAppBarColors`	the resulting `TopAppBarColors` used for the top app bar

pinnedScrollBehavior

Cmn

Added in 1.0.0

@ExperimentalMaterial3Api
@Composable
fun pinnedScrollBehavior(
    state: TopAppBarState = rememberTopAppBarState(),
    canScroll: () -> Boolean = { true }
): TopAppBarScrollBehavior

Returns a pinned TopAppBarScrollBehavior that tracks nested-scroll callbacks and updates its TopAppBarState.contentOffset accordingly.

The returned TopAppBarScrollBehavior is remembered across compositions.

Parameters
`state: TopAppBarState = rememberTopAppBarState()`	the state object to be used to control or observe the top app bar's scroll state. See `rememberTopAppBarState` for a state that is remembered across compositions.
`canScroll: () -> Boolean = { true }`	a callback used to determine whether scroll events are to be handled by this pinned `TopAppBarScrollBehavior`

topAppBarColors

Cmn

Added in 1.2.0

@Composable
fun topAppBarColors(): TopAppBarColors

Creates a TopAppBarColors for small TopAppBar. The default implementation animates between the provided colors according to the Material Design specification.

topAppBarColors

Cmn

@Composable
fun topAppBarColors(
    containerColor: Color = Color.Unspecified,
    scrolledContainerColor: Color = Color.Unspecified,
    navigationIconContentColor: Color = Color.Unspecified,
    titleContentColor: Color = Color.Unspecified,
    actionIconContentColor: Color = Color.Unspecified
): TopAppBarColors

Creates a TopAppBarColors for small TopAppBar. The default implementation animates between the provided colors according to the Material Design specification.

Parameters
`containerColor: Color = Color.Unspecified`	the container color
`scrolledContainerColor: Color = Color.Unspecified`	the container color when content is scrolled behind it
`navigationIconContentColor: Color = Color.Unspecified`	the content color used for the navigation icon
`titleContentColor: Color = Color.Unspecified`	the content color used for the title
`actionIconContentColor: Color = Color.Unspecified`	the content color used for actions

Returns
`TopAppBarColors`	the resulting `TopAppBarColors` used for the top app bar

Public properties

LargeAppBarCollapsedHeight

Cmn

Added in 1.3.0

val LargeAppBarCollapsedHeight: Dp

The default height of a LargeTopAppBar when collapsed by a TopAppBarScrollBehavior.

LargeAppBarExpandedHeight

Cmn

Added in 1.3.0

val LargeAppBarExpandedHeight: Dp

The default expanded height of a LargeTopAppBar.

LargeAppBarWithSubtitleExpandedHeight

Cmn

Added in 1.4.0-alpha05

val LargeAppBarWithSubtitleExpandedHeight: Dp

The default expanded height of a LargeTopAppBar with subtitle.

LargeAppBarWithoutSubtitleExpandedHeight

Cmn

Added in 1.4.0-alpha05

val LargeAppBarWithoutSubtitleExpandedHeight: Dp

The default expanded height of a LargeTopAppBar without subtitle.

MediumAppBarCollapsedHeight

Cmn

Added in 1.3.0

val MediumAppBarCollapsedHeight: Dp

The default height of a MediumTopAppBar when collapsed by a TopAppBarScrollBehavior.

MediumAppBarExpandedHeight

Cmn

Added in 1.3.0

val MediumAppBarExpandedHeight: Dp

The default expanded height of a MediumTopAppBar.

MediumAppBarWithSubtitleExpandedHeight

Cmn

Added in 1.4.0-alpha05

val MediumAppBarWithSubtitleExpandedHeight: Dp

The default expanded height of a MediumTopAppBar with subtitle.

MediumAppBarWithoutSubtitleExpandedHeight

Cmn

Added in 1.4.0-alpha05

val MediumAppBarWithoutSubtitleExpandedHeight: Dp

The default expanded height of a MediumTopAppBar without subtitle.

TopAppBarExpandedHeight

Cmn

Added in 1.3.0

val TopAppBarExpandedHeight: Dp

The default expanded height of a TopAppBar and the CenterAlignedTopAppBar.

windowInsets

Cmn

Added in 1.0.0

val windowInsets: WindowInsets

Default insets to be used and consumed by the top app bars