# @formspark/use-formspark 中文文档

规范地址：https://npmcn.com/package/%40formspark/use-formspark/

版本：1\.0\.2
npm 元数据更新时间：2026-08-03T19:05:25.731Z
中文译文更新时间：2026-11-15T09:13:07.952Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：10.6 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0
- 首次发布：2020-11-13T18:32:16.629Z
- 最新版本发布：2026-08-03T19:05:25.378Z
- 近 30 天下载量：97500（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：35（近 12 个月 2 个）

## 中文简介

形式 Park 的反应钩

## 安装

```sh
npm install @formspark/use-formspark
```

也可以使用：`pnpm add @formspark/use-formspark`、`yarn add @formspark/use-formspark`、`bun add @formspark/use-formspark`

## README

[![Formspark logo](https://cdn.formspark.io/images/formspark/logos/formspark.svg)](https://formspark.io/)

# 使用窗体窗口

反应钩 [窗体参数](https://formspark.io/)。 。 。 .

与React和React Industrial合作.

[![Deploy](https://github.com/formspark/use-formspark/workflows/Deploy/badge.svg)](https://github.com/formspark/use-formspark/actions?query=workflow%3ADeploy)

## 安装

```bash
# NPM
npm install @formspark/use-formspark

# Yarn
yarn add @formspark/use-formspark
```

要求反应出18或19和节点.js 18或更新.

## 使用量

```tsx
import React, { useState } from "react";
import { useFormspark } from "@formspark/use-formspark";

const ContactForm = () => {
  const [submit, submitting] = useFormspark({
    formId: "your-form-id"
  });
  const [message, setMessage] = useState("");
  return (
    <form onSubmit={async (e) => {
        e.preventDefault();
        await submit({ message });
    }}>
      <textarea
        value={message}
        onChange={(e) => setMessage(e.target.value)}
      />
      <button type="submit" disabled={submitting}>Send</button>
    </form>
  );
};
```

**说明:** 不要混淆表单的动作 URL(例如. `https://submit-form.com/capybara`)与表单ID(例如. `capybara`) (中文(简体) ). 此软件包只使用后者 .

## 处理错误

`submit` 丢出一个 `FormsparkError` 当服务器以非-2xx状态响应时. 错误带有 HTTP 状态和响应正文, 尽可能解析为 JSON, 否则保留为原始文本 .

```ts
import { useFormspark, FormsparkError } from "@formspark/use-formspark";

try {
  await submit({ message });
} catch (error) {
  if (error instanceof FormsparkError) {
    console.error(error.status, error.body);
  }
}
```

## 许可证

[麻省理工学院](https://opensource.org/licenses/MIT)

## 常见问题

### @formspark/use-formspark 是什么？

形式 Park 的反应钩

### 如何安装 @formspark/use-formspark？

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

### @formspark/use-formspark 支持 TypeScript 吗？

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

### @formspark/use-formspark 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @formspark/use-formspark 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @formspark/use-formspark 可以商用吗？

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

### @formspark/use-formspark 的下载量有多少？

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

### @formspark/use-formspark 还在维护吗？

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

