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 | 弦( 光, 暗) | 没有 | light | h Captcha 支持光和暗的主题。 如果没有设定主题, API 将默认为发光 . |
tabindex | 整数 | 没有 | 0 | 设置部件和弹出的标签索引 。 在适当情况下,这可以使您的网站的导航更直观. |
language | 字符串(ISO 639-2代码) | 没有 | auto | hCaptcha通过用户浏览器自动检测语言. 它覆盖了设置默认的 UI 语言 . |
reCaptchaCompat | 布尔 | 没有 | true | 禁止对 reCAPTCHA 进行即时替换 false 防止h Captcha注射入窗口。 克丽卡. |
challengeContainer | 字符串 | 没有 | - | 一个自定义元素 ID 来完成 hCaptcha 挑战 . |
rqdata | 字符串 | 没有 | - 说吧 | 见企业文件. |
sentry | 布尔 | 没有 | - 说吧 | 见企业文件. |
custom | 布尔 | 没有 | - 说吧 | 见企业文件. |
apiEndpoint | 字符串 | 没有 | - 说吧 | 见企业文件. |
endpoint | 字符串 | 没有 | - 说吧 | 见企业文件. |
reportapi | 字符串 | 没有 | - 说吧 | 见企业文件. |
assethost | 字符串 | 没有 | - 说吧 | 见企业文件. |
imghost | 字符串 | 没有 | - 说吧 | 见企业文件. |
回调事件
| 活动 | 参数 | 说明 |
|---|---|---|
error | err | 当出错时。 组件在出错后将立即重置 . |
verify | token, eKey | 当挑战完成时。 这个 token 还有一个 eKey 被传递. |
expired | - 说吧 | 当当前符号过期时 . |
challengeExpired | - 说吧 | 当未完成的挑战到期时. |
opened | - 说吧 | 当挑战打开. |
closed | - 说吧 | 当挑战结束. |
reset | - 说吧 | 当挑战被重置时. |
rendered | - 说吧 | 当挑战提出时. |
executed | - 说吧 | 当挑战被执行时. |
方法
| 方法 | 说明 |
|---|---|
execute() | 程序引发质疑请求 |
executeAsync() | 类似 execute 但它返回一个 Promise。 。 。 . |
reset() | 重置当前的挑战 |
财务问题
我怎么能有钥匙?
报名到 h 卡普察语Name 去拿你的车钥匙 检查 文档 更多信息.
什么是hCaptcha吗?
h 卡普察语Name 帮助公司获得数据标签.
博特分数和无CAPTCHA/被动模式等特性是否也可用?
是,企业版:见 h Captcha 企业( 停止) 详细情况.
演示

运行演示:
- 复制此 repo
git clone https://github.com/hCaptcha/vue-hcaptcha.git cd examples/traditional-vue2yarn && yarn serve- 它会在本地主机: 8080启动演示应用
- 打开您的控制台查看演示应用程序发布事件
类型脚本
支持类型脚本 。 您可以看到两者的示例应用程序 vue2 财务报告和审定财务报表 vue3 内 examples 目录.
开发者的说明
脚本
yarn lint- 检查出问题yarn test- 测试 vue2 和 vue3 软件包yarn build- 将建立生产vue2,3版本
维护者的注释
出版
要出版新版本,请遵循下一步:
- 跳出两种版本:
vue2/package.json财务报告和审定财务报表vue3/package.json(保持同步) - 填充
CHANGES.md有更改细节 - 推变化为主.
- CI/CD管道将公布新版本,以便: @hcaptcha/vue-hcaptcha (英语) 或者说 @hcaptcha/vue3-hcaptcha (英语)。 。 。 .
贡献 + 显著贡献者
vue-hcaptcha 通过卡普查社区的集体努力发展和维持.
包括你这样的开发者! 我们欢迎你的问题、建议和公关.
较大变化的显著贡献者:
- Vue2 支援: h Captcha 团队
- Vue3 支持: JDinABox 和 DSergiu