@github/template-parts

中文文档
0.7.1发布于 2024/12/15MITTypeScriptES Module零依赖近 30 天下载 8735
中文使用文档

模板部件

这个库被设计成一个"poyfill"的库,在其中执行设计 Template Instance 提议什么wg spec 已提议解决 什么wg/html#2254。 。 。 .

这样做可以执行提案中最低可行部分,以便提供行之有效的东西,但如果模板部分提案落地,就应容易减少.

重申上述提案中的例子,并提供一个模板,例如:

<template id="foo">
  <div class="foo {{y}}">{{x}} world</div>
</template>

我们想 {{x}} 财务报告和审定财务报表 {{y}} 将会是 模板部件,作为 JavaScript 可被操纵的对象曝光.

有了这个库和给定的模板,就可以执行以下内容:

import {TemplateInstance} from '@github/template-parts'

const tpl = new TemplateInstance(document.getElementById('some-template'), { x: 'Hello', y: 'bar'})

document.appendChild(tpl)

A 类 TemplateInstance 实例是 DocumentFragment - 包含模板的克隆内容。 也有一个 update(params: unknown): void 方法 - 当调用时将运行给定的“ 处理器”, 并使用新的 params。 。 。 .

这个库有一个默认的"处理器": propertyIdentity 执行将参数对象值应用到模板部件的基本功能(它有效) part.value = params[part.expression](中文(简体) )

此外,还有一个 propertyIdentityOrBooleanAttribute 导出可增加转动能力 boolean 样式属性如 hidden 或者说 input.required。 。 。 .

用来使用 propertyIdentityOrBooleanAttribute,将其导入并传递给 TemplateInstance 构造器 :

import {TemplateInstance, propertyIdentityOrBooleanAttribute} from '@github/template-parts'

// This will simply replace `{{x}}` with `"Hello"` and `{{y}}` with `"bar"`
const tpl = new TemplateInstance(document.getElementById('foo'), { x: 'Hello', y: 'bar'})

// The `propertyIdentityOrBooleanAttribute` processor will check for `false`/`true` values which map to Template Part values that are assigned to attributes, and add/remove the attribute.
const tpl = new TemplateInstance(document.getElementById('foo'), { x: 'Hello', hidden: false}, propertyIdentityOrBooleanAttribute)

版本与发布记录

@github/template-parts 共发布 23 个版本,首次发布于 2020/07/31;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.7.1latest2024/12/151.9 年前
0.7.02024/12/131.9 年前
0.6.32024/12/131.9 年前
0.6.22024/12/091.9 年前
0.6.12024/12/031.9 年前
0.6.02024/12/032 年前

关于 @github/template-parts 的常见问题

@github/template-parts 是什么?

实施模板创新建议https://github.com/w3c/web组件/blob/159b1600bab02fe9cd794825440a98537d53b389/提议/Template-Institution.md(中文(简体) )

如何安装 @github/template-parts?

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

@github/template-parts 支持 TypeScript 吗?

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

@github/template-parts 支持 ESM 还是 CommonJS?

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

@github/template-parts 可以商用吗?

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

@github/template-parts 的下载量有多少?

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

@github/template-parts 还在维护吗?

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