@garyliao/pattern-lock-js-advanced
v1.0.1
Published
An pattern lock project forked from @tympanix/pattern-lock-js, but with more options and functions to operate with.
Downloads
3
Maintainers
Readme
pattern-lock-js
A passcode mechanism built with scalable vector graphics (SVG) and javascript for modern web application with mobile and tablet support
Demo
Install
Install using npm:
npm i @garyliao/pattern-lock-js-advanced
Getting started
Import dependecies:
<script src="jquery.js" charset="utf-8"></script>
Import the module:
<link rel="stylesheet" href="patternlock.min.css">
<script src="patternlock.min.js" charset="utf-8"></script>
Design your desired svg pattern (or use the default one below). Your svg graphics must as a minimum have the patternlock
class and three groups <g>
with the classes lock-actives
, lock-lines
and lock-dots
<svg class="patternlock" id="lock" viewBox="0 0 100 100" xmlns="http://www.w3.org/2000/svg">
<g class="lock-actives"></g>
<g class="lock-lines"></g>
<g class="lock-dots">
<circle cx="20" cy="20" r="2"/>
<circle cx="50" cy="20" r="2"/>
<circle cx="80" cy="20" r="2"/>
<circle cx="20" cy="50" r="2"/>
<circle cx="50" cy="50" r="2"/>
<circle cx="80" cy="50" r="2"/>
<circle cx="20" cy="80" r="2"/>
<circle cx="50" cy="80" r="2"/>
<circle cx="80" cy="80" r="2"/>
</g>
</svg>
Initialise the component
var lock = new PatternLock("#lock", {
onPattern: function(result) {
console.log(result.rspCode);
// check rspCode equals 0000 before you retrieve result.pattern
}
});
Options
The returned object from new PatternLock(...)
has the following utility functions:
clear()
Clears the current patternsuccess()
Validates the pattern as correcterror()
Validates the pattern as incorrectswitchHide()
Hide or Show line when runninggetPattern()
Return an object contains rspCode and pattern result.0000
-> Success1001
-> Input nodes number invalid(Smaller than minimun number)1002
-> Input nodes number invalid(Exceed manimun accepted number)
The pattern lock constructor accepts a second argument - an object literal with the following properties:
onPattern: function
Called when a pattern is drawn with the pattern as argument. Returning true/false validates/invalidates the pattern - the same as callingsuccess()
anderror()
. The context is set to the pattern lock instance itself.allowRepeat: boolean
Defines if nodes can be selected repeatly(But can't select one node continuosly). Default:true
hideLine: boolean
Hide the lines if needed. Default:false
checkMin: boolean
Defines if need check min input nodes. Default:true
checkMax: boolean
Defines if need check max input nodes. Default:true
min: number
Defines the minimum valid numbers of input nodes. Default:4
max: number
Defines the maximun valid numbers of input nodes. Default:9