circuit-foundation/com.slack.circuit.foundation/NavEvent

NavEvent

sealed interface NavEvent : CircuitUiEvent(source)

A sealed navigation interface intended to be used when making a navigation callback.

Inheritors

Types

data object Backward : NavEvent

Corresponds to Navigator.backward.

data object Forward : NavEvent

Corresponds to Navigator.forward.

data class GoTo(val screen: Screen) : NavEvent

Corresponds to Navigator.goTo.

data class Pop(val result: PopResult? = null) : NavEvent

Corresponds to Navigator.pop.

data class ResetRoot(val newRoot: Screen, val options: Navigator.StateOptions) : NavEvent

Corresponds to Navigator.resetRoot.