# @graphcms/zoid 中文文档

规范地址：https://npmcn.com/package/%40graphcms/zoid/

版本：9\.0\.64-alpha\.3
npm 元数据更新时间：2025-12-12T12:05:01.727Z
中文译文更新时间：2026-11-17T18:24:56.250Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40graphcms/zoid
原文对照：https://npmcn.com/package/%40graphcms/zoid/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.3 MB，36 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：4 个
- 首次发布：2021-02-22T17:25:28.701Z
- 最新版本发布：2022-01-20T10:08:32.771Z
- 近 30 天下载量：4592（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 0 个）

## 中文简介

交叉域组件.

## 安装

```sh
npm install @graphcms/zoid
```

也可以使用：`pnpm add @graphcms/zoid`、`yarn add @graphcms/zoid`、`bun add @graphcms/zoid`

## README

这是一个临时叉子,由 [图CMS](https://graphcms.com/) 满足一揽子计划的具体需要 [@ graphcms/ uix- sdk (英语)](https://www.npmjs.com/package/@graphcms/uix-sdk)。 。 。 . 请使用原始软件包/仓库 [krakenjs/动物](https://github.com/krakenjs/zoid) 改为:;

* * *

![](https://cdn.rawgit.com/krakenjs/zoid/master/zoid.png)

* * *

跨领域组件工具包,支持:

-   在不同的域上设定一个 Iframe 或弹出, 并传递道具, 包括对象和函数
-   从儿童窗口自家召回电话,而不担心后消息或跨域限制
-   创建并曝光组件, 将功能从您的站点共享到其它站点 !
-   将您的组件直接渲染为反应、 Vue 或 Angular 组件 !

这是“ 数据下调, 动作上调” 样式组件, 但100% 跨域使用 iframes 和弹出 !

* * *

### [API 文档](https://npmcn.com/package/%40graphcms/zoid/docs/api.md)

得到zoid支持的公开选择和方法

### [演示文稿](http://krakenjs.com/zoid/demo/index.htm)

不同zoid模式的工作演示

### [演示应用程序](https://github.com/krakenjs/zoid-demo)

有构建,测试,发布和演示预配置的可分叉演示应用.

### [示例](https://npmcn.com/package/%40graphcms/zoid/docs/example.md)

一个使用 zoid 的跨域组件的完整示例

* * *

### 快速实例

定义要放在父母和儿童页面上的组件:

```javascript
var MyLoginComponent = zoid.create({
  tag: "my-login-component",
  url: "http://www.my-site.com/my-login-component",
});
```

在主页上渲染组件 :

```javascript
<div id="container"></div>

<script src="script-where-my-login-component-is-defined.js"></script>
<script>
    MyLoginComponent({

        prefilledEmail: 'foo@bar.com',

        onLogin: function(email) {
            console.log('User logged in with email:', email);
        }

    }).render('#container');
</script>
```

执行iframe中的组件:

```javascript
<input type="text" id="email" />
<input type="password" id="password" />
<button id="login">Log In</button>

<script src="script-where-my-login-component-is-defined.js"></script>
<script>
    var email = document.querySelector('#email');
    var password = document.querySelector('#password');
    var button = document.querySelector('#login');

    email.value = window.xprops.prefilledEmail;

    function validUser (email, password) {
      return email && password;
    }

    button.addEventListener('click', function() {
        if (validUser(email.value, password.value)) {
            window.xprops.onLogin(email.value);
        }
    });
</script>
```

### 有用链接

-   [引入 zoid](https://medium.com/@bluepnume/introducing-zoid-seamless-cross-domain-web-components-from-paypal-c0144f3e82bf#.ikbg9r1ml)
-   [将您的 Web 应用程序转换为包含五行代码的跨域组件](https://medium.com/@bluepnume/turn-your-web-app-into-a-cross-domain-component-with-5-lines-of-code-ced01e6795f9#.w8ea7h6ky)
-   [如何执行和使用 ZOID 的全部实例](https://npmcn.com/package/%40graphcms/zoid/docs/example.md)
-   [使用 Zoid 构建 PayPal 按钮](https://medium.com/@bluepnume/less-is-more-reducing-thousands-of-paypal-buttons-into-a-single-iframe-using-zoid-d902d71d8875#.o3ib7y58n)
-   [PayPal 检查 - zoid 供电按钮和检查组件](https://github.com/paypal/paypal-checkout)
-   [后 Robot - 授权 Zoid 的跨域消息库](https://github.com/krakenjs/post-robot)
-   [执行 Zoid 视频教程](https://www.youtube.com/watch?v=UpXavGv7FaI)

#### 具体框架

-   [构建跨域反应组件](https://medium.com/@bluepnume/creating-a-cross-domain-react-component-with-zoid-fbcccc4778fd#.73jnwv44c)
-   [引入跨域 Glimer 组件支持, 并带有 zoid](https://medium.com/@bluepnume/introducing-support-for-cross-domain-glimmer-components-with-zoid-21287c9f91f1)

## 理由

**写入跨域组件很棘手 .**

考虑一下: 我拥有 `foo.com`你拥有 `bar.com`我想在你的页面上分享一些功能. 我可以给你一些Javascript来装入你的页面。 但后来:

-   如果我在React中写了一个组件, 但你在使用其他的框架呢?
-   如果我有安全的表型字段 或者安全的数据... ...我不想让你的网站监视呢?
-   如果我需要打个安全电话给我的后端, 而不诉诸CORS呢?

**那Iframe怎么办?**

你可以用香草来做这一切 不过:

-   您必须在url中传递数据,或者使用后信息.
-   需要设置后消息听众 让事件从孩子恢复.
-   您需要处理出错的情况, 就像您的 Iframe 无法加载或者不响应后消息 .
-   你需要仔细思考如何在简单清晰的界面背后暴露所有这些功能.

**佐德解决了所有这些问题.**

-   您将数据传递给下调为 Javascript 对象
-   zoid 制作组件并传递数据
-   等孩子准备好了再打给你

它甚至会自动生成 React 和 Angular 绑定, 这样人们就可以在任何地方,而不是 担心iframes或后消息.

## 财务问题

-   **我需要使用像React这样的特定框架来使用zoid吗?**
    
    不,zoid是框架不可知论。 你可以这样:
    
    -   以香草为用.
    -   用任何你选择的框架.
    -   与 React 或 Angular 一起使用,并利用主页上的自动绑定
-   **为什么要写另一个 ui / 组件库 ?**
    
    这不是用来取代像React这样的负责渲染同域组件的库. 事实上,唯一的 真正的渲染Zoid的确是 Iframes and popups;其余的由你决定! 你可以使用任何框架构建你的组件, 库或图案,然后使用zoid来曝光您的组件跨域。 它应该很好地发挥 任何其他的框架!
    
-   **Iframes真的慢吗?**
    
    是的,但这里有一些事情需要记住:
    
    -   zoid不是用来为自己的场地建造组件的 为此,您应该使用本地组件库 像反应, 它使快速在你的页面。 使用 zoid 与其他站点共享功能, 您无法共享 共享本地- javascript 组件
        
    -   zoid还提供了将 html 和 css 预先放入 iframes 和 popups 的机制,所以你至少可以制取一个 装入自旋器, 或者更高级的东西, 而新的窗口加载其内容.
        
-   **我不想打扰到弹出, 我能得到Zoid 只要iframe支持?**
    
    当然可以 有一个 `zoid.frame.js` 财务报告和审定财务报表 `zoid.frame.min.js` 输入 `dist/` 文件夹。 还有很多 魔法需要让弹出物与IE相通,这些都修剪了.
    
-   **我可以贡献吗?**
    
    当然了! 但请先提出一个问题,如果它不只是一个小的改变,来讨论可行性.
    
-   **这不一样吗 [反应框架组件](https://github.com/ryanseddon/react-frame-component)? 吗?**
    
    对. `react-frame-component` 允许您将 html 渲染成同一域上的沙盒 iframe . `zoid` 定位为 在跨域的iframe中,将功能从一个域共享到另一个域.
    

## 浏览器支持

-   互联网探索者 9+
-   颜色 27+
-   Firefox 30+ (英语)
-   萨法里5.1+
-   歌剧院 23+

## 常见问题

### @graphcms/zoid 是什么？

交叉域组件\.

### 如何安装 @graphcms/zoid？

在项目目录运行 npm install @graphcms/zoid，或使用 pnpm add / yarn add / bun add。

### @graphcms/zoid 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/graphcms\_\_zoid 是否存在。

### @graphcms/zoid 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @graphcms/zoid 可以商用吗？

@graphcms/zoid 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @graphcms/zoid 的下载量有多少？

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

### @graphcms/zoid 还在维护吗？

最新版本 9\.0\.64-alpha\.3 发布于 2022/01/20（4 年前）；至今共发布 5 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/02/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

