# @zerolith/router 中文文档

规范地址：https://npmcn.com/package/%40zerolith/router/

版本：0\.1\.0-alpha\.8
npm 元数据更新时间：2026-11-02T23:24:41.687Z
中文译文更新时间：2026-11-03T01:01:50.894Z
软件包许可：Apache-2\.0

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40zerolith/router
原文对照：https://npmcn.com/package/%40zerolith/router/?lang=original
项目主页：https://zerolith.dev/
源码仓库：https://github.com/molexxxx/zerolith

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：160 kB，31 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24\.0\.0
- 运行依赖：0 个
- peer 依赖：zerolith ^0\.1\.0-alpha\.8
- 首次发布：2026-10-29T17:20:43.339Z
- 最新版本发布：2026-11-02T23:24:41.359Z
- 已发布版本数：13（近 12 个月 13 个）

## 中文简介

zerolith的类型客户端路由：一个仅用于推断的路由表、普通锚、加载器、头部元数据和一个出口视图

## 安装

```sh
npm install @zerolith/router
```

也可以使用：`pnpm add @zerolith/router`、`yarn add @zerolith/router`、`bun add @zerolith/router`

## README

# @zerolith /路由器

为zerolith输入的客户端路由。

-   `defineRoutes({ name: route({...}) })` 是一个仅推理路由表：参数来自路径字符串，数据来自加载器(写 `load` 之前 `view`), `router.href("release", { tag })` 对拼写错误的路由或缺少参数进行类型检查失败。
-   普通锚导航。没有修改键的同源链接； `download`， `target`，或者 `rel="external"` 由一个委托的点击监听器处理；其他的一切都留给了浏览器。
-   路线的 `load` 在URL更改之前运行，并且它的惰性视图会解析，所以页面永远不会显示半加载的路由； `router.pending` 同时也是真的。
-   `head` 静态地或从加载的数据中设置每个路由的文档标题和描述。
-   `router.ready` 在初始导航提交时进行处理， `router.head` 是当前路线的元数据作为信号，和 `renderHead` 从 `@zerolith/router/server` 写为 `<title>` 和 `<meta>` 元素，因此同一个路由器在服务器上呈现请求，并在浏览器中进行交互。 `renderRouteState` 将加载的数据嵌入到页面中，浏览器路由器在初始导航中重用它，而不是运行加载器两次。
-   `base`，例如 `import.meta.env.BASE_URL`，在路径下服务于应用程序：路由路径保持相对于它， `href()` 包含它，它之外的链接留给浏览器。
-   前后恢复滚动位置；新的导航滚动到顶部或散列。
-   `router.outlet()` 呈现当前路由的视图，以及未知url的回退，以供布局放置。

指南在 [文档网站](https://zerolith.dev/guide/routing/).

状态:α。安装与 `npm install @zerolith/router@alpha`； API可能会在1.0之前更改。

## 文档

-   这个 [路由指南](https://zerolith.dev/guide/routing/) 用作为测试运行的示例解释它。
-   这个 [参考](https://zerolith.dev/reference/zerolith-router/) 列出从源生成的每个导出。
-   对zerolith不熟悉？这个 [教程](https://zerolith.dev/learn/) 一步一步地构建一个应用程序 [操场上](https://zerolith.dev/playground/) 在浏览器中运行代码。

## 许可证

apache - 2.0。看到 `LICENSE`.

## 常见问题

### @zerolith/router 是什么？

zerolith的类型客户端路由：一个仅用于推断的路由表、普通锚、加载器、头部元数据和一个出口视图

### 如何安装 @zerolith/router？

在项目目录运行 npm install @zerolith/router，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zerolith（^0\.1\.0-alpha\.8）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @zerolith/router 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @zerolith/router 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @zerolith/router 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @zerolith/router 可以商用吗？

@zerolith/router 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @zerolith/router 还在维护吗？

最新版本 0\.1\.0-alpha\.8 发布于 2026/11/03（今天）；至今共发布 13 个版本，其中过去 12 个月发布了 13 个；首次发布于 2026/10/30。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。