jchucomponents-ui/com.jeluchu.jchucomponents.ui.composables.structures/ScaffoldStates

ScaffoldStates

@Composable
fun <T> ScaffoldStates(modifier: Modifier = Modifier, scaffoldState: ScaffoldState = rememberScaffoldState(), topBar: @Composable () -> Unit = {}, bottomBar: @Composable () -> Unit = {}, snackbarHost: @Composable (SnackbarHostState) -> Unit = { SnackbarHost(it) }, floatingActionButton: @Composable () -> Unit = {}, floatingActionButtonPosition: FabPosition = FabPosition.End, isFloatingActionButtonDocked: Boolean = false, backgroundColor: Color = MaterialTheme.colors.background, contentColor: Color = contentColorFor(backgroundColor), isLoading: Boolean = false, items: List<T> = emptyList(), onSuccess: @Composable (PaddingValues, List<T>) -> Unit, onFailed: @Composable (PaddingValues) -> Unit = {}, onLoading: @Composable (PaddingValues) -> Unit = {})

Author: @Jeluchu

This component is useful to check the status of a response to a request to the service, and depending on the result it can display information, an error or the loading progress

Parameters

modifier

optional Modifier for the root of the Scaffold

scaffoldState

state of this scaffold widget. It contains the state of the screen, e.g. variables to provide manual control over the drawer behavior, sizes of components, etc

topBar

top app bar of the screen. Consider using TopAppBar.

bottomBar

bottom bar of the screen. Consider using BottomAppBar.

snackbarHost

component to host Snackbars that are pushed to be shown via SnackbarHostState.showSnackbar. Usually it's a SnackbarHost

floatingActionButton

Main action button of your screen. Consider using FloatingActionButton for this slot.

floatingActionButtonPosition

position of the FAB on the screen. See FabPosition for possible options available.

isFloatingActionButtonDocked

whether floatingActionButton should overlap with bottomBar for half a height, if bottomBar exists. Ignored if there's no bottomBar or no floatingActionButton.

backgroundColor

background of the scaffold body

contentColor

color of the content in scaffold body. Defaults to either the matching content color for backgroundColor, or, if it is not a color from the theme, this will keep the same value set above this Surface.

isLoading

controls the status of whether the request to the service is loading or has already finished.

items

the list of items to be displayed within the LazyColumn or LazyRow

onSuccess

content when service response is success of your screen. The lambda receives an PaddingValues that should be applied to the content root via Modifier.padding to properly offset top and bottom bars. If you're using VerticalScroller, apply this modifier to the child of the scroller, and not on the scroller itself.

onFailed

content when service response is failed of your screen. The lambda receives an PaddingValues that should be applied to the content root via Modifier.padding to properly offset top and bottom bars. If you're using VerticalScroller, apply this modifier to the child of the scroller, and not on the scroller itself.

onLoading

content when service response is loading of your screen. The lambda receives an PaddingValues that should be applied to the content root via Modifier.padding to properly offset top and bottom bars. If you're using VerticalScroller, apply this modifier to the child of the scroller, and not on the scroller itself.