circuit-foundation/com.slack.circuit.foundation.navstack/SaveableNavStack

SaveableNavStack

class SaveableNavStack : NavStack<SaveableNavStack.Record> , Iterable<SaveableNavStack.Record> (source)

A NavStack that supports saving its state via rememberSaveable. See rememberSaveableNavStack.

This implementation supports forward navigation, removal in both directions, and moving through the stack without removing entries.

Constructors

SaveableNavStack

constructor(root: Screen)

constructor(root: SaveableNavStack.Record)

Types

Companion

object Companion

Record

data class Record(val screen: Screen, val key: String = Uuid.random().toString()) : NavStack.Record

SaveableNavStackList

data class SaveableNavStackList(val entries: List<SaveableNavStack.Record>, val currentIndex: Int) : NavStackList<SaveableNavStack.Record>

Properties

currentRecord

open override val currentRecord: SaveableNavStack.Record?

rootRecord

open override val rootRecord: SaveableNavStack.Record?

size

open override val size: Int

topRecord

open override val topRecord: SaveableNavStack.Record?

Functions

backward

open override fun backward(): Boolean

containsRecord

open override fun containsRecord(record: SaveableNavStack.Record, includeSaved: Boolean): Boolean

forward

open override fun forward(): Boolean

isRecordReachable

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

iterator

open operator override fun iterator(): Iterator<SaveableNavStack.Record>

peekState

open override fun peekState(): List<Screen>

pop

open override fun pop(): SaveableNavStack.Record?

popUntil

open fun popUntil(predicate: (SaveableNavStack.Record) -> Boolean): List<SaveableNavStack.Record>

push

open override fun push(record: SaveableNavStack.Record): Boolean

open override fun push(screen: Screen): Boolean

removeState

open override fun removeState(screen: Screen): Boolean

restoreState

open override fun restoreState(screen: Screen): Boolean

saveState

open override fun saveState()

snapshot

open override fun snapshot(): NavStackList<SaveableNavStack.Record>?