@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "This is an experimental Circuit API that may be changed or removed at any time. This usually means it's under active development or incubation, please report any feedback on the issue tracker.")

annotation class ExperimentalCircuitApi

GoToNavigator

@Stable

interface GoToNavigator

A minimal navigation interface that only supports forward navigation via goTo.

InternalCircuitApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.TYPEALIAS, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR])

@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "This is an internal Circuit API that should not be used from outside of com.slack.circuit. No compatibility guarantees are provided. It is recommended to report your use-case of internal API to Circuit issue tracker, so a stable API could be provided instead")

annotation class InternalCircuitApi

Marks declarations that are internal in Circuit's API, meaning that they should not be used outside of Circuit's first party API. This is their signatures and semantics will change between future releases without any warnings and without providing any migration aids.

Navigator

@Stable

interface Navigator : GoToNavigator

A basic navigation interface for navigating between screens.

Functions

answeringNavigationAvailable

@Composable

fun answeringNavigationAvailable(): Boolean

Returns whether answering navigation is available in the current composition.

popRoot

fun Navigator.popRoot(result: PopResult? = null)

Pop the Navigator as if this was the root Navigator.pop call.

popUntil

fun Navigator.popUntil(predicate: (Screen) -> Boolean)

Calls Navigator.pop until the given predicate is matched or it pops the root.

rememberAnsweringNavigator

@Composable

inline fun <T : PopResult> rememberAnsweringNavigator(fallbackNavigator: Navigator, noinline block: (result: T) -> Unit): GoToNavigator

Returns a GoToNavigator that receives a T when its destination returns one, or fallbackNavigator when answering navigation is unavailable.

@Composable

fun <T : PopResult> rememberAnsweringNavigator(fallbackNavigator: Navigator, resultType: KClass<T>, block: (result: T) -> Unit): GoToNavigator

Returns a GoToNavigator that receives a resultType when its destination returns one, or fallbackNavigator when answering navigation is unavailable.

resetRoot

fun Navigator.resetRoot(newRoot: Screen, saveState: Boolean = false, restoreState: Boolean = false, clearState: Boolean = false): List<Screen>

Parameter based alternate for Navigator.resetRoot.

inline fun Navigator.resetRoot(newRoot: Screen, saveState: (currentRoot: Screen?) -> Boolean = { false }, restoreState: (currentRoot: Screen?) -> Boolean = { false }, clearState: (currentRoot: Screen?) -> Boolean = { false }): List<Screen>

Clear the existing backstack of screens and navigate to newRoot.