# @blockprotocol/hook 中文文档

规范地址：https://npmcn.com/package/%40blockprotocol/hook/

版本：0\.1\.8
npm 元数据更新时间：2024-06-30T15:26:46.702Z
中文译文更新时间：2026-11-08T07:28:17.649Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40blockprotocol/hook
原文对照：https://npmcn.com/package/%40blockprotocol/hook/?lang=original
项目主页：https://blockprotocol.org/
源码仓库：https://github.com/blockprotocol/blockprotocol

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

- 包体积（解压后）：99.5 kB，23 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：react ^18\.0\.0
- 首次发布：2022-08-01T13:26:31.638Z
- 最新版本发布：2024-03-19T12:56:01.068Z
- 近 30 天下载量：24391（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：83（近 12 个月 0 个）

## 中文简介

实施区块和嵌入应用的区块议定书Hook模块规格

## 安装

```sh
npm install @blockprotocol/hook
```

也可以使用：`pnpm add @blockprotocol/hook`、`yarn add @blockprotocol/hook`、`bun add @blockprotocol/hook`

## README

## 块状协议-虎克模块

这个软件包为块和嵌入应用执行"块协议钩"模块.

要开始 :

1.  `yarn add @blockprotocol/hook` 或者说 `npm install @blockprotocol/hook`
2.  遵循使用钩子模块的指令 [块](https://npmcn.com/package/%40blockprotocol/hook/#readme-blocks) 或一个 [嵌入应用程序](https://npmcn.com/package/%40blockprotocol/hook/#readme-embedding-applications)

## 块

创建 `HookBlockHandler`中,将构造器传递到您块中的元素,以及您想要注册的用于处理来信的任何调用.

为了发出一个钩子信息,你叫 `hook` 函数.

```typescript
import { HookBlockHandler } from "@blockprotocol/hook";

const handler = new HookBlockHandler({ element });

handler.hook({
  data: {
    hookId: null, // the embedding application will provide a hookId in response to use in future messages
    node, // a reference to the DOM node to render into
    type: "text", // the type of hook
    entityId: "entity1", // the id of the entity this hook will show/edit data for
    path: ["http://example.com/property-type/text/"], // the path in the entity's properties data will be taken from/saved to
  },
});
```

### 反应示例

对于反应,我们提供 `useHookBlockModule` 钩子,它接受 `ref` 到一个元素。 这将返回对象的形状为 `{ hookModule: HookBlockHandler | null }` 用于发送钩状信息.

我们还提供 `useHook` 钩子可以让发送钩子信息更容易.

```typescript
import { useHook } from "@blockprotocol/hook/react";

useHook(
  hookModule,
  nodeRef,
  "text",
  ["http://example.com/property-type/text/"],
  (node) => {
    node.innerText = "hook fallback";

    return () => {
      node.innerText = "";
    };
  },
);
```

何处 `nodeRef` 是一个 `RefObject` 包含您想要传递到嵌入应用程序的 DOM 节点 .

### 自定义元素示例

你可以用这个 `firstUpdate` 升 [生命周期钩](https://lit.dev/docs/components/lifecycle/#reactive-update-cycle-completing) 请求嵌入应用程序接管DOM节点的控制.

```typescript
export class MyBlock extends BlockElementBase {
  private hookModule?: HookBlockHandler;

  firstUpdated() {
    if (!this.hookModule || this.hookModule.destroyed) {
      this.hookModule = new HookBlockHandler({
        element: this,
      });
    }

    const paragraph = this.renderRoot.querySelector(`#my-hook-paragraph`);
    if (!paragraph || !(paragraph instanceof HTMLParagraphElement)) {
      throw new Error("No paragraph element for hook module found in element DOM");
    }

    void this.hookModule.hook({
      data: {
        node: paragraph,
        entityId: this.getBlockEntity()?.metadata.recordId.entityId,
        hookId: null,
        path: [extractBaseUrl(propertyTypes.description.$id)],
        type: "text",
      },
    });
  }

  render() {
    return html`
      <p id="my-hook-paragraph"></p>
    `;
  }
```

## 嵌入应用程序

创建 `HookEmbedderHandler`,通过构造器:

1.  一个 `element` 包装您的块
2.  `callbacks` 以响应块中的信息
3.  您执行的以下信件的起始值 :

-   `hook`

```typescript
import { HookEmbedderHandler } from "@blockprotocol/hook";

const hookIds = new WeakMap<HTMLElement, string>();
const nodes = new Map<string, HTMLElement>();

const generateId = () => (Math.random() + 1).toString(36).substring(7);

const hookModule = new HookEmbedderHandler({
  callbacks: {
    hook({ data }) {
      if (data.hookId) {
        const node = nodes.get(data.hookId);

        if (node) node.innerText = "";
        nodes.delete(data.hookId);
      }

      const hookId = data.hookId ?? generateId();

      if (data.node) {
        nodes.set(hookId, data.node);
        data.node.innerText = `Hook of type ${data.type} for path ${data.path}`;
      }

      return { hookId };
    },
  },
  element: elementWrappingTheBlock,
});
```

### 反应

对于反应嵌入应用程序,我们提供一个 `useHookEmbedderModule` 钩子,它接受 `ref` ,以及您想要通过的任何附加构造参数.

```tsx
import { useHookEmbedderModule } from "@blockprotocol/hook/react";
import { useRef } from "react";

export const App = () => {
  const wrappingRef = useRef<HTMLDivElement>(null);

  useHookEmbedderModule(blockRef, {
    hook({ data }) {
      // As above
    },
  });

  return (
    <div ref={wrappingRef}>
      <Block />
    </div>
  );
};
```

## 常见问题

### @blockprotocol/hook 是什么？

实施区块和嵌入应用的区块议定书Hook模块规格

### 如何安装 @blockprotocol/hook？

在项目目录运行 npm install @blockprotocol/hook，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @blockprotocol/hook 支持 TypeScript 吗？

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

### @blockprotocol/hook 支持 ESM 还是 CommonJS？

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

### @blockprotocol/hook 可以商用吗？

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

### @blockprotocol/hook 的下载量有多少？

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

### @blockprotocol/hook 还在维护吗？

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