arcaptcha-vue3

ARCaptcha Vue3

ARCaptcha Component Library for Vue3.

Installation

You can install this library via npm with:

• npm i arcaptcha-vue3

Usage

• Basic:

<script setup>
import arcaptchaVue3 from "arcaptcha-vue3";

function callbackDef() {
// This function would be called after solving captcha
}
function expired_callbackDef() {
  //This function would be called after expiring
}
</script>

<template>
<div>
  <arcaptchaVue3
    :callback="callbackDef"
    :expired_callback="expired_callbackDef"
    site_key="YOUR_SITE_KEY"
  >
  </arcaptchaVue3>

  <!-- <arcaptchaVue3 site_key="bdopsptc2b"></arcaptchaVue3> -->
</div>
</template>

• Invisible:

<template>
    <div>
        <arcaptchaVue3 :callback="callbackDef" :expired_callback="expired_callbackDef" site_key="YOUR_SITE_KEY" :invisible="true" ref="widget"></arcaptchaVue3>

        <button @click="execute">Load invisible captcha</button>
        <button @click="reset">reset invisible captcha</button>
    </div>
</template>

<script>
import arcaptchaVue3 from "arcaptcha-vue3";
import { ref } from 'vue'

export default {
    components: {
        arcaptchaVue3
    },
    setup() {
      const widget = ref(null)
      return {widget}
    },
    methods: {
        expired_callbackDef() {
            //This method would be called after expiring
        },
        callbackDef(token) {
            // This method would be called after solving captcha
            console.log('Captcha Solved with token:', token)
        },
        execute() {
            this.$refs.widget.execute();
        },
        reset() {
          this.$refs.widget.reset();
        },
    }
};
</script>

• Invisible with promise:

<template>
  <div>
    <arcaptchaVue3 :callback="callbackDef" :expired_callback="expired_callbackDef" site_key="YOUR_SITE_KEY" :invisible="true" ref="widget">               </arcaptchaVue3>

    <button @click="execute">Load invisible captcha</button>
    <button @click="reset">reset invisible captcha</button>
  </div>
</template>

<script>
  import arcaptchaVue3 from "arcaptcha-vue3";
  import { ref } from 'vue'

  export default {
    components: {
        arcaptchaVue3
    },
    setup() {
      const widget = ref(null)
      return {widget}
    },
    methods: {
        expired_callbackDef() {
            //This method would be called after expiring
        },
        callbackDef() {
            // This method would be called after solving captcha
        },
        execute() {
            this.$refs.widget.execute().then((token) => {
                console.log("Captcha Solved! token:", token);
            });
        },
        reset() {
          this.$refs.widget.reset();
        },
      }
    };
</script>

Props

Name	Values/Type	Required	Default	Description
site_key	string	Yes	-	This is your sitekey, this allows you to load captcha. If you need a sitekey, please visit Arcaptcha, and sign up to get your sitekey
invisible	Boolean	NO	False	This allows you to use invisible captcha for you forms
lang	string	NO	fa	This allows you to choose language by this prop. you can choose 'en' or 'fa' for english and persion language
theme	string	NO	light	This allows you to choose theme for your widget. The themes are light and dark
color	String	No	normal	Color of every colored element in widget and challenge.
callback	Function	NO	null	This function would be called after solving captcha
rendered_callback	Function	NO	null	This function would be called after rendering captcha
closed_callback	Function	NO	null	This function would be called after user decides to close the challenge
error_callback	Function	NO	null	This function would be called after error
reset_callback	Function	NO	null	This function would be called after reseting captcha
expired_callback	Function	NO	null	This function would be called after expiring
chlexpired_callback	Function	NO	null	This function would be called after challange expiration

Events

Name	Description
onError	If there is any issue with loading api.js file this event will be emitted

Methods

Method	Description
execute()	Programmatically trigger a challenge request. You can use this, to load invisible captcha after trigger a button
reset()	Reset the current challenge

How can I get a sitekey?

Sign up at ARCaptcha to get your sitekey. Check documentation for more information.