circuit-runtime/com.slack.circuit.runtime

Package-level declarations

Types

Link copied to clipboard
class CircuitContext constructor(val parent: CircuitContext?, tags: MutableMap<KClass<*>, Any> = mutableMapOf())

A CircuitContext is used in Presenter.Factory and Ui.Factory to inform creation of their respective Presenter and Ui instances.

Link copied to clipboard
@Immutable
interface CircuitUiEvent

Marker interface for all UiEvent types.

Link copied to clipboard
@Stable
interface CircuitUiState

Marker interface for all UiState types.

Link copied to clipboard
@Stable
interface GoToNavigator

A Navigator that only supports goTo.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.TYPEALIAS, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR])
annotation class InternalCircuitApi

Marks declarations that are internal in Circuit API, which means that should not be used outside of com.slack.circuit, because their signatures and semantics will change between future releases without any warnings and without providing any migration aids.

Link copied to clipboard
@Stable
interface Navigator : GoToNavigator

A basic navigation interface for navigating between screens.

Functions

Link copied to clipboard
fun Navigator.popRoot(result: PopResult? = null)

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

Link copied to clipboard
fun Navigator.popUntil(predicate: (Screen) -> Boolean)

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

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

Clear the existing backstack of screens and navigate to newRoot.