@fluid-topics/ft-reader-context

中文文档
2.2.52发布于 2026/11/14ISCTypeScriptCommonJS近 30 天下载 1.5万

Context block for integrated reader components

原始使用文档
文档目录6 节
  1. Install
  2. Javascript
  3. HTML
  4. Usage
  5. Lit
  6. HTML

Context block for integrated reader components. All children components with the ft-reader prefix will share the same context and interact with each other.

For example navigating using the component ft-reader-toc will change what topics the component ft-reader-content displays and topics visible in ft-reader-content will be highlighted in ft-reader-toc.

This component requires the Fluid Topics public API to be imported independently.

Install

Javascript

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

HTML

To be placed at the end of HTML body:

<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>

Usage

Lit

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 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 共发布 497 个版本,首次发布于 2022/09/27;过去 12 个月发布了 167 个版本。

版本发布日期距今
2.2.52latest2026/11/141 天前
2.2.512026/11/133 天前
2.2.502026/11/114 天前
2.2.492026/11/115 天前
2.2.482026/11/105 天前
2.2.472026/11/078 天前

关于 @fluid-topics/ft-reader-context 的常见问题

@fluid-topics/ft-reader-context 是什么?

Context block for integrated reader components

如何安装 @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 和提交记录判断。