@github/include-fragment-element

中文文档
6.4.1发布于 2025/09/04MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 13.3万

一个客户端包括标签 .

中文使用文档
文档目录13 节
  1. 安装
  2. 使用量
  3. 其他属性
  4. 错误
  5. 活动
  6. 选项
  7. 推迟装载
  8. 模式
  9. CSP 信任类型
  10. 与服务器侧的关联包括
  11. 浏览器支持
  12. 发展
  13. 许可证

< 包含- 分解 > 元素

一个客户端包括标签 .

安装

$ npm install --save @github/include-fragment-element

使用量

全体 include-fragment 元素必须有一个 src 属性以获取 HTML 元素碎片.

初始的页面负载应该包括如果无法立即获取资源而显示的倒计时内容 .

import '@github/include-fragment-element'

原文

<div class="tip">
  <include-fragment src="/tips">
    <p>Loading tip…</p>
  </include-fragment>
</div>

在页面加载时 include-fragment 元素获取 URL, 将响应解为 HTML 元素, 替换 include-fragment 整个元素.

结果

<div class="tip">
  <p>You look nice today</p>
</div>

服务器必须用 HTML 片段响应以替换 include-fragment 键。 它不应该包含 又一个 include-fragment 元素或服务器将在无限循环中进行授精.

其他属性

接受

这个属性告诉 <include-fragment/> 发送什么作为 Accept 页眉, 作为获取请求的一部分 。 如果省略,或设置为空值,默认行为将是 text/html。服务器必须使用 HTML 进行响应,但您可能希望更改接受信头,以帮助与服务器谈判正确的内容.

装入

这说明 何时 应当获取内容 :

  • eager: 无论是否 <include-fragment/> 正在可见的视图端口内(这是默认值).
  • lazy: 拖放取并装入内容直到 <include-fragment/> 标记与取景口的计算距离。 其用意是避免处理内容所需的网络和存储带宽,直到合理确定需要.

错误

如果 URL 无法加载,则 include-fragment 元素留在页面中,并用 is-error 可用于造型的 CSS 类.

活动

请求的生命周期活动于 <include-fragment> 键.

  • loadstart - 服务器抓取开始 .
  • load - 请求成功完成.
  • error -请求失败了.
  • loadend - 请求已经完成.
  • include-fragment-replace (可撤销) - 成功对策已解析. 它会随着 event.detail.fragment 这将取代目前的元素.
  • include-fragment-replaced - 元素已经被碎片所取代.
const loader = document.querySelector('include-fragment')
const container = loader.parentElement
loader.addEventListener('loadstart', () => container.classList.add('is-loading'))
loader.addEventListener('loadend', () => container.classList.remove('is-loading'))
loader.addEventListener('load', () => container.classList.add('is-success'))
loader.addEventListener('error', () => container.classList.add('is-error'))

选项

属性选项说明
srcURL 字符串需要装入替换 HTML 元素碎片的 URL .

推迟装载

从服务器替换标记的请求从 src 属性在 <include-fragment> 键。 当元素被渲染出来时,这种情况通常会在页面负荷时发生. 但是,如果我们省略 src 属性直到稍后某个时间,我们才能将内容装入.

这个 <details-menu> 元素使用此技术将加载菜单内容推迟到菜单首次打开.

模式

延后显示标值一般采用以下使用模式.

  • 一个用户动作开始在服务器上慢跑的背景工作,比如备份存储在服务器上的文件. 在备份工作运行时,向用户显示进度栏 。 完成后,包含-分解元素被替换为备份文件的链接.

  • 用户第一次访问包含一个耗时的加分生成的页面时,会显示加载指示器. 当标记在服务器上完成后,它被存储于memcache并被发送到浏览器来替换包含-分解加载器. 随后访问页面会直接使被缓存的标出,而不通过包含分解元素.

CSP 信任类型

你可以打电话 setCSPTrustedTypesPolicy(policy: TrustedTypePolicy | Promise<TrustedTypePolicy> | null) 从 Java 脚本设置 CSP 信任的类型政策,可以执行(同步)过滤或拒绝 fetch 在插入该页之前的答复 :

import IncludeFragmentElement from "include-fragment-element";
import DOMPurify from "dompurify"; // Using https://github.com/cure53/DOMPurify

// This policy removes all HTML markup except links.
const policy = trustedTypes.createPolicy("links-only", {
  createHTML: (htmlText: string) => {
    return DOMPurify.sanitize(htmlText, {
      ALLOWED_TAGS: ["a"],
      ALLOWED_ATTR: ["href"],
      RETURN_TRUSTED_TYPE: true,
    });
  },
});
IncludeFragmentElement.setCSPTrustedTypesPolicy(policy);

该政策可进入 fetch 响应对象。 由于平台的限制,政策中只能使用来自响应的同步信息(除了HTML文本正文):

import IncludeFragmentElement from "include-fragment-element";

const policy = trustedTypes.createPolicy("require-server-header", {
  createHTML: (htmlText: string, response: Response) => {
    if (response.headers.get("X-Server-Sanitized") !== "sanitized=true") {
      // Note: this will reject the contents, but the error may be caught before it shows in the JS console.
      throw new Error("Rejecting HTML that was not marked by the server as sanitized.");
    }
    return htmlText;
  },
});
IncludeFragmentElement.setCSPTrustedTypesPolicy(policy);

注意:

  • 只有单一的政策可以制定,由所有人共享 IncludeFragmentElement 获取.
  • 你应该打电话 setCSPTrustedTypesPolicy() 在任何其他负载之前 include-fragment-element 在你的代码.
    • 如果您的政策本身需要同步工作来构建, 您也可以通过 Promise<TrustedTypePolicy>。 。 。 .
    • 过 null 以删除保险单.
  • 不是所有的浏览器 支持 JavaScript 中信任的 API 类型。您可能想要使用 建议的微量填充 构建一个不在其他浏览器中引起问题的策略.

与服务器侧的关联包括

这种宣示式方法与 SIS 导弹 或者说 ESI (欧洲证券交易所) 指令。 。 。 事实上,在实际交付客户之前,边缘执行可以取代标记.

<include-fragment src="/github/include-fragment/commit-count" timeout="100">
  <p>Counting commits…</p>
</include-fragment>

如果请求在超时前完成, 代理可能会试图取出并替换碎片 。 否则标签会交给客户端. 此库只执行客户端方面 .

浏览器支持

浏览器, 不本地 自定义元素支持 需要一个 多边填充. 后遗症浏览器需要各种其他多填充. 见 examples/index.html 详细情况.

  • 颜色
  • 火花
  • 萨法里
  • 微软边缘

发展

npm install
npm test

许可证

以麻省理工学院许可证分发。 详情见LICENSE.

版本与发布记录

@github/include-fragment-element 共发布 25 个版本,首次发布于 2019/05/23;过去 12 个月发布了 0 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
6.4.1latest2025/09/041.2 年前
6.4.02025/05/201.5 年前
6.3.02023/06/163 年前
6.2.12023/06/163 年前
6.2.02023/06/163 年前
6.1.12022/12/203 年前

其他发布通道:next → 5.1.2-0。

关于 @github/include-fragment-element 的常见问题

@github/include-fragment-element 是什么?

一个客户端包括标签 .

如何安装 @github/include-fragment-element?

在项目目录运行 npm install @github/include-fragment-element,或使用 pnpm add / yarn add / bun add。

@github/include-fragment-element 支持 TypeScript 吗?

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

@github/include-fragment-element 支持 ESM 还是 CommonJS?

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

@github/include-fragment-element 可以商用吗?

@github/include-fragment-element 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@github/include-fragment-element 的下载量有多少?

根据 npm 官方下载统计,@github/include-fragment-element 在 2026/10/17 – 2026/11/15 这 30 天内被下载 132,768 次,日均约 4,426 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@github/include-fragment-element 还在维护吗?

最新版本 6.4.1 发布于 2025/09/04(1.2 年前);至今共发布 25 个版本,其中过去 12 个月发布了 0 个;首次发布于 2019/05/23。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。