Update documentation

vmanot · vmanot · commit fe9fca48bdeb · 2022-05-01T22:49:57.000+05:30
diff --git a/Sources/Intramodular/Navigation/Navigator.swift b/Sources/Intramodular/Navigation/Navigator.swift
@@ -43,6 +43,11 @@ extension EnvironmentValues {
         }
     }
 
+    /// Encapsulated access to a navigation controller, if present.
+    ///
+    /// To resolve this environment value:
+    /// - You must add `._resolveAppKitOrUIKitViewControllerIfAvailable()` _outside_ of the view using this via `@Environment(\.navigator)`. This allows SwiftUIX to introspect, grab and provide the nearest `UINavigationController` at runtime.
+    /// - There must be a navigation view present in the view hierarchy. Without a navigation view, this property will always be `nil`.
     public var navigator: Navigator? {
         get {
             self[NavigatorEnvironmentKey.self]

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,11 @@ extension EnvironmentValues {`
`43`	`43`	`}`
`44`	`44`	`}`
`45`	`45`
	`46`	`+ /// Encapsulated access to a navigation controller, if present.`
	`47`	`+ ///`
	`48`	`+ /// To resolve this environment value:`
	`49`	+ /// - You must add `._resolveAppKitOrUIKitViewControllerIfAvailable()` _outside_ of the view using this via `@Environment(\.navigator)`. This allows SwiftUIX to introspect, grab and provide the nearest `UINavigationController` at runtime.
	`50`	+ /// - There must be a navigation view present in the view hierarchy. Without a navigation view, this property will always be `nil`.
`46`	`51`	`public var navigator: Navigator? {`
`47`	`52`	`get {`
`48`	`53`	`self[NavigatorEnvironmentKey.self]`