让开源，少一点语言距离。
npm包中文文档

@api-viewer/docs

中文文档
1.0.0-pre.10发布于 2024/04/05MITTypeScriptES Module近 30 天下载 1.5万

Web 组件的 API 文档查看器

中文使用文档
中文原文

@api-viewer/docs

Web 组件的 API 文档 。 依据 自定义元素显示 JSON格式.

<api-docs src="./custom-elements.json"></api-docs>

文 件 ∗∗

生活节日

Screenshot of api-viewer docs

安装

npm install @api-viewer/docs

看看这个 开始 向导.

特征

  • 属性 - 部分公开披露JS财产.
  • 属性 - HTML 属性(与属性相匹配的属性除外).
  • 活动 - 部门派出的DOM活动.
  • 槽数 - 默认 <slot> 和/或指定空档,如果有的话.
  • CSS 自定义属性 - 组件的造型API.
  • CSS 阴影部件 - 可以使用的元素 ::part()。 。 。 .

版本与发布记录

@api-viewer/docs 共发布 10 个版本，首次发布于 2022/01/01；过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.0-pre.10latest2024/04/052 年前
1.0.0-pre.92023/11/033 年前
1.0.0-pre.82023/07/213 年前
1.0.0-pre.72022/11/233 年前
1.0.0-pre.62022/04/074 年前
1.0.0-pre.52022/01/284 年前

其他发布通道：pre → 1.0.0-pre.1。

关于 @api-viewer/docs 的常见问题

@api-viewer/docs 是什么？

Web 组件的 API 文档查看器

如何安装 @api-viewer/docs？

在项目目录运行 npm install @api-viewer/docs，或使用 pnpm add / yarn add / bun add。

@api-viewer/docs 支持 TypeScript 吗？

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

@api-viewer/docs 支持 ESM 还是 CommonJS？

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

@api-viewer/docs 可以商用吗？

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

@api-viewer/docs 的下载量有多少？

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

@api-viewer/docs 还在维护吗？

最新版本 1.0.0-pre.10 发布于 2024/04/05（2 年前）；至今共发布 10 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/01/01。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。