NavigationPath

struct · iOS 16.0+ · SDK 27.1

struct NavigationPath

A type-erased list of data representing the content of a navigation stack. You can manage the state of a ``NavigationStack`` by initializing the stack with a binding to a collection of data. The stack stores data items in the collection for each view on the stack. You also can read and write the collection to observe and alter the stack's state. When a stack displays views that rely on only one kind of data, you can use a standard collection, like an array, to hold the data. If you need to present different kinds of data in a single stack, use a navigation path instead. The path uses type erasure so you can manage a collection of heterogeneous elements. The path also provides the usual collection controls for adding, counting, and removing data elements. ### Serialize the path When the values you present on the navigation stack conform to the <doc://com.apple.documentation/documentation/Swift/Codable> protocol, you can use the path's ``codable`` property to get a serializable representation of the path. Use that representation to save and restore the contents of the stack. For example, you can define an <doc://com.apple.documentation/documentation/Combine/ObservableObject> that handles serializing and deserializing the path: class MyModelObject: ObservableObject { @Published var path: NavigationPath static func readSerializedData() -> Data? { // Read data representing the path from app's persistent storage. } static func writeSerializedData(_ data: Data) { // Write data representing the path to app's persistent storage. } init() { if let data = Self.readSerializedData() { do { let representation = try JSONDecoder().decode( NavigationPath.CodableRepresentation.self, from: data) self.path = NavigationPath(representation) } catch { self.path = NavigationPath() } } else { self.path = NavigationPath() } } func save() { guard let representation = path.codable else { return } do { let encoder = JSONEncoder() let data = try encoder.encode(representation) Self.writeSerializedData(data) } catch { // Handle error. } } } Then, using that object in your view, you can save the state of the navigation path when the ``Scene`` enters the ``ScenePhase/background`` state: @StateObject private var pathState = MyModelObject() @Environment(\.scenePhase) private var scenePhase var body: some View { NavigationStack(path: $pathState.path) { // Add a root view here. } .onChange(of: scenePhase) { phase in if phase == .background { pathState.save() } } }

Members (10)

removeLast(k?: number): void

mutating func removeLast(_ k: Int = 1)

get count(): number

var count: Int { get }

append(value: number): void

mutating func append<V>(_ value: V) where V : Hashable

append68641(value: number): void

mutating func append<V>(_ value: V) where V : Decodable, V : Encodable, V : Hashable

get codable(): (NavigationPath_CodableRepresentation) | null

var codable: NavigationPath.CodableRepresentation? { get }

get isEmpty(): boolean

var isEmpty: Bool { get }

static init(): NavigationPath

init()

static init69647(codable: NavigationPath_CodableRepresentation): NavigationPath

init(_ codable: NavigationPath.CodableRepresentation)

static init63331(elements: Array<number>): NavigationPath

init<S>(_ elements: S) where S : Sequence, S.Element : Hashable

static init39645(elements: Array<number>): NavigationPath

init<S>(_ elements: S) where S : Sequence, S.Element : Decodable, S.Element : Encodable, S.Element : Hashable

All SwiftUI types →