@tarojs/router 3.5.0-beta.0 → 3.5.0-beta.3

package/dist/api.js

@@ -8,10 +8,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { parsePath } from 'history';
-import stacks from './router/stack';
 import { history, prependBasename } from './history';
-import { routesAlias, addLeadingSlash } from './utils';
 import { RouterConfig } from './router';
+import stacks from './router/stack';
+import { addLeadingSlash, routesAlias } from './utils';
 function processNavigateUrl(option) {
     var _a;
     const pathPieces = parsePath(option.url);

package/dist/index.cjs.js

@@ -4,14 +4,39 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var history = require('history');
 var runtime = require('@tarojs/runtime');
-var UniversalRouter = require('universal-router');
 var queryString = require('query-string');
 var taro = require('@tarojs/taro');
+var UniversalRouter = require('universal-router');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
-var UniversalRouter__default = /*#__PURE__*/_interopDefaultLegacy(UniversalRouter);
 var queryString__default = /*#__PURE__*/_interopDefaultLegacy(queryString);
+var UniversalRouter__default = /*#__PURE__*/_interopDefaultLegacy(UniversalRouter);
+
+/*! *****************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
 
 const addLeadingSlash = (url = '') => (url.charAt(0) === '/' ? url : '/' + url);
 const hasBasename = (path = '', prefix = '') => new RegExp('^' + prefix + '(\\/|\\?|#|$)', 'i').test(path) || path === prefix;
@@ -178,31 +203,6 @@ function prependBasename(url = '') {
     return basename.replace(/\/$/, '') + '/' + url.replace(/^\//, '');
 }
 
-/*! *****************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-
-function __awaiter(thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-}
-
 class Stacks {
     constructor() {
         this.stacks = [];
@@ -352,36 +352,6 @@ function getCurrentPages() {
     return pages.map(e => (Object.assign(Object.assign({}, e), { route: e.path || '' })));
 }
 
-/**
- * 插入页面动画需要的样式
- */
-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);
-}
-
 let pageResizeFn;
 function bindPageResize(page) {
     pageResizeFn && window.removeEventListener('resize', pageResizeFn);
@@ -455,6 +425,189 @@ function initTabbar(config) {
     taro.initTabBarApis(config);
 }
 
+class MultiPageHandler {
+    constructor(config) {
+        this.config = config;
+        this.mount();
+    }
+    get appId() { return 'app'; }
+    get router() { return this.config.router; }
+    get routerMode() { return this.router.mode || 'hash'; }
+    get customRoutes() { return this.router.customRoutes || {}; }
+    get tabBarList() { var _a; return ((_a = this.config.tabBar) === null || _a === void 0 ? void 0 : _a.list) || []; }
+    get PullDownRefresh() { return this.config.PullDownRefresh; }
+    set pathname(p) { this.router.pathname = p; }
+    get pathname() { return this.router.pathname; }
+    get basename() { return this.router.basename || ''; }
+    get pageConfig() { return this.config.route; }
+    get isTabBar() {
+        var _a;
+        const routePath = stripBasename(this.pathname, this.basename);
+        const pagePath = ((_a = Object.entries(this.customRoutes).find(([, target]) => {
+            if (typeof target === 'string') {
+                return target === routePath;
+            }
+            else if ((target === null || target === void 0 ? void 0 : target.length) > 0) {
+                return target.includes(routePath);
+            }
+            return false;
+        })) === null || _a === void 0 ? void 0 : _a[0]) || routePath;
+        return !!pagePath && this.tabBarList.some(t => t.pagePath === pagePath);
+    }
+    get search() { return location.search.substr(1); }
+    getQuery(search = '', options = {}) {
+        search = search ? `${search}&${this.search}` : this.search;
+        const query = search
+            ? queryString__default["default"].parse(search)
+            : {};
+        return Object.assign(Object.assign({}, query), options);
+    }
+    mount() {
+        var _a;
+        setHistoryMode(this.routerMode, this.router.basename);
+        (_a = document.getElementById('app')) === null || _a === void 0 ? void 0 : _a.remove();
+        const app = document.createElement('div');
+        app.id = this.appId;
+        app.classList.add('taro_router');
+        if (this.tabBarList.length > 1) {
+            const container = document.createElement('div');
+            container.classList.add('taro-tabbar__container');
+            container.id = 'container';
+            const panel = document.createElement('div');
+            panel.classList.add('taro-tabbar__panel');
+            panel.appendChild(app);
+            container.appendChild(panel);
+            document.body.appendChild(container);
+            initTabbar(this.config);
+        }
+        else {
+            document.body.appendChild(app);
+        }
+    }
+    onReady(page, onLoad = true) {
+        var _a;
+        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);
+            onLoad && (pageEl['__page'] = page);
+        }
+    }
+    load(page, pageConfig = {}) {
+        var _a;
+        if (!page)
+            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'));
+            this.onReady(page, true);
+            (_a = page.onShow) === null || _a === void 0 ? void 0 : _a.call(page);
+            this.bindPageEvents(page, pageEl, pageConfig);
+        });
+    }
+    getPageContainer(page) {
+        var _a;
+        const path = page ? page === null || page === void 0 ? void 0 : page.path : (_a = runtime.Current.page) === null || _a === void 0 ? void 0 : _a.path;
+        const id = path === null || path === void 0 ? void 0 : path.replace(/([^a-z0-9\u00a0-\uffff_-])/ig, '\\$1');
+        if (page) {
+            return document.querySelector(`.taro_page#${id}`);
+        }
+        const el = (id
+            ? document.querySelector(`.taro_page#${id}`)
+            : document.querySelector('.taro_page') ||
+                document.querySelector('.taro_router'));
+        return el || window;
+    }
+    bindPageEvents(page, pageEl, config = {}) {
+        var _a;
+        if (!pageEl) {
+            pageEl = this.getPageContainer();
+        }
+        const distance = config.onReachBottomDistance || ((_a = this.config.window) === null || _a === void 0 ? void 0 : _a.onReachBottomDistance) || 50;
+        bindPageScroll(page, pageEl, distance);
+        bindPageResize(page);
+    }
+}
+
+// TODO 支持多路由 (APP 生命周期仅触发一次)
+/** Note: 关于多页面应用
+ * - 需要配置路由映射（根目录跳转、404 页面……）
+ * - app.onPageNotFound 事件不支持
+ * - 应用生命周期可能多次触发
+ * - TabBar 会多次加载
+ * - 不支持路由动画
+ */
+function createMultiRouter(app, config, framework) {
+    var _a, _b, _c, _d, _e, _f;
+    return __awaiter(this, void 0, void 0, function* () {
+        RouterConfig.config = config;
+        const handler = new MultiPageHandler(config);
+        const launchParam = handler.getQuery();
+        (_a = app.onLaunch) === null || _a === void 0 ? void 0 : _a.call(app, launchParam);
+        const pathName = config.pageName;
+        const pageConfig = handler.pageConfig;
+        let element;
+        try {
+            element = yield ((_b = pageConfig.load) === null || _b === void 0 ? void 0 : _b.call(pageConfig));
+        }
+        catch (error) {
+            throw new Error(error);
+        }
+        if (!element)
+            return;
+        let enablePullDownRefresh = ((_c = config === null || config === void 0 ? void 0 : config.window) === null || _c === void 0 ? void 0 : _c.enablePullDownRefresh) || false;
+        runtime.eventCenter.trigger('__taroRouterChange', {
+            toLocation: {
+                path: pathName
+            }
+        });
+        if (pageConfig) {
+            document.title = (_d = pageConfig.navigationBarTitleText) !== null && _d !== void 0 ? _d : document.title;
+            if (typeof pageConfig.enablePullDownRefresh === 'boolean') {
+                enablePullDownRefresh = pageConfig.enablePullDownRefresh;
+            }
+        }
+        const el = (_e = element.default) !== null && _e !== void 0 ? _e : element;
+        const loadConfig = Object.assign({}, pageConfig);
+        delete loadConfig['path'];
+        delete loadConfig['load'];
+        const page = runtime.createPageConfig(enablePullDownRefresh ? runtime.hooks.call('createPullDownComponent', el, location.pathname, framework, config.PullDownRefresh) : el, pathName + runtime.stringify(launchParam), {}, loadConfig);
+        handler.load(page, pageConfig);
+        (_f = app.onShow) === null || _f === void 0 ? void 0 : _f.call(app, launchParam);
+    });
+}
+
+/**
+ * 插入页面动画需要的样式
+ */
+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);
+}
+
 function setDisplay(el, type = '') {
     if (el) {
         el.style.display = type;
@@ -731,7 +884,6 @@ function createRouter(app, config, framework) {
     var _a, _b;
     RouterConfig.config = config;
     const handler = new PageHandler(config);
-    const runtimeHooks = runtime.container.get(runtime.SERVICE_IDENTIFIER.Hooks);
     routesAlias.set(handler.router.customRoutes);
     const basename = handler.router.basename;
     const routes = handler.routes.map(route => {
@@ -746,7 +898,7 @@ function createRouter(app, config, framework) {
     const launchParam = handler.getQuery(stacks.length);
     (_a = app.onLaunch) === null || _a === void 0 ? void 0 : _a.call(app, launchParam);
     const render = ({ location, action }) => __awaiter(this, void 0, void 0, function* () {
-        var _c, _d, _e, _f, _g;
+        var _c, _d, _e, _f;
         handler.pathname = decodeURI(location.pathname);
         let element, params;
         try {
@@ -820,7 +972,7 @@ function createRouter(app, config, framework) {
             const stacksIndex = stacks.length;
             delete loadConfig['path'];
             delete loadConfig['load'];
-            const page = runtime.createPageConfig(enablePullDownRefresh ? (_g = runtimeHooks.createPullDownComponent) === null || _g === void 0 ? void 0 : _g.call(runtimeHooks, el, location.pathname, framework, handler.PullDownRefresh) : el, pathname + runtime.stringify(handler.getQuery(stacksIndex)), {}, loadConfig);
+            const page = runtime.createPageConfig(enablePullDownRefresh ? runtime.hooks.call('createPullDownComponent', el, location.pathname, framework, handler.PullDownRefresh) : el, pathname + runtime.stringify(handler.getQuery(stacksIndex)), {}, loadConfig);
             if (params)
                 page.options = params;
             return handler.load(page, pageConfig, stacksIndex);
@@ -835,160 +987,6 @@ function createRouter(app, config, framework) {
     return exports.history.listen(render);
 }
 
-class MultiPageHandler {
-    constructor(config) {
-        this.config = config;
-        this.mount();
-    }
-    get appId() { return 'app'; }
-    get router() { return this.config.router; }
-    get routerMode() { return this.router.mode || 'hash'; }
-    get customRoutes() { return this.router.customRoutes || {}; }
-    get tabBarList() { var _a; return ((_a = this.config.tabBar) === null || _a === void 0 ? void 0 : _a.list) || []; }
-    get PullDownRefresh() { return this.config.PullDownRefresh; }
-    set pathname(p) { this.router.pathname = p; }
-    get pathname() { return this.router.pathname; }
-    get basename() { return this.router.basename || ''; }
-    get pageConfig() { return this.config.route; }
-    get isTabBar() {
-        var _a;
-        const routePath = stripBasename(this.pathname, this.basename);
-        const pagePath = ((_a = Object.entries(this.customRoutes).find(([, target]) => {
-            if (typeof target === 'string') {
-                return target === routePath;
-            }
-            else if ((target === null || target === void 0 ? void 0 : target.length) > 0) {
-                return target.includes(routePath);
-            }
-            return false;
-        })) === null || _a === void 0 ? void 0 : _a[0]) || routePath;
-        return !!pagePath && this.tabBarList.some(t => t.pagePath === pagePath);
-    }
-    get search() { return location.search.substr(1); }
-    getQuery(search = '', options = {}) {
-        search = search ? `${search}&${this.search}` : this.search;
-        const query = search
-            ? queryString__default["default"].parse(search)
-            : {};
-        return Object.assign(Object.assign({}, query), options);
-    }
-    mount() {
-        var _a;
-        setHistoryMode(this.routerMode, this.router.basename);
-        (_a = document.getElementById('app')) === null || _a === void 0 ? void 0 : _a.remove();
-        const app = document.createElement('div');
-        app.id = this.appId;
-        app.classList.add('taro_router');
-        if (this.tabBarList.length > 1) {
-            const container = document.createElement('div');
-            container.classList.add('taro-tabbar__container');
-            container.id = 'container';
-            const panel = document.createElement('div');
-            panel.classList.add('taro-tabbar__panel');
-            panel.appendChild(app);
-            container.appendChild(panel);
-            document.body.appendChild(container);
-            initTabbar(this.config);
-        }
-        else {
-            document.body.appendChild(app);
-        }
-    }
-    onReady(page, onLoad = true) {
-        var _a;
-        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);
-            onLoad && (pageEl['__page'] = page);
-        }
-    }
-    load(page, pageConfig = {}) {
-        var _a;
-        if (!page)
-            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'));
-            this.onReady(page, true);
-            (_a = page.onShow) === null || _a === void 0 ? void 0 : _a.call(page);
-            this.bindPageEvents(page, pageEl, pageConfig);
-        });
-    }
-    getPageContainer(page) {
-        var _a;
-        const path = page ? page === null || page === void 0 ? void 0 : page.path : (_a = runtime.Current.page) === null || _a === void 0 ? void 0 : _a.path;
-        const id = path === null || path === void 0 ? void 0 : path.replace(/([^a-z0-9\u00a0-\uffff_-])/ig, '\\$1');
-        if (page) {
-            return document.querySelector(`.taro_page#${id}`);
-        }
-        const el = (id
-            ? document.querySelector(`.taro_page#${id}`)
-            : document.querySelector('.taro_page') ||
-                document.querySelector('.taro_router'));
-        return el || window;
-    }
-    bindPageEvents(page, pageEl, config = {}) {
-        var _a;
-        if (!pageEl) {
-            pageEl = this.getPageContainer();
-        }
-        const distance = config.onReachBottomDistance || ((_a = this.config.window) === null || _a === void 0 ? void 0 : _a.onReachBottomDistance) || 50;
-        bindPageScroll(page, pageEl, distance);
-        bindPageResize(page);
-    }
-}
-
-// TODO 支持多路由 (APP 生命周期仅触发一次)
-/** Note: 关于多页面应用
- * - 需要配置路由映射（根目录跳转、404 页面……）
- * - app.onPageNotFound 事件不支持
- * - 应用生命周期可能多次触发
- * - TabBar 会多次加载
- * - 不支持路由动画
- */
-function createMultiRouter(app, config, framework) {
-    var _a, _b, _c, _d, _e, _f, _g;
-    return __awaiter(this, void 0, void 0, function* () {
-        RouterConfig.config = config;
-        const handler = new MultiPageHandler(config);
-        const runtimeHooks = runtime.container.get(runtime.SERVICE_IDENTIFIER.Hooks);
-        const launchParam = handler.getQuery();
-        (_a = app.onLaunch) === null || _a === void 0 ? void 0 : _a.call(app, launchParam);
-        const pathName = config.pageName;
-        const pageConfig = handler.pageConfig;
-        let element;
-        try {
-            element = yield ((_b = pageConfig.load) === null || _b === void 0 ? void 0 : _b.call(pageConfig));
-        }
-        catch (error) {
-            throw new Error(error);
-        }
-        if (!element)
-            return;
-        let enablePullDownRefresh = ((_c = config === null || config === void 0 ? void 0 : config.window) === null || _c === void 0 ? void 0 : _c.enablePullDownRefresh) || false;
-        runtime.eventCenter.trigger('__taroRouterChange', {
-            toLocation: {
-                path: pathName
-            }
-        });
-        if (pageConfig) {
-            document.title = (_d = pageConfig.navigationBarTitleText) !== null && _d !== void 0 ? _d : document.title;
-            if (typeof pageConfig.enablePullDownRefresh === 'boolean') {
-                enablePullDownRefresh = pageConfig.enablePullDownRefresh;
-            }
-        }
-        const el = (_e = element.default) !== null && _e !== void 0 ? _e : element;
-        const loadConfig = Object.assign({}, pageConfig);
-        delete loadConfig['path'];
-        delete loadConfig['load'];
-        const page = runtime.createPageConfig(enablePullDownRefresh ? (_f = runtimeHooks.createPullDownComponent) === null || _f === void 0 ? void 0 : _f.call(runtimeHooks, el, location.pathname, framework, config.PullDownRefresh) : el, pathName + runtime.stringify(launchParam), {}, loadConfig);
-        handler.load(page, pageConfig);
-        (_g = app.onShow) === null || _g === void 0 ? void 0 : _g.call(app, launchParam);
-    });
-}
-
 exports.createMultiRouter = createMultiRouter;
 exports.createRouter = createRouter;
 exports.getCurrentPages = getCurrentPages;