VerticalFloatingToolbarWithFabOverrideScope

Class

Common

@ExperimentalMaterial3ComponentOverrideApi
class VerticalFloatingToolbarWithFabOverrideScope
internal constructor(
    val isExpanded: Boolean,
    val floatingActionButton: @Composable () -> Unit,
    val modifier: Modifier,
    val colors: FloatingToolbarColors,
    val contentPadding: PaddingValues,
    val scrollBehavior: FloatingToolbarScrollBehavior?,
    val shape: Shape,
    val floatingActionButtonPosition: FloatingToolbarVerticalFabPosition,
    val animationSpec: FiniteAnimationSpec<Float>,
    val expandedShadowElevation: Dp,
    val collapsedShadowElevation: Dp,
    val content: @Composable ColumnScope.() -> Unit,
)

Parameters available to VerticalFloatingToolbar that includes a floating action button (FAB).

Parameters


isExpanded	whether the floating toolbar is expanded or not. In its expanded state, the FAB and the toolbar content are organized horizontally. Otherwise, only the FAB is visible. Note that the toolbar will stay expanded in case a touch exploration service (e.g., TalkBack) is active.
floatingActionButton	a floating action button to be displayed by the toolbar. It's recommended to use a `FloatingToolbarDefaults.VibrantFloatingActionButton` or `FloatingToolbarDefaults.StandardFloatingActionButton` that is styled to match the `colors`. Note that the provided FAB's size is controlled by the floating toolbar and animates according to its state. In case a custom FAB is provided, make sure it's set with a `Modifier.fillMaxSize` to be sized correctly.
modifier	the `Modifier` to be applied to this floating toolbar.
colors	the colors used for this floating toolbar. There are two predefined `FloatingToolbarColors` at `FloatingToolbarDefaults.standardFloatingToolbarColors` and `FloatingToolbarDefaults.vibrantFloatingToolbarColors` which you can use or modify. See also `floatingActionButton` for more information on the right FAB to use for proper styling.
contentPadding	the padding applied to the content of this floating toolbar.
scrollBehavior	a `FloatingToolbarScrollBehavior`. If provided, this FloatingToolbar will automatically react to scrolling. If your toolbar is positioned along a center edge of the screen (like top or bottom center), it's best to use this scroll behavior to make the entire toolbar scroll off-screen as the user scrolls. This would prevent the FAB from appearing off-center, which may occur in this case when using the `isExpanded` flag to simply expand or collapse the toolbar. Note that the toolbar will not react to scrolling in case a touch exploration service (e.g., TalkBack) is active.
shape	the shape used for this floating toolbar content.
floatingActionButtonPosition	the position of the floating toolbar's floating action button. By default, the FAB is placed at the end of the toolbar (i.e. aligned to the right in left-to-right layout, or to the left in right-to-left layout).
animationSpec	the animation spec to use for this floating toolbar expand and collapse animation.
expandedShadowElevation	the elevation for the shadow below this floating toolbar when expanded.
collapsedShadowElevation	the elevation for the shadow below this floating toolbar when collapsed.
content	the main content of this floating toolbar. The default layout here is a `Row`, so content inside will be placed horizontally.