Caputchin
集成指南

客户端集成

组件是一个小小的包,@caputchin/widget,它会注册 <caputchin-widget><caputchin-game> 自定义元素。把它放到你页面上有两种方式。按你的站点有没有构建步骤来选。

Script 标签(CDN)

没有构建步骤,一个纯 HTML 或服务端渲染的页面?直接从 jsDelivr CDN 加载它:

<script src="https://cdn.jsdelivr.net/npm/@caputchin/widget@3/dist/widget.js"></script>

那个 @3 把当前的主版本钉住,于是你拿到修复和新游戏,而不会冒出意外的破坏性变更。把那一行放进你的 <head>(或就在 </body> 之前),元素就为整个页面注册好了。

npm(ESM)

有一个打包器(Vite、webpack、Next.js 等等)?安装这个包,并在启动时导入它一次:

npm install @caputchin/widget
import "@caputchin/widget";

这个导入不暴露任何可调用的东西;它运行是为了它注册自定义元素的副作用。把它放在你的应用入口里,让它在任何 <caputchin-widget> 渲染之前运行。

用哪一个?

  • 没有构建步骤(纯 HTML,一个服务端渲染的模板):用 script 标签。它就是一行里的整套集成。
  • 一个打包后的应用(React、Vue 以及其余):用 npm 导入。它随你的 lockfile 一起版本化,并避免一个阻塞渲染的外部请求。

无论哪种方式,元素以及下游的一切(注入的令牌、你的服务器检查)都完全相同。唯一改变的,是这个包如何到达。

另见

本页内容