https://github.com/thinkjs/think-svg-captcha

svg captcha for ThinkJS
https://github.com/thinkjs/think-svg-captcha

captcha svg-captcha thinkjs3

Last synced: 2 months ago
JSON representation

svg captcha for ThinkJS

• Host: GitHub
• URL: https://github.com/thinkjs/think-svg-captcha
• Owner: thinkjs
• License: mit
• Created: 2017-04-07T01:00:41.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-06-30T23:28:07.000Z (over 3 years ago)
• Last Synced: 2024-10-27T20:41:33.203Z (3 months ago)
• Topics: captcha, svg-captcha, thinkjs3
• Language: JavaScript
• Homepage:
• Size: 26.4 KB
• Stars: 10
• Watchers: 12
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• think-awesome - think-svg-captcha

README

        
# think-svg-captcha

[![Build Status](https://travis-ci.org/thinkjs/think-svg-captcha.svg?branch=master)](https://travis-ci.org/thinkjs/think-svg-captcha)

[![Coverage Status](https://coveralls.io/repos/github/thinkjs/think-svg-captcha/badge.svg?branch=master)](https://coveralls.io/github/thinkjs/think-svg-captcha?branch=master)

[![npm](https://img.shields.io/npm/v/think-svg-captcha.svg?style=flat-square)](https://www.npmjs.com/package/think-svg-captcha)

think-svg-captcha is just a wrap of [svg-captcha](https://github.com/lemonce/svg-captcha).

## Usage

### default options

```js

const defaultOptions = {

  size: 4, // size of random string

  ignoreChars: '', // filter out some characters

  noise: 3, // number of noise lines

  color: false, // default grey, true if background option is set

  background: '#ffffff', // background color of the svg image

  width: 150, // width of captcha

  height: 50, // height of captcha

  fontPath: './fonts/Comismsh.ttf', // your font path

  fontSize: 32, // captcha text size

  charPreset: 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789' // random character preset

}

```

### demo

```js

import ThinkSvgCaptcha from 'think-svg-captcha';

let captcha = new ThinkSvgCaptcha(options);

captcha.create(); // returns an object that has the following property: {data: 'svg path data', text: 'captcha text'}

captcha.svgCaptcha(text); // return a svg captcha based on text provided.

```

You can find more details at [svg-captcha](https://github.com/lemonce/svg-captcha) !