A very small tool drawing check code, and support the IE 9(支持微信小程序)
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist
src
.gitignore
.npmignore
LICENSE
README.md
index.html
package.json
rollup.config.js
yarn.lock

README.md

checkcode

NPM version

A very small tool drawing check code, and support the IE 9

checkcode

Installation

$ npm install checkcode

Import

  • ESM
import CheckCode from 'checkcode';
  • CommonJS
var CheckCode = require('checkcode');
  • CDN
<script src="https://unpkg.com/checkcode/dist/CheckCode.min.js"></script>

Quick Start

  • Browser
<!-- 最好设置canvas的宽高(建议120x40),不然会被拉伸 -->
<canvas id="cvs" width="120" height="40">浏览器不支持canvas</canvas>
// 初始化
var ctx=document.getElementById("cvs").getContext("2d");
new CheckCode(ctx, {
    num: 4, // 验证码个数 
    lineNum: 5, // 干扰线个数
    dotNum: 20, // 干扰点个数
    canvasWidth:120, // 画布的宽,与canvas的width属性值相同
    canvasHeight:40, // 画布的高,与canvas的height属性值相同
}).paint();// 返回验证码的文本内容
  • MiniProgram(微信小程序)
<!-- 设置略有不同,通过style属性设置宽高 -->
<canvas canvas-id='cvs' style='width:120px;height:40px'></canvas>
var ctx=wx.createCanvasContext("cvs"); // 获取到绘图context
new CheckCode(ctx).paint();

API

CheckCode(ctx[,options])

params memo type default
ctx The context of your canvas element string --
options config iConfig --

iConfig

params memo type default
num The number of checkcode number 4
lineNum The number of interference lines number 5
dotNum The number of interference dots number 20
canvasWidth The width of your canvas element number 120
canvasHeight The height of your canvas element number 40

CheckCode#draw

method memo return
paint Drawing and returns the contents of the checkcode string

Contributing

  • Fork this Repo first
  • Clone your Repo
  • Install dependencies by $ npm install
  • Checkout a feature branch
  • Feel free to add your features
  • Make sure your features are fully tested
  • Publish your local branch, Open a pull request
  • Enjoy hacking <3

MIT license

Copyright (c) 2018 yangfan2016 <15234408101@163.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


built upon love by docor v0.3.0