Skip to content

Latest commit

 

History

History
56 lines (43 loc) · 1.99 KB

README.md

File metadata and controls

56 lines (43 loc) · 1.99 KB
Raw

AngularDart Google ReCaptcha component

Installation

Put following lines in pubspec.yaml:

dependencies:
  angular_grecaptcha: ^0.0.4

then

pub get

Basic usage

import 'package:angular_grecaptcha/angular_grecaptcha.dart';
...
@Component(
  selector: 'my-component',
  template: '''
    ...
    <form>
    ...
    <g-recaptcha sitekey="YOUR SITEKEY"></g-recaptcha>
    ...
    </form>
    ...
  ''',
  directives: const [AngularRecaptcha]
)
class MyComponent {}

Besides mandatory sitekey parameter you can add optional render parameters:

  • sitekey: String -- Your sitekey
  • theme: String -- Optional. The color theme of the widget. Values: light | dark. Default: light.
  • type: String -- Optional. The type of CAPTCHA to serve. Values: audio | image. Default: image.
  • size: String -- Optional. The size of the widget. Values: compact | normal. Default: normal.
  • tabindex: int -- Optional. The tabindex of the widget and challenge. If other elements in your page use tabindex, it should be set to make user navigation easier. Default: 0
  • callback: Function -- Optional. The name of your callback function to be executed when the user submits a successful CAPTCHA response. The user's response, g-recaptcha-response, will be the input for your callback function.
  • expired-callback: Function -- Optional. The name of your callback function to be executed when the recaptcha response expires and the user needs to solve a new CAPTCHA.

Original parameters description you can find here

Advanced usage example

Advanced usage example you can find here

Important information

This component allows to get ReCaptcha response and post it to a back-end server, where the response is to be verified as described here. The component is not responsible for the verification.