# @aacn\.eu/use-friendly-captcha 中文文档

规范地址：https://npmcn.com/package/%40aacn.eu/use-friendly-captcha/

版本：1\.3\.0
npm 元数据更新时间：2024-02-20T13:41:33.991Z
中文译文更新时间：2026-11-05T20:46:37.457Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：47.9 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：friendly-challenge ^0\.9\.11，react \>=17\.0\.2，react-dom \>=17\.0\.2，tailwindcss \>=3\.1\.8
- 首次发布：2022-12-09T23:24:48.031Z
- 最新版本发布：2024-02-20T13:41:33.558Z
- 近 30 天下载量：24513（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 0 个）

## 中文简介

友好Captcha反应执行

## 安装

```sh
npm install @aacn.eu/use-friendly-captcha
```

也可以使用：`pnpm add @aacn.eu/use-friendly-captcha`、`yarn add @aacn.eu/use-friendly-captcha`、`bun add @aacn.eu/use-friendly-captcha`

## README

# 使用友好的 Captcha 钩头

## 使用量

库有前端和后端的功能. 两人各自独立工作.

### 前端

包含 `useCaptchaHook()` 在选中文件中。 从那里可以查询部件 从钩子上写出来 让你用你的形式来管理和使用.

请注意 `friendly-challenge` 库是自1.2.0版本以来必要的对等依赖

**钩子预期以下属性:**  

```
siteKey: string;
endpoint?: FC_PUZZLE_EP; enum for the currently available endpoints (EU & global)
language?: keyof typeof localizations | Localization;
startMode?: "auto" | "focus" | "none";
showAttribution: boolean;
```

  
**钩子提供以下参数:**  
\- \`CaptchaWidget' 返回 HTML 认证部件. - \`Captcha Status.Solution'用于确定谜题是否已解决(\`string')或未解决(\`null') - \`captchastatus.error'用于确定在解决(\`string')或未解决(\`null')时发生的错误

  
**CaptchaWidget 自定义道具**  
当 `CaptchaWidget` ,您可以添加额外的属性 :  
  
`props: HTMLAttributes` 这包括所有可能的html属性. 因此,这是添加 `className` 属性, 将自定义样式添加到外侧 Captcha 容器。 您可以在此直接添加 TailwindCSS 类或定义自定义类 项目的.css文件中的未来样式.  
  
`customWidgetStyle` 允许直接适用于组件的特定样式最多有三个属性:

-   `icon` 部件的图标
-   `button` 部件的提交按钮
-   `text` 部件内的所有文本元素  
    这些属性都是可选的,如果使用的话,它们期望一个cs对象像下面的例子:

```js
CustomWidgetStyle = { icon: {color: "green", background: "yellow"}, text: {color: "blue"} }
```

### 后端

后端明智 此库提供了使用 Fellower Captcha 校验的函数 API 检查所提交的拼图解是否有效 。 它还原出一个布尔来继续 处理您自己的代码.

**该函数期望以下属性:**  

```
endpoint?: FC_VERIFICATION_EP; enum for the currently available endpoints (EU & global)
solution: string;
secret: string;
sitekey?: string;
httpPostFetcher: (see further down)
```

### httpstFetcher 页面

后端期望获取器函数为参数 。 此功能由用户提供 并用于向 fc 校验服务器发送 http post 请求。 它应该符合以下设计:

```
function fetcherExample(
    endpoint: string,
    requestBody: { solution: string; secret: string; siteKey: string },
    headers: { 'Content-Type': 'application/json'; 'Accept': 'application/json'; }
) => Promise<{ success: boolean; errors: any; } | null>
```

### 实例

我们提供了以下基本例子: `/examples` 文件夹,关于如何使用此库 [反应](https://github.com/aacn/use-friendly-captcha/tree/main/examples/react-example) 财务报告和审定财务报表 [下一个js](https://github.com/aacn/use-friendly-captcha/tree/main/examples/nextjs)。 。 。 . 这两个示例都用TypeScript来书写,并保持了简单易读,从此库中呈现函数的效用. 如果您想要运行您的机器上的例子, 请确保读取相应的 README 文件, 增加所有需要.

## 常见问题

### @aacn\.eu/use-friendly-captcha 是什么？

友好Captcha反应执行

### 如何安装 @aacn\.eu/use-friendly-captcha？

在项目目录运行 npm install @aacn\.eu/use-friendly-captcha，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：friendly-challenge（^0\.9\.11）、react（\>=17\.0\.2）、react-dom（\>=17\.0\.2）、tailwindcss（\>=3\.1\.8）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aacn\.eu/use-friendly-captcha 支持 TypeScript 吗？

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

### @aacn\.eu/use-friendly-captcha 支持 ESM 还是 CommonJS？

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

### @aacn\.eu/use-friendly-captcha 可以商用吗？

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

### @aacn\.eu/use-friendly-captcha 的下载量有多少？

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

### @aacn\.eu/use-friendly-captcha 还在维护吗？

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