ButterflEye dynamically generates an eye-tracker compatible overlay for Bootstrap 3 sites.
-
Include jQuery:
<script src="http://ajax.googleapis.com/ajax/libs/jquery/2.0.0/jquery.min.js"></script>
-
Include plugin's code:
<script src="dist/jquery.butterfleye.min.js"></script>
-
Call the plugin:
$("#element").butterfleye({ propertyName: "a custom value" });
The basic structure of the project is given in the following way:
├── demo/
│ └── index.html
├── dist/
│ ├── jquery.butterfleye.js
│ └── jquery.butterfleye.min.js
├── src/
│ └── jquery.butterfleye.js
├── .editorconfig
├── .gitignore
├── .jshintrc
├── .travis.yml
├── Gruntfile.js
└── package.json
Contains a simple HTML file to demonstrate your plugin.
This is where the generated files are stored once Grunt runs.
Contains the files responsible for your plugin, you can choose between JavaScript or CoffeeScript.
This file is for unifying the coding style for different editors and IDEs.
Check editorconfig.org if you haven't heard about this project yet.
List of files that we don't want Git to track.
Check this Git Ignoring Files Guide for more details.
List of rules used by JSHint to detect errors and potential problems in JavaScript.
Check jshint.com if you haven't heard about this project yet.
Definitions for continous integration using Travis.
Check travis-ci.org if you haven't heard about this project yet.
Contains all automated tasks using Grunt.
Check gruntjs.com if you haven't heard about this project yet.
Specify all dependencies loaded via Node.JS.
Check NPM for more details.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.