# @aphrody/m3-reader 中文文档

规范地址：https://npmcn.com/package/%40aphrody/m3-reader/

版本：1\.4\.7
npm 元数据更新时间：2026-10-23T03:52:17.567Z
中文译文更新时间：2026-11-08T03:11:18.992Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40aphrody/m3-reader
原文对照：https://npmcn.com/package/%40aphrody/m3-reader/?lang=original
项目主页：https://github.com/aphrody-labs/bun-distribution/tree/os/packages/m3-reader#readme
源码仓库：https://github.com/aphrody-labs/bun-distribution

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

- 包体积（解压后）：171 kB，13 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：react \>=18\.0\.0，react-dom \>=18\.0\.0，tailwindcss \>=4\.1\.0
- 首次发布：2026-10-05T07:54:39.648Z
- 最新版本发布：2026-10-23T03:52:17.385Z
- 近 30 天下载量：1923（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 10 个）

## 中文简介

资料 3 漫畫和插图阅读器

## 安装

```sh
npm install @aphrody/m3-reader
```

也可以使用：`pnpm add @aphrody/m3-reader`、`yarn add @aphrody/m3-reader`、`bun add @aphrody/m3-reader`

## README

# @aphrody/m3读取器

材料3 页面和纵向漫画的对应阅读器和图书.

```sh
bun add @aphrody/m3-reader react react-dom tailwindcss
```

```tsx
import "@aphrody/m3-reader/styles.css";
import { MangaReader } from "@aphrody/m3-reader";

export function Chapter({ pages }: { pages: string[] }) {
  return <MangaReader title="Chapter 1" pages={pages} direction="rtl" />;
}
```

许可证: Apache-2.0(`LICENSE`) (中文(简体) ). 安装指南 : [文件/材料/立方米/INSTALL.md](https://github.com/aphrody-labs/bun-distribution/blob/os/docs/material/m3/INSTALL.md)。 。 。 .

这个软件包拥有读取器UI,呼号,虚拟滚动,缩放,全屏,缩略图,键盘控制,和灯盒焦点. 它没有资产服务器、编辑API、持久性或OCR政策.

导入 `@aphrody/m3-reader/styles.css` 一次在主机样式表。 主机必须装入 Tailwind 4 并扫描软件包 `dist` 目录为 `@source`,与其他 Apprody M3 组件包一样。 CSS 颜色使用材料 3 `--md-sys-color-*` 角色,带有可读倒数. 读者也可以通过 `--reader-surface`, (中文(简体) ), `--reader-on-surface`, (中文(简体) ), `--reader-accent`, (中文(简体) ), `--reader-on-accent`,以及 `--reader-outline`。 。 。 .

`MangaReader` 接受页面URL,方向,相邻章节链接,资产解析器,可选镜像解析器,以及页面地址的回调. `CaptionedReader` 接受已编号的页面、可中止的复制加载器、复制出、图像优化回调和预装数. `CollectionReader` 拥有版本和章节控制;主机提供其版本分组和章节渲染器. 主机提供特定域的加载和渲染.

这个 `/source` 导出服务于 TypeScript 源到将软件包本身转录的主机( Next, Bun); 根导出点到编译的 `dist`。主机仍然负责资产路由、API链接、读取历史、按需复制检索、OCR警告、校正链接和Markdown渲染.

## 常见问题

### @aphrody/m3-reader 是什么？

资料 3 漫畫和插图阅读器

### 如何安装 @aphrody/m3-reader？

在项目目录运行 npm install @aphrody/m3-reader，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=18\.0\.0）、react-dom（\>=18\.0\.0）、tailwindcss（\>=4\.1\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aphrody/m3-reader 支持 TypeScript 吗？

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

### @aphrody/m3-reader 支持 ESM 还是 CommonJS？

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

### @aphrody/m3-reader 可以商用吗？

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

### @aphrody/m3-reader 的下载量有多少？

根据 npm 官方下载统计，@aphrody/m3-reader 在 2026/10/06 – 2026/11/04 这 30 天内被下载 1,923 次，日均约 64 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @aphrody/m3-reader 还在维护吗？

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