gleam-navigation/dev.teogor.gleam.navigation

Package-level declarations

Types

class GleamNavigator(gleamState: GleamState) : Navigator<GleamNavigator.Destination>

Navigator that drives a GleamState for use with GleamScaffolds within the navigation library. Every destination using this Navigator must set a valid Composable by defining it directly on an instantiated Destination or calling gleam.

GleamNavigatorState

@Stable

class GleamNavigatorState(gleamState: GleamState)

The state of a GleamScaffold driven by the GleamNavigator.

Functions

gleam

fun NavGraphBuilder.gleam(route: String, arguments: List<NamedNavArgument> = emptyList(), deepLinks: List<NavDeepLink> = emptyList(), content: @Composable ColumnScope.(backstackEntry: NavBackStackEntry) -> Unit)

Add the content as gleam content to the NavGraphBuilder

GleamScaffold

@Composable

fun GleamScaffold(navigator: GleamNavigator, modifier: Modifier = Modifier, gleamMaxWidth: Dp = GleamDefaults.GleamMaxWidth, shape: Shape = GleamDefaults.ExpandedShape, containerColor: Color = GleamDefaults.ContainerColor, contentColor: Color = contentColorFor(containerColor), tonalElevation: Dp = GleamDefaults.Elevation, scrimColor: Color = GleamDefaults.ScrimColor, dragHandle: @Composable () -> Unit? = { GleamDefaults.DragHandle() }, windowInsets: WindowInsets = GleamDefaults.windowInsets, properties: GleamProperties = GleamDefaults.properties(), content: @Composable () -> Unit)

Helper function to create a GleamScaffold from a GleamNavigator.

provideNavController

fun GleamNavigator.provideNavController(navController: NavHostController): GleamNavigator

Associates a NavHostController with this GleamNavigator, enabling navigation using Gleam composables.

rememberGleamNavigator

@Composable

fun rememberGleamNavigator(): GleamNavigator

Creates and remembers a GleamNavigator for use with Gleam navigations.