友好的卡普查 SDK
用于将 Friendly Captcha v2 整合到您的网站上的 SDK .
这是您网站上运行的代码, 插入了 Captcha 部件 .
这是SDK的 友好的 Captcha v2 仅限如果你正在寻找v1 SDK,你可以找到 这里。 。 。 .
安装
# using npm
npm install @friendlycaptcha/sdk
# using yarn
yarn add @friendlycaptcha/sdk
你可以在图书馆里使用它.
import { FriendlyCaptchaSDK } from "@friendlycaptcha/sdk"
// Re-use this SDK if you are creating multiple widgets.
const sdk = new FriendlyCaptchaSDK();
// HTML element that you want to mount the widget under.
const mount = document.querySelector("#my-widget-mount");
// Create the widget
const widget = sdk.createWidget({
element: mount,
sitekey: "<your sitekey>"
});
常见JS
你也可以这样 require 如果你的环境使用普通JS的话.
var { FriendlyCaptchaSDK } = require("@friendlycaptcha/sdk");
// Re-use this SDK if you are creating multiple widgets.
const sdk = new FriendlyCaptchaSDK();
文档
这些文件可见于我们 开发者枢纽,则 开始 指南。 。 。 .
发展
如果您想要开发 SDK 本身, 下列命令是有用的
# install dependencies
npm install
# minimal build
npm run build
# build for distribution (also builds docs)
npm run build:dist
# run the basic unit tests
npm run test
浏览器兼容性
SDK支持非常旧的浏览器(包括IE11). 这个 .compat 捆绑与 Babel 转接 并获得多填充 src/polyfill/ (单位:千美元)Promise, (中文(简体) ), Map, (中文(简体) ), Set, (中文(简体) ), WeakMap 财务报告和审定财务报表 WeakSet),但Babel不转接发电机或 async 函数,而不填充任何其他API。 运行相容linter以查找语言特性和 API 来避免 :
npm run lint:compat
规矩是存在的 lint-compat.config.mjs. 沉默一种蓄意使用,例如经过特征检查的,使用 // compat-ignore: reason 在相同或上行上注释.
测试
我们把更适当的端到端测试纳入 测试 工具文件夹.
更新 docusaurus SDK 参考文件
我们自动生成标记下的文件,并将它们翻译为对Docuraurus有效的格式的文件。 然后您需要手动更新文件, 删除旧文件并添加新文件 。 像这样:
rm -rf ../friendly-docs/docs/sdk/reference && mkdir ../friendly-docs/docs/sdk/reference && cp -r ./dist/docs/docusaurus/ ../friendly-docs/docs/sdk/reference/
添加许可证头
# print those files that would be changed
npm run license-check-and-add -- check
# add the headers
npm run license-check-and-add -- add
许可证
这是免费的软件,你可以按照以下条款重新分配和/或修改: Mozilla 公共许可版本 2.0。 。 。 .
捐款
欢迎捐款.
在我们接受你的贡献之前... ...你需要签下我们 CLA(捐助者许可证协议)。 。 。 .