# @fluid-topics/ft-reader-context 中文文档

规范地址：https://npmcn.com/package/%40fluid-topics/ft-reader-context/

版本：2\.2\.52
npm 元数据更新时间：2026-11-14T00:35:23.277Z
中文译文更新时间：2026-11-15T02:05:14.320Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40fluid-topics/ft-reader-context
原文对照：https://npmcn.com/package/%40fluid-topics/ft-reader-context/?lang=original
源码仓库：https://scm.mrs.antidot.net:2222/fluidtopics/ft-web-components

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

- 包体积（解压后）：614 kB，36 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2022-09-27T09:27:27.321Z
- 最新版本发布：2026-11-14T00:35:22.694Z
- 近 30 天下载量：14946（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：497（近 12 个月 167 个）

## 中文简介

综合阅读器组件的背景块

## 安装

```sh
npm install @fluid-topics/ft-reader-context
```

也可以使用：`pnpm add @fluid-topics/ft-reader-context`、`yarn add @fluid-topics/ft-reader-context`、`bun add @fluid-topics/ft-reader-context`

## README

综合阅读器组件的背景块. 所有儿童的构成 `ft-reader` 前缀将共享相同的上下文并相互交互.

例如,使用组件导航 `ft-reader-toc` 将改变组件的主题 `ft-reader-content` 显示 和可见于 `ft-reader-content` 将在 `ft-reader-toc`。 。 。 .

这一部分要求 [流体主题公共 API](https://www.npmjs.com/package/@fluid-topics/public-api) 将会是 独立导入.

## 安装

### Javascript

```shell
npm install @fluid-topics/ft-reader-context
yarn add @fluid-topics/ft-reader-context
```

### HTML 语言

放置在 HTML 正文末尾 :

```
<script src="https://cdn.jsdelivr.net/npm/@fluid-topics/public-api/dist/fluidtopics.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@fluid-topics/ft-reader-context/build/ft-reader-context.min.js"></script>
```

## 使用量

### 升

```typescript
import { html } from "lit"
import "@fluid-topics/public-api/dist/fluidtopics.min.js"
import "@fluid-topics/ft-app-context"
import "@fluid-topics/ft-reader-context"
import "@fluid-topics/ft-reader-toc"
import "@fluid-topics/ft-reader-content"
import "@fluid-topics/ft-reader-topic-context"
import "@fluid-topics/ft-reader-topic-title"
import "@fluid-topics/ft-reader-topic-content"

function render() {
    return html`
        <ft-app-context
                baseUrl="https://docs.fluidtopics.com/"
                apiIntegrationIdentifier="custom-integration">
            <ft-reader-context mapId="MdDo16IjKjJdTxsdVYuWjA">
                <ft-reader-toc></ft-reader-toc>
                <ft-reader-content></ft-reader-content>
                <ft-reader-toc scope="current-page"></ft-reader-toc>
            </ft-reader-context>
        </ft-app-context>
    `
}
```

### HTML 语言

```html
<html lang="en">
<head>
    <title>My custom reader</title>
</head>
<body>
    <style>
        ft-reader-context {
            display: flex;
            height: 100%;
            overflow: hidden;
            gap: 8px;
        }

        ft-reader-context > * {
            height: 100%;
            overflow: auto;
        }

        ft-reader-toc {
            flex-shrink: 0;
            flex-grow: 0;
            width: 20%;
        }

        ft-reader-content {
            flex-shrink: 1;
            flex-grow: 1;
        }

        ft-reader-toc[scope="current-page"][empty] {
            display: none;
        }

    </style>

    <ft-app-context
            baseUrl="<Tenant base URL>"
            apiIntegrationIdentifier="custom-integration">
        <ft-reader-context mapId="<Structured publication identifier>">
            <ft-reader-toc></ft-reader-toc>
            <ft-reader-content></ft-reader-content>
            <ft-reader-toc scope="current-page"></ft-reader-toc>
        </ft-reader-context>
    </ft-app-context>

    <script src="https://cdn.jsdelivr.net/npm/@fluid-topics/public-api/dist/fluidtopics.min.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/@fluid-topics/ft-app-context/build/ft-app-context.min.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/@fluid-topics/ft-reader-context/build/ft-reader-context.min.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/@fluid-topics/ft-reader-toc/build/ft-reader-toc.min.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/@fluid-topics/ft-reader-content/build/ft-reader-content.min.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/@fluid-topics/ft-reader-topic-context/build/ft-reader-topic-context.min.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/@fluid-topics/ft-reader-topic-title/build/ft-reader-topic-title.min.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/@fluid-topics/ft-reader-topic-content/build/ft-reader-topic-content.min.js"></script>
</body>
</html>

```

## 常见问题

### @fluid-topics/ft-reader-context 是什么？

综合阅读器组件的背景块

### 如何安装 @fluid-topics/ft-reader-context？

在项目目录运行 npm install @fluid-topics/ft-reader-context，或使用 pnpm add / yarn add / bun add。

### @fluid-topics/ft-reader-context 支持 TypeScript 吗？

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

### @fluid-topics/ft-reader-context 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @fluid-topics/ft-reader-context 可以商用吗？

@fluid-topics/ft-reader-context 使用 ISC 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @fluid-topics/ft-reader-context 的下载量有多少？

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

### @fluid-topics/ft-reader-context 还在维护吗？

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

