---
sidebar_label: router
---

import RouterLegacyTip from "@site-docs/components/router-legacy-tip"

<RouterLegacyTip />

# runtime.router

- **类型：** `boolean | Object`
- **默认值：** `false`

开启 `router` 之后，支持使用 Modern.js 默认提供的约定式路由进行路由管理。Modern.js 的路由模块基于 [React Router 6](https://reactrouter.com/) 实现。

具体配置如下：

## basename

- **类型：** `string`
- **默认值：** `/`

设置客户端路由的 `basename`，通常用于应用需要部署在域名非根路径下的场景。

## supportHtml5History

- **类型：** `boolean`
- **默认值：** `true`

值为 `true`，使用 `BrowserRouter`；否则使用 `HashRouter`。推荐使用 `BrowserRouter`。

:::warning
当开启 SSR 时，不支持设置 `supportHtml5History`。

:::
