# rememberNavigationEventState

Common/AllAndroid/JVMNative/C/iOS

## Functions summary

|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigationevent/compose/NavigationEventState<T>` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable <T : https://developer.android.com/reference/kotlin/androidx/navigationevent/NavigationEventInfo> https://developer.android.com/reference/kotlin/androidx/navigationevent/compose/rememberNavigationEventState.composable#rememberNavigationEventState(androidx.navigationevent.NavigationEventInfo,kotlin.collections.List,kotlin.collections.List)( currentInfo: T, backInfo: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<T>, forwardInfo: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<T> )` Remembers and returns a `https://developer.android.com/reference/kotlin/androidx/navigationevent/compose/NavigationEventState` instance. | Cmn |

## Functions

### rememberNavigationEventState

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

```
@Composable
fun <T : NavigationEventInfo> rememberNavigationEventState(
    currentInfo: T,
    backInfo: List<T> = emptyList(),
    forwardInfo: List<T> = emptyList()
): NavigationEventState<T>
```

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

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/NavigationEventHandler.composable#NavigationEventHandler(androidx.navigationevent.compose.NavigationEventState,kotlin.Boolean,kotlin.Function0,kotlin.Function0,kotlin.Boolean,kotlin.Function0,kotlin.Function0)` (the composable) to "hoist" the state.

The state's handler info (currentInfo, backInfo, forwardInfo) is kept in sync with the provided parameters via a `https://developer.android.com/reference/kotlin/androidx/compose/runtime/SideEffect.composable#SideEffect(kotlin.Function0)`.

| Parameters |
|---|---|
| `<T : https://developer.android.com/reference/kotlin/androidx/navigationevent/NavigationEventInfo>` | The type of `https://developer.android.com/reference/kotlin/androidx/navigationevent/NavigationEventInfo` this state will manage. |
| `currentInfo: T` | The object representing the current destination. |
| `backInfo: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<T> = emptyList()` | A list of destinations the user may navigate back to (nearest-first). |
| `forwardInfo: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<T> = emptyList()` | A list of destinations the user may navigate forward to (nearest-first). |

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