A very simple,powerful and highly customizable captcha for ReactJS
npm install react-simple-captchash
$ npm install react-simple-captcha
`
Demo
Demo can be seen here.
Usage Guide
Just follow these 4 easy steps to use the react simple captcha:
- Step 1:
Import all functions from react-simple-captcha
`sh
import { loadCaptchaEnginge, LoadCanvasTemplate, LoadCanvasTemplateNoReload, validateCaptcha } from 'react-simple-captcha';
`
- Step 2:
Place < LoadCanvasTemplate /> or < LoadCanvasTemplateNoReload /> (if you do not want 'Reload Captcha' functionality) in your render code
`sh
render() {
return (
);
};
`
OR
`sh
render() {
return (
);
};
`
- Step 3:
Paste loadCaptchaEnginge(6) (You can change 6 to number of captcha charcters you want) in componentDidMount
`sh
componentDidMount () {
loadCaptchaEnginge(6);
};
`
- Step 4:
Validate captcha by using validateCaptcha(user_captcha_value)
`sh
doSubmit = () => {
let user_captcha_value = document.getElementById('user_captcha_input').value;
if (validateCaptcha(user_captcha_value)==true) {
alert('Captcha Matched');
}
else {
alert('Captcha Does Not Match');
}
};
`
OR
If you don't want captcha to be reloaded if user enter the wrong value then set second parameter to false validateCaptcha(user_captcha_value, false)
`sh
doSubmit = () => {
let user_captcha_value = document.getElementById('user_captcha_input').value;
if (validateCaptcha(user_captcha_value, false)==true) {
alert('Captcha Matched');
}
else {
alert('Captcha Does Not Match');
}
};
`
$3
Listed are all the options available for react-simple-captcha
| Name | Description |
| ------ | ------ |
| < LoadCanvasTemplate /> | It will load the captcha with 'Reload Captcha' functionality. Place between your render code, usage example < LoadCanvasTemplate /> |
| < LoadCanvasTemplateNoReload /> | It will load the captcha without 'Reload Captcha' functionality. Place between your render code, usage example < LoadCanvasTemplateNoReload /> |
| loadCaptchaEnginge(Number_Of_Captcha_Charcters); | Simply paste it in componentDidMount(). Pass number of captcha characters you want to display. |
| validateCaptcha(User_Submitted_Value) | Will return true if user submitted value matches with captcha otherwise false. Also will reload captcha if user submitted value is false |
| validateCaptcha(User_Submitted_Value, false) | Will return true if user submitted value matches with captcha otherwise false. Will not reload captcha if user submitted value is false |
$3
| Options | All of these changes are optionals |
| ------ | ------ |
| < LoadCanvasTemplate reloadText="Reload My Captcha" /> | If you want to change the "Reload Captcha" with your own text |
| < LoadCanvasTemplate reloadColor="red" /> | If you want to change the blue color of "Reload Captcha" |
| < LoadCanvasTemplate reloadText="Reload My Captcha" reloadColor="red" /> | If you want to change the "Reload Captcha" text and it's blue color |
| loadCaptchaEnginge(Number_Of_Captcha_Charcters, Background_Color); | If you want to change the background color from black to your custom color. Example Syntax to change the background color to red use: loadCaptchaEnginge(6,'red'); |
| loadCaptchaEnginge(Number_Of_Captcha_Charcters, Background_Color, Font_Color); | If you want to change the font color from white to your custom color. Example Syntax to change the font color to blue use: loadCaptchaEnginge(6,'','blue'); |
| loadCaptchaEnginge(Number_Of_Captcha_Charcters, Background_Color, Font_Color); | If you want to change the both background and font color. Example Syntax to change the background color to white and font color to black use: loadCaptchaEnginge(6,'white','black'); |
| loadCaptchaEnginge(Number_Of_Captcha_Charcters, Background_Color, Font_Color, Upper_Characters_Only); | If you want only upper characters and numbers use loadCaptchaEnginge(6,'','','upper'); |
| loadCaptchaEnginge(Number_Of_Captcha_Charcters, Background_Color, Font_Color, Lower_Characters_Only); | If you want only lower characters and numbers use loadCaptchaEnginge(6,'','','lower'); |
| loadCaptchaEnginge(Number_Of_Captcha_Charcters, Background_Color, Font_Color, Numbers); | If you want only numbers use loadCaptchaEnginge(6,'','','numbers'); |
| loadCaptchaEnginge(Number_Of_Captcha_Charcters, Background_Color, Font_Color, Special_Characters); | If you want only special characters use loadCaptchaEnginge(6,'','','special_char'); |
$3
Let's create a class name CaptchaTest with react simple captcha functionality:
`sh
import React, { Component } from 'react';
import { loadCaptchaEnginge, LoadCanvasTemplate, LoadCanvasTemplateNoReload, validateCaptcha } from 'react-simple-captcha';
class CaptchaTest extends Component {
componentDidMount () {
loadCaptchaEnginge(6);
};
doSubmit = () => {
let user_captcha = document.getElementById('user_captcha_input').value;
if (validateCaptcha(user_captcha)===true) {
alert('Captcha Matched');
loadCaptchaEnginge(6);
document.getElementById('user_captcha_input').value = "";
}
else {
alert('Captcha Does Not Match');
document.getElementById('user_captcha_input').value = "";
}
};
render() {
return (
);
};
}
export default CaptchaTest;
`
Import CaptchaTest in index.js
`sh
import CaptchaTest from './captcha_test';
`
Now replace ReactDOM.render with
`sh
ReactDOM.render(
``