# saber-router

**Repository Path**: mirrors_ecomfe/saber-router

## Basic Information

- **Project Name**: saber-router
- **Description**: 适用于移动端的路由控制，支持 hash, popstate
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-01-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

saber-router
===

![Bower version](https://img.shields.io/bower/v/saber-router.svg?style=flat-square) [![Build Status](https://img.shields.io/travis/ecomfe/saber-router.svg?style=flat-square)](https://travis-ci.org/ecomfe/saber-router) [![License](https://img.shields.io/github/license/ecomfe/saber-router.svg?style=flat-square)](./LICENSE) [![EFE Mobile Team](https://img.shields.io/badge/EFE-Mobile_Team-blue.svg?style=flat-square)](http://efe.baidu.com)

适用于移动端的路由控制

* 支持`hash`、`popstate`与普通的多页面
* 支持相对路径 `../somewhere/action`
* 支持正则表达式控制路径
* 支持`RESTful`
* `hash`路由使用`~`分隔查询条件 `#/action~uid=100&name=saber`

## Installation

通过 [edp](https://github.com/ecomfe/edp) 引入模块：

```sh
edp import saber-router
```

## Usage

```js
var router = require('saber-router');

// 启用hash控制器
router.controller(require('saber-router/controller/hash'));

// 添加路由规则
router.add(
    '/custom/:id', // RESTful风格
    function (path, query, url) {
        console.log(query.id);
    }
);

// 开始路由监听
router.start();
```

## API

### Methods

#### config([options])

全局配置

* **options** `{Object=}` 配置参数
    * **path** `{string=}` 初始路径 默认为`'/'`，只对`hash`控制器生效
    * **index** `{string=}` index文件名 默认为`''`

#### controller(con)

设置控制控制

* **con** `{Object}` 控制器，有以下控制器供选择
    * [hash](src/controller/hash.js) hash控制器
    * [popstate](src/controller/popstate.js) popstate控制器
    * [page](src/controller/page.js) 多页面控制器

#### add(path, fn[, thisArg])

添加路由规则

* **path** `{string|RegExp}` 路由路径，如果是空字符串则认为是设置默认路由。在路由处理未找到对应路由规则时，会使用此默认路由进行处理
* **fn** `{function(string, Object, Object, string, Object)}` 路由处理函数（函数参数分别是：path、查询条件、路径参数、完整URL、跳转参数，具体跳转参数请参考[redirect(url, query, options)](#redirecturl-query-options)）
* **thisArg** `{Object=}` 路径处理函数的`this`指针

#### remove(path)

删除路由规则

* **path** `{string}` 需要删除的路由路径

#### clear()

清除所有路由规则

#### reset(url[, query[, options]])

重置当前的URL（不产生新的浏览历史记录），只对`hash`与`popstate`控制器生效

* **url** `{string}` url
* **query** `{Object=}` 查询条件
* **options** `{Object=}` 重置参数
    * **silent** `{boolean=}` 是否静默重置，如果静默重置则不会触发相应的路由规则处理

#### redirect(url[, query[, options]])

URL跳转

* **url** `{string}` url
* **query** `{Object=}` 查询条件
* **options** `{options=}` 跳转参数
    * **force** `{boolean=}` 是否强制跳转（默认情况下相同URL不跳转）
    * **silent** `{boolean=}` 是否静默跳转，如果静默跳转则不改变当前的URL

#### start()

启动路由监听

#### stop()

停止路由监听