Skip to content

Commit

Permalink
fixed readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RyanDaDeng committed Jan 25, 2019
1 parent 7812ad9 commit f10fbbd
Showing 1 changed file with 43 additions and 59 deletions.
102 changes: 43 additions & 59 deletions README.md
Expand Up @@ -364,17 +364,20 @@ The file will be created under js/components/googlerecaptchav3/GoogleReCaptchaV3

### Step 2 Import vue component and Register reCAPTCHA v3 SiteKey

#### A BIG thanks to [@Fluxlicious](https://github.com/Fluxlicious) who improved the vue component.

The Blade way is no longer useful if you use Vue, so we need to manage to assign site key by ourselves. The component supports props below:

Supported: siteKey, elementId, inline and action, check the original file to see the details.
Supported: siteKey, id, inline and action, check the original file to see the details.

````vue
<google-re-captcha-v3
:siteKey="this.siteKey"
:elementId="'contact_us_id'"
:inline="true"
:action="'contact_us'">
</google-re-captcha-v3>
<google-re-captcha-v3
ref="captcha" v-model="gRecaptchaResponse"
:siteKey="'Your Site Key Here'"
:id="'contact_us_id'"
:inline="true"
:action="'contact_us'">
</google-re-captcha-v3>
````

Expand All @@ -386,58 +389,52 @@ There are two ways you can bind site key to the component.
````vue
<template>
<div>
<form method="POST" action="/verify">
<div>
<label for="exampleInputEmail1">Email address</label>
<input type="email" id="exampleInputEmail1"
aria-describedby="emailHelp"
placeholder="Enter email">
</div>
<form @submit.prevent="submit">
<div>
<label for="exampleInputPassword1">Password</label>
<input type="password" id="exampleInputPassword1"
placeholder="Password">
<google-re-captcha-v3
ref="captcha" v-model="form.gRecaptchaResponse"
:siteKey="this.siteKey"
:id="'contact_us_id'"
:inline="true"
:action="'contact_us'">
</google-re-captcha-v3>
</div>
<div>
<div id="contact_us_id"></div> // Your reCAPTCHA div element
</div>
<button type="submit">Submit</button>
</form>
<google-re-captcha-v3
:siteKey="this.siteKey"
:elementId="'contact_us_id'"
:inline="true"
:action="'contact_us'">
</google-re-captcha-v3>
</div>
</template>
<script>
import GoogleReCaptchaV3 from '../components/googlerecaptchav3/GoogleReCaptchaV3'; // location might be diff to your case, ensure that your location is right
import GoogleReCaptchaV3 from '../../components/googlerecaptchav3/GoogleReCaptchaV3';
// location might be diff to your case, ensure that your component location is right
export default {
components: {
GoogleReCaptchaV3
},
data() {
return {
siteKey: 'YOUR_SITE_KEY', // provide your site key here
form: {
gRecaptchaResponse: null
},
siteKey: 'Your Site Key',
}
},
created() {
},
computed: {},
mounted() {
},
watch: {},
methods: {}
methods: {
submit() {
axios.post('/verify', this.form).then(
response => {
this.$refs.captcha.execute(); // every time you submit, the reCAPTCHA token needs to be refreshed
}
).catch(
error => {
this.$refs.captcha.execute(); // every time you submit, the reCAPTCHA token needs to be refreshed
});
}
}
}
</script>
````

### or Add site key directly into GoogleReCaptchaV3 component
Expand All @@ -447,28 +444,15 @@ Alternatively, I believe most of cases your site key will never be changed, so y
For instance, open published file and find code below:
````vue
....
props: {
siteKey: {
type: String,
required: true
},
.....
},
siteKey: {
type: String,
required: false, // set to true if you don't want to store the siteKey in this component
default: 'Your Site Key Here' // set siteKey here if you want to store it in this component
},
....
````

Remove it from prop and add it in data():

````vue
data() {
return {
siteKey: "YOUR_KEY_HERE",
....
}
},
````


## Advanced Usage <a name="advanced-usage" />

Expand Down

0 comments on commit f10fbbd

Please sign in to comment.