# rememberNavigationEventState

Common/All

## Functions summary

|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigationevent/compose/NavigationEventState<https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneInfo<T>>` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable <T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html> https://developer.android.com/reference/kotlin/androidx/navigation3/scene/rememberNavigationEventState.composable#rememberNavigationEventState(androidx.navigation3.scene.SceneState)(sceneState: https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneState<T>)` Remembers and returns a `https://developer.android.com/reference/kotlin/androidx/navigationevent/compose/NavigationEventState` instance for a `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneState`. | Cmn |

## Functions

### rememberNavigationEventState

Cmn Artifact: [androidx.navigation3:navigation3-ui](https://developer.android.com/jetpack/androidx/releases/navigation3) [View Source](https://cs.android.com/search?q=file:androidx/navigation3/scene/RememberNavigationEventState.kt+function:rememberNavigationEventState) Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/navigation3#1.2.0)

```
@Composable
fun <T : Any> rememberNavigationEventState(sceneState: SceneState<T>): NavigationEventState<SceneInfo<T>>
```

Remembers and returns a `https://developer.android.com/reference/kotlin/androidx/navigationevent/compose/NavigationEventState` instance for a `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneState`.

This composable creates and remembers a `https://developer.android.com/reference/kotlin/androidx/navigationevent/compose/NavigationEventState` object, which holds a `https://developer.android.com/reference/kotlin/androidx/navigationevent/compose/NavigationEventHandler.composable#NavigationEventHandler(androidx.navigationevent.compose.NavigationEventState,kotlin.Boolean,kotlin.Function0,kotlin.Function0,kotlin.Boolean,kotlin.Function0,kotlin.Function0)` internally. This is the state object that can be passed to `https://developer.android.com/reference/kotlin/androidx/navigationevent/compose/NavigationBackHandler.composable#NavigationBackHandler(androidx.navigationevent.compose.NavigationEventState,kotlin.Boolean,kotlin.Function0,kotlin.Function0)` (the composable) to "hoist" the state.

The state's handler info (currentInfo and backInfo) is kept in sync with the provided `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/package-summary#rememberNavigationEventState(androidx.navigation3.scene.SceneState)`.

| Parameters |
|---|---|
| `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html>` | the type of the key in the `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneState`. |
| `sceneState: https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneState<T>` | the `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneState` that this state will track. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigationevent/compose/NavigationEventState<https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneInfo<T>>` | a stable, remembered `https://developer.android.com/reference/kotlin/androidx/navigationevent/compose/NavigationEventState` instance. |