jQuery Magnetic Card Reader
A jQuery Plugin to read magnetic cards of 1, 2 and 3 trails.
Install it via Package Managers
Bower
bower install jquery-magnetic-card-reader
NPM
npm i jquery-magnetic-card-reader
How to use
There are numbers of way to use this plugin:
$(selector).magneticCardReader(options)$.magneticCardReader($target, options)
And each of these methods has the same options:
animationOnInitis a optional function that will override a standard animation function that is triggered after the first trail is capturedanimationOnCompleteis a optional function that will override a standard animation function that is triggered when the last trails capture timer finishesbuildDataFirstTrailis a optional function used to extract the necessary data referring to the first trailbuildDataSecondTrailis a optional function used to extract the necessary data referring to the second trailbuildDataThirdTrailis a optional function used to extract the necessary data referring to the third trailcallbackis a required function that is triggered at the end of the execution of the plugin containing the data obtained from the cardcolorToHideis a required attribute used to set the color of the input text when the default animation is activated, default value is"#FFF"colorToShowis a required attribute used to set the color of the input text when the default animation is completed, default value is""eventKeyTypeis a required attribute use to fire the plugin, default value iskeydown, other possible values is:keypressandkeyupregExpFirstTrailis a optional attribute used to capture the value of first trail including the initial and end characters, this value must be a object of type RegExpregExpSecondTrailis a required attribute used to capture the value of second trail including the initial and end characters, this value must be a object of type RegExpregExpThirdTrailis a optional attribute used to capture the value of third trail including the initial and end characters, this value must be a object of type RegExpstyleCursorOnInitis a required attribute used to set the style of cursor pointer when the default animation is activated, default value is"wait"timerLimitis a required attribute used to define a timer limit of capturation on each trail
See usage examples here!
Contributing
- Bug Reporting: You can contribute opening issues.
- Bug Fixing: Fix it and help others and write some tests to make sure that everything are working propertly.
- Improving: Open an issue and lets discuss it.
To get started to contribuite, please install NodeJS, Bower, Grunt, and then run some Grunt/Bower commands.
npm install
bower install
grunt test # Lint code and run test suite on scenarios
grunt build # Generate the release files
This plugin is tested with QUnit, under jQuery 1.7 up to 3.3 and RequireJS.