@tarojs/router

  • Version 3.4.10
  • Published
  • 108 kB
  • 5 dependencies
  • MIT license

Install

npm i @tarojs/router
yarn add @tarojs/router
pnpm add @tarojs/router

Overview

Taro-router

Index

Functions

function createHistory

createHistory: (props: {
basename?: string;
mode: 'hash' | 'browser';
firstPagePath: string;
customRoutes: { [key: string]: string | string[] };
}) => any;

    Namespaces

    namespace Router

    namespace Router {}
    • original code from: https://github.com/qiu8310/minapp/blob/master/packages/minapp-wx/typing/wx.d.ts Lincenced under MIT license: https://github.com/qiu8310/minapp/issues/69 thanks for the great work by 👍👍👍

    function navigateBack

    navigateBack: (OBJECT: navigateBack.Param) => void;
    • 关闭当前页面,返回上一页面或多级页面。可通过 [getCurrentPages()](https://developers.weixin.qq.com/miniprogram/dev/framework/app-service/page.html#getCurrentPages()) 获取当前的页面栈,决定需要返回几层。

      **Tip:**

      1. tip: Router.navigateTo 和 Router.redirectTo 不允许跳转到 tabbar 页面,只能用 Router.switchTab 跳转到 tabbar 页面

      **示例代码:**

      ```javascript // 注意:调用 navigateTo 跳转时,调用该方法的页面会被加入堆栈,而 redirectTo 方法则不会。见下方示例代码

      // 此处是A页面 Router.navigateTo({ url: 'B?id=1' })

      // 此处是B页面 Router.navigateTo({ url: 'C?id=1' })

      // 在C页面内 navigateBack,将返回A页面 Router.navigateBack({ delta: 2 }) ```

      See Also

      • https://developers.weixin.qq.com/miniprogram/dev/api/ui-navigate.html#wxnavigatebackobject

    function navigateTo

    navigateTo: (OBJECT: navigateTo.Param) => void;
    • 保留当前页面,跳转到应用内的某个页面,使用Router.navigateBack可以返回到原页面。

      **示例代码:**

      ```javascript Router.navigateTo({ url: 'test?id=1' }) ```

      **示例代码:**

      ```javascript //test.js Page({ onLoad: function(option){ console.log(option.query) } }) ```

      See Also

      • https://developers.weixin.qq.com/miniprogram/dev/api/ui-navigate.html#wxnavigatetoobject

    function redirectTo

    redirectTo: (OBJECT: redirectTo.Param) => void;
    • 关闭当前页面,跳转到应用内的某个页面。

      **示例代码:**

      ```javascript Router.redirectTo({ url: 'test?id=1' }) ```

      See Also

      • https://developers.weixin.qq.com/miniprogram/dev/api/ui-navigate.html#wxredirecttoobject

    function reLaunch

    reLaunch: (OBJECT: reLaunch.Param) => void;
    • 1.1.0

      关闭所有页面,打开到应用内的某个页面。

      **示例代码:**

      ```javascript Router.reLaunch({ url: 'test?id=1' }) ```

      **示例代码:**

      ```javascript //test.js Page({ onLoad: function(option){ console.log(option.query) } }) ```

      See Also

      • https://developers.weixin.qq.com/miniprogram/dev/api/ui-navigate.html#wxrelaunchobject

    function switchTab

    switchTab: (OBJECT: switchTab.Param) => void;
    • 跳转到 tabBar 页面,并关闭其他所有非 tabBar 页面

      **示例代码:**

      ```json { "tabBar": { "list": [{ "pagePath": "index", "text": "首页" },{ "pagePath": "other", "text": "其他" }] } } ```

      **示例代码:**

      ```javascript Router.switchTab({ url: '/index' }) ```

      See Also

      • https://developers.weixin.qq.com/miniprogram/dev/api/ui-navigate.html#wxswitchtabobject

    namespace Router.navigateBack

    namespace Router.navigateBack {}

      type Param

      type Param = {
      /**
      * 返回的页面数,如果 delta 大于现有页面数,则返回到首页。
      *
      * @default 1
      */
      delta?: number;
      };

        namespace Router.navigateTo

        namespace Router.navigateTo {}

          type Param

          type Param = {
          /**
          * 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数。参数与路径之间使用`?`分隔,参数键与参数值用`=`相连,不同参数用`&`分隔;如 'path?key=value&key2=value2'
          */
          url: string;
          /**
          * 接口调用成功的回调函数
          */
          success?: ParamPropSuccess;
          /**
          * 接口调用失败的回调函数
          */
          fail?: ParamPropFail;
          /**
          * 接口调用结束的回调函数(调用成功、失败都会执行)
          */
          complete?: ParamPropComplete;
          };

            type ParamPropComplete

            type ParamPropComplete = () => any;
            • 接口调用结束的回调函数(调用成功、失败都会执行)

            type ParamPropFail

            type ParamPropFail = (err: any) => any;
            • 接口调用失败的回调函数

            type ParamPropSuccess

            type ParamPropSuccess = (res: any) => any;
            • 接口调用成功的回调函数

            namespace Router.redirectTo

            namespace Router.redirectTo {}

              type Param

              type Param = {
              /**
              * 需要跳转的应用内非 tabBar 的页面的路径,路径后可以带参数。参数与路径之间使用`?`分隔,参数键与参数值用`=`相连,不同参数用`&`分隔;如 'path?key=value&key2=value2'
              */
              url: string;
              /**
              * 接口调用成功的回调函数
              */
              success?: ParamPropSuccess;
              /**
              * 接口调用失败的回调函数
              */
              fail?: ParamPropFail;
              /**
              * 接口调用结束的回调函数(调用成功、失败都会执行)
              */
              complete?: ParamPropComplete;
              };

                type ParamPropComplete

                type ParamPropComplete = () => any;
                • 接口调用结束的回调函数(调用成功、失败都会执行)

                type ParamPropFail

                type ParamPropFail = (err: any) => any;
                • 接口调用失败的回调函数

                type ParamPropSuccess

                type ParamPropSuccess = (res: any) => any;
                • 接口调用成功的回调函数

                namespace Router.reLaunch

                namespace Router.reLaunch {}

                  type Param

                  type Param = {
                  /**
                  * 需要跳转的应用内页面路径 , 路径后可以带参数。参数与路径之间使用`?`分隔,参数键与参数值用`=`相连,不同参数用`&`分隔;如 'path?key=value&key2=value2',如果跳转的页面路径是 tabBar 页面则不能带参数
                  */
                  url: string;
                  /**
                  * 接口调用成功的回调函数
                  */
                  success?: ParamPropSuccess;
                  /**
                  * 接口调用失败的回调函数
                  */
                  fail?: ParamPropFail;
                  /**
                  * 接口调用结束的回调函数(调用成功、失败都会执行)
                  */
                  complete?: ParamPropComplete;
                  };

                    type ParamPropComplete

                    type ParamPropComplete = () => any;
                    • 接口调用结束的回调函数(调用成功、失败都会执行)

                    type ParamPropFail

                    type ParamPropFail = (err: any) => any;
                    • 接口调用失败的回调函数

                    type ParamPropSuccess

                    type ParamPropSuccess = (res: any) => any;
                    • 接口调用成功的回调函数

                    namespace Router.switchTab

                    namespace Router.switchTab {}

                      type Param

                      type Param = {
                      /**
                      * 需要跳转的 tabBar 页面的路径(需在 app.json 的 [tabBar](https://developers.weixin.qq.com/miniprogram/dev/framework/config.html#tabbar) 字段定义的页面),路径后不能带参数
                      */
                      url: string;
                      /**
                      * 接口调用成功的回调函数
                      */
                      success?: ParamPropSuccess;
                      /**
                      * 接口调用失败的回调函数
                      */
                      fail?: ParamPropFail;
                      /**
                      * 接口调用结束的回调函数(调用成功、失败都会执行)
                      */
                      complete?: ParamPropComplete;
                      };

                        type ParamPropComplete

                        type ParamPropComplete = () => any;
                        • 接口调用结束的回调函数(调用成功、失败都会执行)

                        type ParamPropFail

                        type ParamPropFail = (err: any) => any;
                        • 接口调用失败的回调函数

                        type ParamPropSuccess

                        type ParamPropSuccess = (res: any) => any;
                        • 接口调用成功的回调函数

                        Package Files (1)

                        Dependencies (5)

                        Dev Dependencies (0)

                        No dev dependencies.

                        Peer Dependencies (0)

                        No peer dependencies.

                        Badge

                        To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                        You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@tarojs/router.

                        • Markdown
                          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@tarojs/router)
                        • HTML
                          <a href="https://www.jsdocs.io/package/@tarojs/router"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>