---
title: router
---

# runtime.router

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

<RouterLegacyTip />

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

该值在项目创建时被设置为 `true`，支持使用 Modern.js 默认提供的[约定式路由](/guides/concept/entries.html#约定式路由)进行路由管理。

如果希望使用[自控式路由](/guides/concept/entries.html#自控式路由)，请移除该值，或将该值设置为 `false`。

:::note
`router` 的所有子配置都只会在使用约定式路由时生效。
:::

## basename

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

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

:::tip
推荐使用 [`server.baseUrl`](/configure/app/server/base-url) 进行配置。
:::

## supportHtml5History

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

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

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

:::
