npm:medusa-router

README

简介

medusa-router 对官方接口进行了封装增强，让你能以更加优雅的方式读取和使用路由。它相较于官方接口 更加容易记忆并使用 并且 路由参数能够保持原有的数据类型。 medusa-router 是为了给各类小程序开发赋能而设计的，目前已经在微信、百度、支付宝、Taro、uni-app 框架上测试通过。

快速上手

安装

在支持 npm 包管理工具的项目中，你可以通过以下命令下载 medusa-router 。如果你的项目不支持的话，请访问 medusa-router 将 dist 文件夹中的文件拷贝到你的项目中。

$ npm install medusa-router

使用

首先我们需要将对应平台的标志对象传递给 medusa-router 并初始化实例：

/** 微信原生框架 */
import Router from './utils/router';

const router = new Router(wx);
/** Taro 框架 */
import Taro from '@tarojs/taro';
import Router from 'medusa-router';

const router = new Router(Taro);

medusa-router 被设计为单例模式，假设你在多个文件中做初始化操作时也不需要担心创建多个实例。为了方便使用我们可以将实例化对象赋值到 app 实例的属性上。

/**
 * /app.js
 */
import Router from './utils/router';

App({
    ms: new Router(wx),
});

/**
 * /pages/index/index.js or <script>
 *
 * 当前路径：/pages/index/index?id=1
 */
const app = getApp();

Page({
  onLoad() {
    const { fullPath, query } = app.ms.$route;
    console.log(fullPath, query); // '/pages/index/index' { id: 1 }
  },
  onClick() {
    app.ms.push({
      url: '/pages/logs/logs',
      query: {
        num: 0, // number
        bool: true, // boolean
      },
      success: () => {
        console.log('success');
      },
    });
  },
});

$route 对象

ms.$route 对象包含当前页面的信息，该对象包含 getCurrentPages() API 获取的页面栈中最顶层的页面信息和扩充属性 fullPath 和 query 。

{String} fullPath - 页面完整路径，不包含参数
{Object} query - 路由参数，其中的属性保留原有的数据类型

API 说明

getPages()

说明：获取路由栈信息，相当于使用 getCurrentPages() API 获取页面栈；

getPage(delta)

参数
- {number} [delta = 0] - 向前步进值
说明：
- 获取页面信息，不传入参数时默认获取当前页面的信息，传入数值时将获取当前页面之前的页面信息（传入1为上一页面，以此类推）；

push(options)

参数
- {Object} options
- {String} options.url - 目标页面路径
- {Object} [options.query] - 路由参数
- {Object} [options.events] - 页面通信接口
- {Function} [options.success] - 成功时回调函数
- {Function} [options.fail] - 失败时回调函数
- {Function} [options.complete] - 结束时回调函数
说明：
- 跳转至目标页面，与小程序的 navigateTo(...) API 具有相同的功能；

replace(options)

参数
- {Object} options
- {String} options.url - 目标页面路径
- {Object} [options.query] - 路由参数
- {Boolean} [options.closeAll = false] - 控制是否关闭当前路由栈中存在的所有页面
- {Function} [options.success] - 成功时回调函数
- {Function} [options.fail] - 失败时回调函数
- {Function} [options.complete] - 结束时回调函数
说明：
- 跳转至目标页面并且关闭当前页面，与小程序的 redirectTo(...) API 具有相同的功能；
- 当 options.closeAll 参数为 true 时，将跳转至目标页面并且关闭路由栈中所有页面，相当于小程序的 reLaunch(...) API 的功能；

switchTab(options)

参数
- {Object} options
- {String} options.url - tabBar 页面路径
- {Function} [options.success] - 成功时回调函数
- {Function} [options.fail] - 失败时回调函数
- {Function} [options.complete] - 结束时回调函数
说明：
- 跳转至目标页面，与小程序的 navigateTo(...) API 具有相同的功能；

goBack(options)

参数
- {Object} [options]
- {String} options.delta = 1 - 返回几层页面，默认值为 1
- {Function} [options.success] - 成功时回调函数
- {Function} [options.fail] - 失败时回调函数
- {Function} [options.complete] - 结束时回调函数
说明：
- 页面回退功能，与小程序的 navigateBack(...) API 具有相同的功能。该函数的参数是可选的，当不传入参数时默认返回到上一级页面；

goHome()

说明：回到首页功能，清空路由栈；

decoding(options)

参数
- {Object} options - onLoad 生命周期函数的参数 options
返回值
- {Object} query - 路由参数对象
说明：使用 medusa-router 路由功能时，路由参数具有保真功能，需要使用 decoding(options) 解析得到参数；

增强功能说明

路由参数保真功能

medusa-router 中提供的跳转功能均支持原生的传参方式，使用该方式得到的路由参数的值均为字符串类型；
使用 push 和 replace 功能时，运用 query 属性传递参数能够 保持原有的数据类型 。在目标页面当中需使用 $route.query 对象或者调用 decoding(options) API 才能获取正确的路由参数；

API 传参简化

具有跳转功能的 API 如果不需要传递路由参数和回调函数时，可以 直接传递目标页面路径字符串 作为参数；
goBack(options) 回退功能不需要使用回调函数时，可以直接将 回退页面层级 作为参数；

/* 跳转功能 */
ms.push('/pages/logs/logs');

/* 回退功能 */
ms.goBack(2);

Usage no npm install needed!