Vue SDK

Official Vue 3 component for CaptchaLa CAPTCHA — published as @captcha-la/vue.

Live demo

📦

demo-v1.captcha.la/vue — runnable demo with all four product modes. Source: Captcha-La/vue-example.

Install

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

Peer dependency: vue@^3.2.0.

Quick start

<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	Type	Default	Description
appKey	string	required	CaptchaLa application key
serverToken	string	-	One-time, server-issued challenge token. Required when the app has server_token_required=true.
product	'popup' | 'float' | 'embed' | 'bind'	'popup'	Display mode
action	string	'default'	Action identifier (e.g. login, register, checkout)
lang	string	'zh-CN'	Language code (zh-CN, en, ja, …)
bindTo	string | HTMLElement	-	Element selector or node to bind to (only for product="bind")

Events

Event	Payload	Description
success	{ token, type, action }	Verification succeeded
error	error	Verification failed
close	—	CAPTCHA closed
ready	—	CAPTCHA ready

Methods (via 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>

Method	Description
verify()	Trigger verification
reset()	Reset CAPTCHA state
destroy()	Destroy the instance
bindTo(selector)	Bind to element (for bind mode)
setLang(lang)	Switch language in place

Production: serverToken mode

For high-value flows (login, register, payment) we recommend the server-issued token flow. Your backend mints a one-time server_token (5-minute TTL) via POST /v1/server/challenge/issue and hands it to the browser:

<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>

See API Reference for the full backend contract.

Links

• npm · GitHub · example
• Web SDK overview · API Reference