feat: resolve navigation page on navigation event (nativescript-vue#624)

farfromrefug · web-flow · commit 787d1a5547f6 · 2020-04-11T22:58:35.000+02:00
Allow passing in `resolveOnEvent`  (`navigatingTo` or `navigatedTo`) to `$navigateTo` options. When passed, an event listener will be attached to the page element, and whenever it fires - the Promise returned from `$navigateTo` will be resolved with the target `Page`. Useful for for triggering actions after a navigation is complete.
diff --git a/index.d.ts b/index.d.ts
@@ -9,7 +9,8 @@ export type NativeScriptVueItemEventData<T> = ItemEventData & { item: T }
 
 export interface NavigationEntryVue extends NavigationEntry {
     props?: Record<string, any>,
-    frame?: any
+    frame?: any,
+    resolveOnEvent?: Page.navigatingToEvent | Page.navigatedToEvent
 }
 
 export type navigateTo = (
diff --git a/platform/nativescript/plugins/navigator-plugin.js b/platform/nativescript/plugins/navigator-plugin.js
@@ -89,6 +89,10 @@ export default {
 
         updateDevtools()
 
+        const resolveOnEvent = options.resolveOnEvent
+        // ensure we dont resolve twice event though this should never happen!
+        let resolved = false
+
         const handler = args => {
           if (args.isBackNavigation) {
             page.off('navigatedFrom', handler)
@@ -97,6 +101,17 @@ export default {
         }
         page.on('navigatedFrom', handler)
 
+        if (resolveOnEvent) {
+          const resolveHandler = args => {
+            if (!resolved) {
+              resolved = true
+              resolve(page)
+            }
+            page.off(resolveOnEvent, resolveHandler)
+          }
+          page.on(resolveOnEvent, resolveHandler)
+        }
+
         // ensure that the navEntryInstance vue instance is destroyed when the
         // page is disposed (clearHistory: true for example)
         const dispose = page.disposeNativeView
@@ -106,7 +121,10 @@ export default {
         }
 
         frame.navigate(Object.assign({}, options, { create: () => page }))
-        resolve(page)
+        if (!resolveOnEvent) {
+          resolved = true
+          resolve(page)
+        }
       })
     }
   }

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,8 @@ export type NativeScriptVueItemEventData<T> = ItemEventData & { item: T }`
`9`	`9`
`10`	`10`	`export interface NavigationEntryVue extends NavigationEntry {`
`11`	`11`	`props?: Record<string, any>,`
`12`		`- frame?: any`
	`12`	`+ frame?: any,`
	`13`	`+ resolveOnEvent?: Page.navigatingToEvent \| Page.navigatedToEvent`
`13`	`14`	`}`
`14`	`15`
`15`	`16`	`export type navigateTo = (`