@captchafox/vue

中文文档
1.7.0发布于 2026/06/30MITTypeScriptESM + CJS构建来源已验证近 30 天下载 2600

NPM version

中文使用文档
文档目录6 节
  1. 安装
  2. 使用量
  3. 道具
  4. 使用验证回调
  5. 使用虚拟模式
  6. 与实例互动

@ captchafox/ veue (签名)

NPM version

安装

使用您喜欢的软件包管理器安装库

npm install @captchafox/vue
yarn add @captchafox/vue
pnpm add @captchafox/vue
bun add @captchafox/vue

使用量

<script setup lang="ts">
import { CaptchaFox } from '@captchafox/vue';
</script>

<template>
  <CaptchaFox sitekey="sk_11111111000000001111111100000000" />
</template>

(可选)注册整个应用(如. main.ts(中文(简体) )

import { CaptchaFox } from '@captchafox/vue';
import App from './App.vue';

const app = createApp(App)
    .component('CaptchaFox', CaptchaFox);
    .mount('#app');

道具

Prop类型说明需求
站台密钥string部件的站点密钥 .✅
朗语string部件应显示的语言 。 默认自动检测它.
模式inline|popup|hidden部件要显示的模式 .
开始none|auto|focus核查开始时的控制。 默认为 none。 。 。 .
主题light | dark | ThemeDefinition部件的主题 。 默认为光.
无string随机生成非ce.
i18n (英语)object自定义i18n配置.
隐藏boolean隐藏关闭按钮并阻止用户关闭部件模式.
认证function在成功核实后,以响应符号调用.
失败function在核查失败后打电话.
错误function当错误发生时调用 .
结束function当挑战结束时召唤.
关闭function当挑战结束时打电话来.

使用验证回调

<script setup lang="ts">
import { CaptchaFox, CAPTCHA_RESPONSE_KEY } from '@captchafox/vue';

const handleVerify = (token: string) => {
  // do something with the token here (e.g. submit the form)
  const formData = {
    // your form data
    [CAPTCHA_RESPONSE_KEY]: token
  };
};
</script>

<template>
  <CaptchaFox sitekey="sk_11111111000000001111111100000000" @verify="handleVerify" />
</template>

使用虚拟模式

<script setup lang="ts">
import { CaptchaFox, CAPTCHA_RESPONSE_KEY } from '@captchafox/vue';

// contains response token after successful verification
const token = ref<string>();
</script>

<template>
  <CaptchaFox sitekey="sk_11111111000000001111111100000000" v-model="token" />
  <pre>{{ token }}</pre>
</template>

与实例互动

<script setup lang="ts">
import { CAPTCHA_RESPONSE_KEY, CaptchaFox, CaptchaFoxInstance } from '@captchafox/vue';
import { ref } from 'vue';

const captchafox = ref<CaptchaFoxInstance | null>(null);

const triggerAction = async () => {
  // execute the captcha
  try {
    const token = await captchafox.value?.execute();
  } catch {
    // unsuccessful verification
  }
};
</script>

<template>
  <CaptchaFox ref="captchafox" sitekey="sk_11111111000000001111111100000000" />
  <button @click="triggerAction">Action</button>
</template>

您可以在 GitHub 仓库。 。 。 .

版本与发布记录

@captchafox/vue 共发布 9 个版本,首次发布于 2023/06/20;过去 12 个月发布了 2 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.7.0latest2026/06/304 个月前
1.6.02026/04/206 个月前
1.5.02025/09/041.2 年前
1.4.02025/02/181.7 年前
1.3.02024/09/122 年前
1.2.02024/06/092 年前

关于 @captchafox/vue 的常见问题

如何安装 @captchafox/vue?

在项目目录运行 npm install @captchafox/vue,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:vue(^3.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@captchafox/vue 支持 TypeScript 吗?

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

@captchafox/vue 支持 ESM 还是 CommonJS?

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

@captchafox/vue 可以商用吗?

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

@captchafox/vue 的下载量有多少?

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

@captchafox/vue 还在维护吗?

最新版本 1.7.0 发布于 2026/06/30(4 个月前);至今共发布 9 个版本,其中过去 12 个月发布了 2 个;首次发布于 2023/06/20。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。