navease-runtime/io.github.alimsrepo.navease.internal.runtime/NavBackStack

NavBackStack

@Serializable(with = NavBackStackSerializer::class)

class NavBackStack<T : NavKey>(base: SnapshotStateList<T>) : MutableList<T> , StateObject, RandomAccess

A mutable back stack of NavKey elements that integrates with Compose state.

This class wraps a SnapshotStateList so that updates to the stack automatically trigger recomposition in any observing Composables. It also implements StateObject, which allows it to participate in Compose's snapshot system directly.

Typically, you won’t construct a NavBackStack manually. Instead, prefer using rememberNavBackStack, which provides a stack that is automatically saved and restored across process death and configuration changes.

Example

val backStack = NavBackStack(Home("start"))
backStack += Details("item42") // pushes onto stack
backStack.removeLast()         // pops stack

Samples

androidx.navigation3.runtime.samples.NavBackStack_OpenPolymorphismandroidx.navigation3.runtime.samples.NavBackStack_ClosedPolymorphism

Constructors

NavBackStack

constructor(base: SnapshotStateList<T>)

Creates a new back stack backed by the provided SnapshotStateList.

constructor()

constructor(vararg elements: T)

Properties

firstStateRecord

open override val firstStateRecord: StateRecord

size

open override val size: Int

Functions

add

@IgnorableReturnValue

open override fun add(element: T): Boolean

open override fun add(index: Int, element: T)

addAll

@IgnorableReturnValue

open override fun addAll(elements: Collection<T>): Boolean

@IgnorableReturnValue

open override fun addAll(index: Int, elements: Collection<T>): Boolean

clear

open override fun clear()

contains

open operator override fun contains(element: T): Boolean

containsAll

open override fun containsAll(elements: Collection<T>): Boolean

get

open operator override fun get(index: Int): T

indexOf

open override fun indexOf(element: T): Int

isEmpty

open override fun isEmpty(): Boolean

iterator

open operator override fun iterator(): MutableIterator<T>

lastIndexOf

open override fun lastIndexOf(element: T): Int

listIterator

open override fun listIterator(): MutableListIterator<T>

open override fun listIterator(index: Int): MutableListIterator<T>

mergeRecords

open override fun mergeRecords(previous: StateRecord, current: StateRecord, applied: StateRecord): StateRecord?

prependStateRecord

open override fun prependStateRecord(value: StateRecord)

remove

@IgnorableReturnValue

open override fun remove(element: T): Boolean

removeAll

@IgnorableReturnValue

open override fun removeAll(elements: Collection<T>): Boolean

removeAt

@IgnorableReturnValue

open override fun removeAt(index: Int): T

retainAll

@IgnorableReturnValue

open override fun retainAll(elements: Collection<T>): Boolean

set

@IgnorableReturnValue

open operator override fun set(index: Int, element: T): T

subList

open override fun subList(fromIndex: Int, toIndex: Int): MutableList<T>

NavBackStack

Example

See also

Samples

Constructors

Properties

Functions