Package 

Class ScaffoldKt

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private final static ProvidableCompositionLocal<PaddingValues> LocalScaffoldPadding

    • Method Summary

      Modifier and Type Method Description
      final ProvidableCompositionLocal<PaddingValues> getLocalScaffoldPadding() Provides the current Scaffold content padding values.
      final static Unit Scaffold(Modifier modifier, ScaffoldState scaffoldState, Function0<Unit> topBar, Function0<Unit> bottomBar, Function1<SnackbarHostState, Unit> snackbarHost, Function0<Unit> floatingActionButton, FabPosition floatingActionButtonPosition, Boolean isFloatingActionButtonDocked, Function1<ColumnScope, Unit> drawerContent, Boolean drawerGesturesEnabled, Shape drawerShape, Dp drawerElevation, Color drawerBackgroundColor, Color drawerContentColor, Color drawerScrimColor, Color backgroundColor, Color contentColor, PaddingValues contentPadding, Function1<PaddingValues, Unit> content) A copy of androidx.compose.material.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getLocalScaffoldPadding

         final ProvidableCompositionLocal<PaddingValues> getLocalScaffoldPadding()

        Provides the current Scaffold content padding values.

      • Scaffold

        @Deprecated(message = 
        accompanist/insets-ui has been deprecated.
        This functionality has been upstreamed to Material.
        For more migration information, please visit https://google.github.io/accompanist/insets/#migration
    )@Composable() final static Unit Scaffold(Modifier modifier, ScaffoldState scaffoldState, Function0<Unit> topBar, Function0<Unit> bottomBar, Function1<SnackbarHostState, Unit> snackbarHost, Function0<Unit> floatingActionButton, FabPosition floatingActionButtonPosition, Boolean isFloatingActionButtonDocked, Function1<ColumnScope, Unit> drawerContent, Boolean drawerGesturesEnabled, Shape drawerShape, Dp drawerElevation, Color drawerBackgroundColor, Color drawerContentColor, Color drawerScrimColor, Color backgroundColor, Color contentColor, PaddingValues contentPadding, Function1<PaddingValues, Unit> content)

        A copy of androidx.compose.material.Scaffold which lays out content behind both the top bar content, and the bottom bar content. See androidx.compose.material.Scaffold for more information about the features provided.

        A sample which demonstrates how to use this layout to achieve a edge-to-edge layout is below:

        Parameters:
        modifier - optional Modifier for the root of the Scaffold
        scaffoldState - state of this scaffold widget.
        topBar - top app bar of the screen.
        bottomBar - bottom bar of the screen.
        snackbarHost - component to host Snackbars that are pushed to be shown via SnackbarHostState.showSnackbar.
        floatingActionButton - Main action button of your screen.
        floatingActionButtonPosition - position of the FAB on the screen.
        isFloatingActionButtonDocked - whether floatingActionButton should overlap with bottomBar for half a height, if bottomBar exists.
        drawerContent - content of the Drawer sheet that can be pulled from the left side (right for RTL).
        drawerGesturesEnabled - whether or not drawer (if set) can be interacted with via gestures
        drawerShape - shape of the drawer sheet (if set)
        drawerElevation - drawer sheet elevation.
        drawerBackgroundColor - background color to be used for the drawer sheet
        drawerContentColor - color of the content to use inside the drawer sheet.
        drawerScrimColor - color of the scrim that obscures content when the drawer is open
        backgroundColor - background of the scaffold body
        contentColor - color of the content in scaffold body.
        contentPadding - Additional content padding to apply to the content.
        content - content of your screen.