androidx.navigationevent.compose

Classes

NavigationEventState

This class serves as the Compose-layer adapter for the navigation event system.

Cmn

Objects

LocalNavigationEventDispatcherOwner

The CompositionLocal containing the current NavigationEventDispatcher.

Cmn

Composables

NavigationBackHandler

A composable that handles only back navigation gestures, driven by a manually hoisted NavigationEventState.

Cmn
NavigationEventHandler

A composable that handles navigation events using simple lambda handlers, driven by a manually hoisted NavigationEventState.

Cmn
NavigationForwardHandler

A composable that handles only forward navigation gestures, driven by a manually hoisted NavigationEventState.

Cmn
rememberNavigationEventDispatcherOwner

Remembers a new NavigationEventDispatcherOwner which creates a dispatcher linked to a parent dispatcher found in the composition.

Cmn
rememberNavigationEventState

Remembers and returns a NavigationEventState instance.

Cmn

Top-level properties summary

HostDefaultKey<NavigationEventDispatcherOwner?>

A HostDefaultKey used to retrieve the NavigationEventDispatcherOwner provided by the current hosting environment.

Cmn
android
N

Top-level properties

val NavigationEventDispatcherOwnerHostDefaultKeyHostDefaultKey<NavigationEventDispatcherOwner?>

A HostDefaultKey used to retrieve the NavigationEventDispatcherOwner provided by the current hosting environment.

This key allows the composition to access the host's NavigationEventDispatcherOwner through a decoupled mechanism, typically used by compositionLocalWithHostDefaultOf.

On platforms where a NavigationEventDispatcherOwner is not present or supported, this may resolve to null.