@hcaptcha/vue3-hcaptcha

中文文档
1.3.0发布于 2023/07/29MITTypeScriptESM + CJS近 30 天下载 21.3万

h Vue.js 的 Captcha 组件库。 与Vue 2和3相兼容.

中文使用文档
文档目录17 节
  1. 安装
  2. 基本用途
  3. JS API( API)
  4. 道具
  5. 回调事件
  6. 方法
  7. 财务问题
  8. 我怎么能有钥匙?
  9. 什么是hCaptcha吗?
  10. 博特分数和无CAPTCHA/被动模式等特性是否也可用?
  11. 演示
  12. 类型脚本
  13. 开发者的说明
  14. 脚本
  15. 维护者的注释
  16. 出版
  17. 贡献 + 显著贡献者

Vue.js h Captcha 组件库

h Vue.js 的 Captcha 组件库。 与Vue 2和3相兼容.

安装

您可以通过 npm 安装此库 :

  • vue2 (英语) npm install @hcaptcha/vue-hcaptcha --save
  • vue3 : (中文(简体) ) npm install @hcaptcha/vue3-hcaptcha --save

或通过纱线:

  • vue2 (英语) yarn add @hcaptcha/vue-hcaptcha
  • vue3 : (中文(简体) ) yarn add @hcaptcha/vue3-hcaptcha

或通过脚本标记( r)Vue (必须在全球范围内提供)

  • 阴道2
    <script src="https://unpkg.com/vue@2"></script>
    <script src="https://unpkg.com/@hcaptcha/vue-hcaptcha"></script>
    
  • 页:1
    <script src="https://unpkg.com/vue@3"></script>
    <script src="https://unpkg.com/@hcaptcha/vue3-hcaptcha"></script>
    

基本用途

  • vue2 (英语)

    <template>
        <vue-hcaptcha sitekey="**Your sitekey here**"></vue-hcaptcha>
    </template>
    
    <script>
      import VueHcaptcha from '@hcaptcha/vue-hcaptcha';
      export default {
        ...
        components: { VueHcaptcha }
      };
    </script>
    
  • vue3 : (中文(简体) )

    <template>
        <vue-hcaptcha sitekey="**Your sitekey here**"></vue-hcaptcha>
    </template>
    
    <script setup>
      import VueHcaptcha from '@hcaptcha/vue3-hcaptcha';
    </script>
    

该组件会自动加载hCaptcha API库并附加到根组件中.

JS API( API)

道具

名称数值/类型需求默认说明
sitekey字符串对-你的钥匙 请访问 h 卡普察语Name 并注册得到一个站台钥匙.
size字符串( 正常、 紧凑、 无形)没有normal此指定复选框的"大小" 。 hCaptcha允许您在渲染时决定组件将显示多大 。 默认为正常.
theme弦( 光, 暗)没有lighth Captcha 支持光和暗的主题。 如果没有设定主题, API 将默认为发光 .
tabindex整数没有0设置部件和弹出的标签索引 。 在适当情况下,这可以使您的网站的导航更直观.
language字符串(ISO 639-2代码)没有autohCaptcha通过用户浏览器自动检测语言. 它覆盖了设置默认的 UI 语言 .
reCaptchaCompat布尔没有true禁止对 reCAPTCHA 进行即时替换 false 防止h Captcha注射入窗口。 克丽卡.
challengeContainer字符串没有-一个自定义元素 ID 来完成 hCaptcha 挑战 .
rqdata字符串没有- 说吧见企业文件.
sentry布尔没有- 说吧见企业文件.
custom布尔没有- 说吧见企业文件.
apiEndpoint字符串没有- 说吧见企业文件.
endpoint字符串没有- 说吧见企业文件.
reportapi字符串没有- 说吧见企业文件.
assethost字符串没有- 说吧见企业文件.
imghost字符串没有- 说吧见企业文件.

回调事件

活动参数说明
errorerr当出错时。 组件在出错后将立即重置 .
verifytoken, eKey当挑战完成时。 这个 token 还有一个 eKey 被传递.
expired- 说吧当当前符号过期时 .
challengeExpired- 说吧当未完成的挑战到期时.
opened- 说吧当挑战打开.
closed- 说吧当挑战结束.
reset- 说吧当挑战被重置时.
rendered- 说吧当挑战提出时.
executed- 说吧当挑战被执行时.

方法

方法说明
execute()程序引发质疑请求
executeAsync()类似 execute 但它返回一个 Promise。 。 。 .
reset()重置当前的挑战

财务问题

我怎么能有钥匙?

报名到 h 卡普察语Name 去拿你的车钥匙 检查 文档 更多信息.

什么是hCaptcha吗?

h 卡普察语Name 帮助公司获得数据标签.

博特分数和无CAPTCHA/被动模式等特性是否也可用?

是,企业版:见 h Captcha 企业( 停止) 详细情况.

演示

Demo

运行演示:

  1. 复制此 repo git clone https://github.com/hCaptcha/vue-hcaptcha.git
  2. cd examples/traditional-vue2
  3. yarn && yarn serve
    • 它会在本地主机: 8080启动演示应用
    • 打开您的控制台查看演示应用程序发布事件

类型脚本

支持类型脚本 。 您可以看到两者的示例应用程序 vue2 财务报告和审定财务报表 vue3 内 examples 目录.

开发者的说明

脚本

  • yarn lint - 检查出问题
  • yarn test - 测试 vue2 和 vue3 软件包
  • yarn build - 将建立生产vue2,3版本

维护者的注释

出版

要出版新版本,请遵循下一步:

  1. 跳出两种版本: vue2/package.json 财务报告和审定财务报表 vue3/package.json (保持同步)
  2. 填充 CHANGES.md 有更改细节
  3. 推变化为主.

贡献 + 显著贡献者

vue-hcaptcha 通过卡普查社区的集体努力发展和维持.

包括你这样的开发者! 我们欢迎你的问题、建议和公关.

较大变化的显著贡献者:

  • Vue2 支援: h Captcha 团队
  • Vue3 支持: JDinABox 和 DSergiu

版本与发布记录

@hcaptcha/vue3-hcaptcha 共发布 8 个版本,首次发布于 2021/10/19;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.3.0latest2023/07/293 年前
1.2.12023/02/063 年前
1.2.02023/02/063 年前
1.1.02023/02/033 年前
1.0.12021/11/105 年前
1.0.02021/10/205 年前

关于 @hcaptcha/vue3-hcaptcha 的常见问题

@hcaptcha/vue3-hcaptcha 是什么?

h Vue.js 的 Captcha 组件库。 与Vue 2和3相兼容.

如何安装 @hcaptcha/vue3-hcaptcha?

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

@hcaptcha/vue3-hcaptcha 支持 TypeScript 吗?

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

@hcaptcha/vue3-hcaptcha 支持 ESM 还是 CommonJS?

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

@hcaptcha/vue3-hcaptcha 可以商用吗?

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

@hcaptcha/vue3-hcaptcha 的下载量有多少?

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

@hcaptcha/vue3-hcaptcha 还在维护吗?

最新版本 1.3.0 发布于 2023/07/29(3 年前);至今共发布 8 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/10/19。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。