backstack/com.slack.circuit.backstack/BackStack

BackStack

interface BackStack<R : BackStack.Record> : NavStack<R> , Iterable<R> (source)

A caller-supplied stack of Records for presentation with a Navigator. Iteration order is top-first (first element is the top of the stack).

BackStack extends NavStack but is intended for push or pop only navigation patterns. Implementations may provide no-op implementations for forward navigation methods.

Inheritors

SaveableBackStack

Types

Record

@Stable

interface Record : NavStack.Record

Properties

currentRecord

open override val currentRecord: R?

isAtRoot

val BackStack<out BackStack.Record>.isAtRoot: Boolean

true if the BackStack contains exactly one record.

isEmpty

val BackStack<out BackStack.Record>.isEmpty: Boolean

true if the BackStack contains no records. Iterable.firstOrNull will return null.

rootRecord

abstract val rootRecord: R?

size

abstract val size: Int

topRecord

abstract val topRecord: R?

Functions

backward

open override fun backward(): Boolean

Backward navigation is not supported by the BackStack as you are unable to go forward again.

clearState

fun BackStack<out BackStack.Record>.clearState()

Clear any saved state from the BackStack.

containsRecord

abstract fun containsRecord(record: R, includeSaved: Boolean): Boolean

forward

open override fun forward(): Boolean

Forward navigation is not supported by the BackStack.

isRecordReachable

abstract fun isRecordReachable(key: String, depth: Int, includeSaved: Boolean): Boolean

iterator

abstract operator fun iterator(): Iterator<R>

peekState

abstract fun peekState(): List<Screen>

pop

abstract fun pop(): R?

popUntil

open fun popUntil(predicate: (R) -> Boolean): List<R>

push

abstract fun push(record: R): Boolean

abstract fun push(screen: Screen): Boolean

removeState

abstract fun removeState(screen: Screen): Boolean

restoreState

abstract fun restoreState(screen: Screen): Boolean

saveState

abstract fun saveState()

snapshot

open override fun snapshot(): NavStackList<R>?