# @assistant-ui/react-hook-form 中文文档

规范地址：https://npmcn.com/package/%40assistant-ui/react-hook-form/

版本：0\.12\.38
npm 元数据更新时间：2026-10-28T00:51:02.338Z
中文译文更新时间：2026-11-07T00:32:29.958Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：85.3 kB，18 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：react ^18 \|\| ^19，@types/react \*，react-hook-form ^7
- 首次发布：2024-06-16T19:14:33.453Z
- 最新版本发布：2026-10-28T00:51:01.967Z
- 近 30 天下载量：4525（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：104（近 12 个月 45 个）

## 中文简介

助理- ui 反应 Hook 格式集成

## 安装

```sh
npm install @assistant-ui/react-hook-form
```

也可以使用：`pnpm add @assistant-ui/react-hook-form`、`yarn add @assistant-ui/react-hook-form`、`bun add @assistant-ui/react-hook-form`

## README

# `@assistant-ui/react-hook-form`

[反应钩形](https://react-hook-form.com/) 合并 `@assistant-ui/react`替换 `useForm` 与 `useAssistantForm` 通过工具调用,使助手能够读取和填充表格字段.

## 安装

```bash
npm install @assistant-ui/react @assistant-ui/react-hook-form react-hook-form
```

## 使用量

```tsx
"use client";

import { useAssistantForm } from "@assistant-ui/react-hook-form";

export function SignupForm() {
  const form = useAssistantForm({
    defaultValues: { firstName: "", lastName: "", email: "" },
    assistant: {
      tools: {
        set_form_field: { render: () => <FieldUpdated /> },
      },
    },
  });

  return <form onSubmit={form.handleSubmit(onSubmit)}>{/* fields */}</form>;
}
```

助理获得三个内置工具: `set_form_field` 将值写入字段, `submit_form` 呼叫您的提交处理器,以及 `reset_form` 以恢复初始值。 提交和重置默认请求用户批准 。 自定义工具渲染必须处理待决中断和调用 `resume({ approved: true })` 或者说 `resume({ approved: false })`设置 `assistant.tools.submit_form.requireApproval` 或者说 `assistant.tools.reset_form.requireApproval` 改为 `false` 无需询问即可运行该工具。 跑步时不需要人力支援 `requireApproval: false` 这些工具。 与模型共享的窗体状态省略密码输入和字段 `current-password`, (中文(简体) ), `new-password`, (中文(简体) ), `one-time-code`,或 `cc-` 自动补全值。 使用 `assistant.sensitiveFields` 排除DOM检测无法识别的字段,包括没有挂载输入的字段.

## 另见

-   `@assistant-ui/react-lexical` 如果您还想要一个富于文字的作曲家 `@`\- 同一聊天室里有心理支持 - 什么.

被引导走过的生活 [助理-ui.com/示例/表格-演示](https://www.assistant-ui.com/examples/form-demo)。见 [`examples/with-react-hook-form`](https://github.com/assistant-ui/assistant-ui/tree/main/examples/with-react-hook-form) 一个完整的应用程序.

## 常见问题

### @assistant-ui/react-hook-form 是什么？

助理- ui 反应 Hook 格式集成

### 如何安装 @assistant-ui/react-hook-form？

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

### @assistant-ui/react-hook-form 支持 TypeScript 吗？

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

### @assistant-ui/react-hook-form 支持 ESM 还是 CommonJS？

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

### @assistant-ui/react-hook-form 可以商用吗？

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

### @assistant-ui/react-hook-form 的下载量有多少？

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

### @assistant-ui/react-hook-form 还在维护吗？

最新版本 0\.12\.38 发布于 2026/10/28（10 天前）；至今共发布 104 个版本，其中过去 12 个月发布了 45 个；首次发布于 2024/06/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。