gleam-navigation/dev.teogor.gleam.navigation/GleamNavigator

GleamNavigator

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.

Key behavior:

The gleamContent always displays the latest entry from the back stack.
Navigating between Gleam destinations replaces the current content instead of creating a new gleam.
Dismissing the Gleam via user interaction pops the latest entry from the state's back stack.

Public Usage:

Use rememberGleamNavigator to create and access a GleamNavigator instance in your composables. This function handles memory management and ensures consistent usage throughout your application.

Parameters

gleamState

The GleamState that the GleamNavigator will control.

Constructors

constructor(gleamState: GleamState)

Types

class Destination(navigator: GleamNavigator, content: @Composable ColumnScope.(NavBackStackEntry) -> Unit) : NavDestination, FloatingWindow

NavDestination specific to GleamNavigator

Properties

val gleamContent: @Composable ColumnScope.() -> Unit

A Composable function that hosts the current gleam content. This should be set as gleamContent of your GleamScaffold.

var isAttached: Boolean

@get:Composable

val isVisible: Boolean

Determines the overall visibility state of the Gleam content.

navigatorGleamState

val navigatorGleamState: GleamNavigatorState

Access properties of the GleamScaffold's GleamState

shouldBeVisible

@get:Composable

val shouldBeVisible: Boolean

Determines whether the current navigation state should be visible based on the back stack.

Functions

createDestination

open override fun createDestination(): GleamNavigator.Destination

open fun navigate(destination: GleamNavigator.Destination, args: Bundle?, navOptions: NavOptions?, navigatorExtras: Navigator.Extras?): NavDestination?

open override fun navigate(entries: List<NavBackStackEntry>, navOptions: NavOptions?, navigatorExtras: Navigator.Extras?)

open override fun onAttach(state: NavigatorState)

onLaunchSingleTop

open fun onLaunchSingleTop(backStackEntry: NavBackStackEntry)

open fun onRestoreState(savedState: Bundle)

open fun onSaveState(): Bundle?

open fun popBackStack(): Boolean

open override fun popBackStack(popUpTo: NavBackStackEntry, savedState: Boolean)

provideNavController

fun GleamNavigator.provideNavController(navController: NavHostController): GleamNavigator

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