Vue SDK

Официальный компонент Vue 3 для CAPTCHA CaptchaLa — опубликован как @captcha-la/vue.

Живое демо

📦

demo-v1.captcha.la/vue — рабочее демо со всеми четырьмя режимами product. Исходный код: Captcha-La/vue-example.

Установка

npm install @captcha-la/vue
# or
yarn add @captcha-la/vue
# or
pnpm add @captcha-la/vue

Peer-зависимость: vue@^3.2.0.

Быстрый старт

<template>
  <Captchala
    app-key="your-app-key"
    product="popup"
    @success="handleSuccess"
    @error="handleError"
  />
</template>

<script setup>
import { Captchala } from '@captcha-la/vue'

function handleSuccess(result) {
  // Send result.token to your server for validation.
  console.log('pass_token:', result.token)
}

function handleError(error) {
  console.error('verification failed:', error)
}
</script>

Props

Prop	Тип	По умолчанию	Описание
appKey	string	обязательно	Ключ приложения CaptchaLa
serverToken	string	-	Одноразовый Token запроса, выданный сервером. Обязателен, если у приложения server_token_required=true.
product	'popup' | 'float' | 'embed' | 'bind'	'popup'	Режим отображения
action	string	'default'	Идентификатор действия (например login, register, checkout)
lang	string	'zh-CN'	Код языка (zh-CN, en, ja, …)
bindTo	string | HTMLElement	-	Селектор элемента или узел для привязки (только для product="bind")

События

Событие	Payload	Описание
success	{ token, type, action }	Проверка успешна
error	error	Проверка не удалась
close	—	CAPTCHA закрыта
ready	—	CAPTCHA готова

Методы (через ref)

<template>
  <Captchala ref="captchaRef" app-key="your-app-key" />
  <button @click="captchaRef?.verify()">Verify</button>
</template>

<script setup>
import { ref } from 'vue'
const captchaRef = ref()
</script>

Метод	Описание
verify()	Запустить проверку
reset()	Сбросить состояние CAPTCHA
destroy()	Уничтожить экземпляр
bindTo(selector)	Привязка к элементу (для режима bind)
setLang(lang)	Переключить язык на лету

Production: режим serverToken

Для ответственных потоков (вход, регистрация, оплата) мы рекомендуем поток Token, выданного сервером. Ваш backend выпускает одноразовый server_token (TTL 5 минут) через POST /v1/server/challenge/issue и передаёт его в браузер:

<template>
  <Captchala
    v-if="serverToken"
    :server-token="serverToken"
    app-key="pk_your_public_app_key"
    action="login"
    @success="onSuccess"
  />
</template>

<script setup>
import { ref, onMounted } from 'vue'
import { Captchala } from '@captcha-la/vue'

const serverToken = ref()

onMounted(async () => {
  const r = await fetch('/api/captcha-token')   // your own backend
  serverToken.value = (await r.json()).server_token
})

function onSuccess(result) {
  console.log('pass_token:', result.token)
}
</script>

См. Справочник API для полного backend-контракта.

Ссылки

• npm · GitHub · example
• Обзор Web SDK · Справочник API