@tarojs/router 3.6.7 → 3.6.9-alpha.1

package/dist/events/scroll.d.ts

@@ -1,2 +1,2 @@
 import { PageInstance } from '@tarojs/runtime';
-export declare function bindPageScroll(page: PageInstance, pageEl: HTMLElement, distance?: number): void;
+export declare function bindPageScroll(page: PageInstance, scrollEl: HTMLElement | Window, distance?: number): void;

package/dist/events/scroll.js

@@ -1,11 +1,11 @@
 import { Current } from '@tarojs/runtime';
 const pageScrollFn = {};
 let pageDOM = window;
-export function bindPageScroll(page, pageEl, distance = 50) {
+export function bindPageScroll(page, scrollEl, distance = 50) {
     var _a;
     const pagePath = (page ? page === null || page === void 0 ? void 0 : page.path : (_a = Current.router) === null || _a === void 0 ? void 0 : _a.path);
-    pageScrollFn[pagePath] && pageEl.removeEventListener('scroll', pageScrollFn[pagePath]);
-    pageDOM = pageEl;
+    pageScrollFn[pagePath] && scrollEl.removeEventListener('scroll', pageScrollFn[pagePath]);
+    pageDOM = scrollEl;
     let isReachBottom = false;
     pageScrollFn[pagePath] = function () {
         var _a;

package/dist/index.cjs.js

@@ -440,11 +440,11 @@ function bindPageResize(page) {
 
 const pageScrollFn = {};
 let pageDOM = window;
-function bindPageScroll(page, pageEl, distance = 50) {
+function bindPageScroll(page, scrollEl, distance = 50) {
     var _a;
     const pagePath = (page ? page === null || page === void 0 ? void 0 : page.path : (_a = runtime.Current.router) === null || _a === void 0 ? void 0 : _a.path);
-    pageScrollFn[pagePath] && pageEl.removeEventListener('scroll', pageScrollFn[pagePath]);
-    pageDOM = pageEl;
+    pageScrollFn[pagePath] && scrollEl.removeEventListener('scroll', pageScrollFn[pagePath]);
+    pageDOM = scrollEl;
     let isReachBottom = false;
     pageScrollFn[pagePath] = function () {
         var _a;
@@ -472,6 +472,78 @@ function getOffset() {
     }
 }
 
+/**
+ * 插入页面动画需要的样式
+ */
+function loadAnimateStyle(ms = 300) {
+    const css = `
+.taro_router .taro_page {
+  position: absolute;
+  left: 0;
+  top: 0;
+  width: 100%;
+  height: 100%;
+  background-color: #fff;
+  transform: translate(100%, 0);
+  transition: transform ${ms}ms;
+  z-index: 0;
+}
+
+.taro_router .taro_page.taro_tabbar_page,
+.taro_router .taro_page.taro_page_show.taro_page_stationed {
+  transform: none;
+}
+
+.taro_router .taro_page.taro_page_show {
+  transform: translate(0, 0);
+}`;
+    addStyle(css);
+}
+/**
+ * 插入路由相关样式
+ */
+function loadRouterStyle(usingWindowScroll) {
+    const css = `
+  .taro_router {
+    overflow: hidden;
+    position: relative;
+    width: 100%;
+    height: 100%;
+    min-height: 100vh;
+  }
+
+  .taro-tabbar__container .taro_router {
+    min-height: calc(100vh - 50px);
+  }
+
+  .taro_page {
+    width: 100%;
+    height: 100%;
+  ${usingWindowScroll ? '' : `
+    overflow-x: hidden;
+    overflow-y: scroll;
+    max-height: 100vh;
+  `}
+  }
+
+  .taro-tabbar__container .taro-tabbar__panel {
+    overflow: hidden;
+  }
+
+  .taro-tabbar__container .taro_page.taro_tabbar_page {
+    max-height: calc(100vh - 50px);
+  }
+`;
+    addStyle(css);
+}
+function addStyle(css) {
+    if (!css)
+        return;
+    const style = document.createElement('style');
+    style.innerHTML = css;
+    document.getElementsByTagName('head')[0].appendChild(style);
+}
+
 // @ts-nocheck
 function initTabbar(config) {
     if (config.tabBar == null) {
@@ -532,6 +604,17 @@ class MultiPageHandler {
         return !!pagePath && this.tabBarList.some(t => t.pagePath === pagePath);
     }
     get search() { return location.search.substr(1); }
+    get usingWindowScroll() {
+        var _a;
+        let usingWindowScroll = true;
+        if (typeof ((_a = this.pageConfig) === null || _a === void 0 ? void 0 : _a.usingWindowScroll) === 'boolean') {
+            usingWindowScroll = this.pageConfig.usingWindowScroll;
+        }
+        const win = window;
+        win.__taroAppConfig || (win.__taroAppConfig = {});
+        win.__taroAppConfig.usingWindowScroll = usingWindowScroll;
+        return usingWindowScroll;
+    }
     getQuery(search = '', options = {}) {
         search = search ? `${search}&${this.search}` : this.search;
         const query = search
@@ -541,6 +624,7 @@ class MultiPageHandler {
     }
     mount() {
         setHistoryMode(this.routerMode, this.router.basename);
+        loadRouterStyle(this.usingWindowScroll);
         const appId = this.appId;
         let app = document.getElementById(appId);
         let isPosition = true;
@@ -577,7 +661,20 @@ class MultiPageHandler {
         const pageEl = this.getPageContainer(page);
         if (pageEl && !(pageEl === null || pageEl === void 0 ? void 0 : pageEl['__isReady'])) {
             const el = pageEl.firstElementChild;
-            (_a = el === null || el === void 0 ? void 0 : el['componentOnReady']) === null || _a === void 0 ? void 0 : _a.call(el);
+            const componentOnReady = el === null || el === void 0 ? void 0 : el['componentOnReady'];
+            if (componentOnReady) {
+                componentOnReady === null || componentOnReady === void 0 ? void 0 : componentOnReady().then(() => {
+                    requestAnimationFrame(() => {
+                        var _a;
+                        (_a = page.onReady) === null || _a === void 0 ? void 0 : _a.call(page);
+                        pageEl['__isReady'] = true;
+                    });
+                });
+            }
+            else {
+                (_a = page.onReady) === null || _a === void 0 ? void 0 : _a.call(page);
+                pageEl['__isReady'] = true;
+            }
             onLoad && (pageEl['__page'] = page);
         }
     }
@@ -587,11 +684,13 @@ class MultiPageHandler {
             return;
         (_a = page.onLoad) === null || _a === void 0 ? void 0 : _a.call(page, this.getQuery('', page.options), () => {
             var _a;
-            const pageEl = this.getPageContainer(page);
-            this.isTabBar && (pageEl === null || pageEl === void 0 ? void 0 : pageEl.classList.add('taro_tabbar_page'));
+            if (this.isTabBar) {
+                const pageEl = this.getPageContainer(page);
+                pageEl === null || pageEl === void 0 ? void 0 : pageEl.classList.add('taro_tabbar_page');
+            }
             this.onReady(page, true);
             (_a = page.onShow) === null || _a === void 0 ? void 0 : _a.call(page);
-            this.bindPageEvents(page, pageEl, pageConfig);
+            this.bindPageEvents(page, pageConfig);
         });
     }
     getPageContainer(page) {
@@ -605,15 +704,18 @@ class MultiPageHandler {
             ? document.querySelector(`.taro_page#${id}`)
             : document.querySelector('.taro_page') ||
                 document.querySelector('.taro_router'));
-        return el || window;
+        return el;
     }
-    bindPageEvents(page, pageEl, config = {}) {
+    getScrollingElement(page) {
+        if (this.usingWindowScroll)
+            return window;
+        return this.getPageContainer(page) || window;
+    }
+    bindPageEvents(page, config = {}) {
         var _a;
-        if (!pageEl) {
-            pageEl = this.getPageContainer();
-        }
+        const scrollEl = this.getScrollingElement(page);
         const distance = config.onReachBottomDistance || ((_a = this.config.window) === null || _a === void 0 ? void 0 : _a.onReachBottomDistance) || 50;
-        bindPageScroll(page, pageEl, distance);
+        bindPageScroll(page, scrollEl, distance);
         bindPageResize(page);
     }
 }
@@ -682,36 +784,6 @@ function createMultiRouter(app, config, framework) {
     });
 }
 
-/**
- * 插入页面动画需要的样式
- */
-function loadAnimateStyle(ms = 300) {
-    const css = `
-.taro_router .taro_page {
-  position: absolute;
-  left: 0;
-  top: 0;
-  width: 100%;
-  height: 100%;
-  background-color: #fff;
-  transform: translate(100%, 0);
-  transition: transform ${ms}ms;
-  z-index: 0;
-}
-
-.taro_router .taro_page.taro_tabbar_page,
-.taro_router .taro_page.taro_page_show.taro_page_stationed {
-  transform: none;
-}
-
-.taro_router .taro_page.taro_page_show {
-  transform: translate(0, 0);
-}`;
-    const style = document.createElement('style');
-    style.innerHTML = css;
-    document.getElementsByTagName('head')[0].appendChild(style);
-}
-
 /* eslint-disable dot-notation */
 function setDisplay(el, type = '') {
     if (el) {
@@ -797,6 +869,17 @@ class PageHandler {
         }
         return search.substring(1);
     }
+    get usingWindowScroll() {
+        var _a;
+        let usingWindowScroll = false;
+        if (typeof ((_a = this.pageConfig) === null || _a === void 0 ? void 0 : _a.usingWindowScroll) === 'boolean') {
+            usingWindowScroll = this.pageConfig.usingWindowScroll;
+        }
+        const win = window;
+        win.__taroAppConfig || (win.__taroAppConfig = {});
+        win.__taroAppConfig.usingWindowScroll = usingWindowScroll;
+        return usingWindowScroll;
+    }
     getQuery(stamp = '', search = '', options = {}) {
         search = search ? `${search}&${this.search}` : this.search;
         const query = search
@@ -807,7 +890,9 @@ class PageHandler {
     }
     mount() {
         setHistoryMode(this.routerMode, this.router.basename);
+        this.pathname = exports.history.location.pathname;
         this.animation && loadAnimateStyle(this.animationDuration);
+        loadRouterStyle(this.usingWindowScroll);
         const appId = this.appId;
         let app = document.getElementById(appId);
         let isPosition = true;
@@ -874,7 +959,8 @@ class PageHandler {
             this.isTabBar(this.pathname) && pageEl.classList.add('taro_tabbar_page');
             this.addAnimation(pageEl, pageNo === 0);
             (_a = page.onShow) === null || _a === void 0 ? void 0 : _a.call(page);
-            this.bindPageEvents(page, pageEl, pageConfig);
+            this.bindPageEvents(page, pageConfig);
+            this.triggerRouterChange();
         }
         else {
             (_b = page.onLoad) === null || _b === void 0 ? void 0 : _b.call(page, param, () => {
@@ -884,7 +970,8 @@ class PageHandler {
                 this.addAnimation(pageEl, pageNo === 0);
                 this.onReady(page, true);
                 (_a = page.onShow) === null || _a === void 0 ? void 0 : _a.call(page);
-                this.bindPageEvents(page, pageEl, pageConfig);
+                this.bindPageEvents(page, pageConfig);
+                this.triggerRouterChange();
             });
         }
     }
@@ -932,7 +1019,8 @@ class PageHandler {
             setDisplay(pageEl);
             this.addAnimation(pageEl, pageNo === 0);
             (_a = page.onShow) === null || _a === void 0 ? void 0 : _a.call(page);
-            this.bindPageEvents(page, pageEl, pageConfig);
+            this.bindPageEvents(page, pageConfig);
+            this.triggerRouterChange();
         }
         else {
             (_b = page.onLoad) === null || _b === void 0 ? void 0 : _b.call(page, param, () => {
@@ -941,7 +1029,8 @@ class PageHandler {
                 this.addAnimation(pageEl, pageNo === 0);
                 this.onReady(page, false);
                 (_a = page.onShow) === null || _a === void 0 ? void 0 : _a.call(page);
-                this.bindPageEvents(page, pageEl, pageConfig);
+                this.bindPageEvents(page, pageConfig);
+                this.triggerRouterChange();
             });
         }
     }
@@ -995,17 +1084,33 @@ class PageHandler {
             ? document.querySelector(`.taro_page#${id}`)
             : document.querySelector('.taro_page') ||
                 document.querySelector('.taro_router'));
-        return el || window;
+        return el;
     }
-    bindPageEvents(page, pageEl, config = {}) {
+    getScrollingElement(page) {
+        if (this.usingWindowScroll)
+            return window;
+        return this.getPageContainer(page) || window;
+    }
+    bindPageEvents(page, config = {}) {
         var _a;
-        if (!pageEl) {
-            pageEl = this.getPageContainer();
-        }
+        const scrollEl = this.getScrollingElement(page);
         const distance = config.onReachBottomDistance || ((_a = this.config.window) === null || _a === void 0 ? void 0 : _a.onReachBottomDistance) || 50;
-        bindPageScroll(page, pageEl, distance);
+        bindPageScroll(page, scrollEl, distance);
         bindPageResize(page);
     }
+    triggerRouterChange() {
+        /**
+         * @tarojs/runtime 中生命周期跑在 promise 中，所以这里需要 setTimeout 延迟事件调用
+         * TODO 考虑将生命周期返回 Promise，用于处理相关事件调用顺序
+         */
+        setTimeout(() => {
+            runtime.eventCenter.trigger('__afterTaroRouterChange', {
+                toLocation: {
+                    path: this.pathname
+                }
+            });
+        }, 0);
+    }
 }
 
 const createStampId = runtime.incrementId();
@@ -1039,8 +1144,10 @@ function createRouter(app, config, framework) {
     (_a = app.onLaunch) === null || _a === void 0 ? void 0 : _a.call(app, launchParam);
     app.onError && window.addEventListener('error', e => { var _a; return (_a = app.onError) === null || _a === void 0 ? void 0 : _a.call(app, e.message); });
     const render = ({ location, action }) => __awaiter(this, void 0, void 0, function* () {
-        var _c, _d, _e, _f, _g;
+        var _c, _d, _e, _f, _g, _h;
         handler.pathname = decodeURI(location.pathname);
+        if ((_c = window.__taroAppConfig) === null || _c === void 0 ? void 0 : _c.usingWindowScroll)
+            window.scrollTo(0, 0);
         runtime.eventCenter.trigger('__taroRouterChange', {
             toLocation: {
                 path: handler.pathname
@@ -1058,7 +1165,7 @@ function createRouter(app, config, framework) {
                     path: handler.pathname,
                     query: handler.getQuery(createStampId()),
                 };
-                (_c = app.onPageNotFound) === null || _c === void 0 ? void 0 : _c.call(app, notFoundEvent);
+                (_d = app.onPageNotFound) === null || _d === void 0 ? void 0 : _d.call(app, notFoundEvent);
                 runtime.eventCenter.trigger('__taroRouterNotFound', notFoundEvent);
             }
             else if (/Loading hot update .* failed./.test(error.message)) {
@@ -1072,16 +1179,16 @@ function createRouter(app, config, framework) {
         if (!element)
             return;
         const pageConfig = handler.pageConfig;
-        let enablePullDownRefresh = ((_d = config === null || config === void 0 ? void 0 : config.window) === null || _d === void 0 ? void 0 : _d.enablePullDownRefresh) || false;
+        let enablePullDownRefresh = ((_e = config === null || config === void 0 ? void 0 : config.window) === null || _e === void 0 ? void 0 : _e.enablePullDownRefresh) || false;
         if (pageConfig) {
-            setTitle((_e = pageConfig.navigationBarTitleText) !== null && _e !== void 0 ? _e : document.title);
+            setTitle((_f = pageConfig.navigationBarTitleText) !== null && _f !== void 0 ? _f : document.title);
             if (typeof pageConfig.enablePullDownRefresh === 'boolean') {
                 enablePullDownRefresh = pageConfig.enablePullDownRefresh;
             }
         }
         const currentPage = runtime.Current.page;
         const pathname = handler.pathname;
-        const methodName = (_f = stacks.method) !== null && _f !== void 0 ? _f : '';
+        const methodName = (_g = stacks.method) !== null && _g !== void 0 ? _g : '';
         const cacheTabs = stacks.getTabs();
         let shouldLoad = false;
         stacks.method = '';
@@ -1145,7 +1252,7 @@ function createRouter(app, config, framework) {
             shouldLoad = true;
         }
         if (shouldLoad || stacks.length < 1) {
-            const el = (_g = element.default) !== null && _g !== void 0 ? _g : element;
+            const el = (_h = element.default) !== null && _h !== void 0 ? _h : element;
             const loadConfig = Object.assign({}, pageConfig);
             const stacksIndex = stacks.length;
             delete loadConfig['path'];
@@ -1163,11 +1270,6 @@ function createRouter(app, config, framework) {
                 page.options = params;
             handler.load(page, pageConfig, pageStampId, stacksIndex);
         }
-        runtime.eventCenter.trigger('__afterTaroRouterChange', {
-            toLocation: {
-                path: handler.pathname
-            }
-        });
     });
     const routePath = addLeadingSlash(stripBasename(exports.history.location.pathname, handler.basename));
     if (routePath === '/') {