Skip to content
Mouse position monitoring and user input prediction
JavaScript
Branch: master
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.
.gitignore
LICENSE
README.md
gulpfile.js
package.json
trial.js
trial.min.js

README.md

Trial.js

simple library could monitor mouse position and predict user input

  • No dependency
  • Lightweight (~1kb gzipped)
  • Automatically extends jQuery and Zepto properties

Usage & Examples

APIs

Trial(selector)

@params selector {String|Node|NodeList|Array{Node}|jQuery object}
@return {Trial instance}
@constructor

Initialize a new Trial instance related to selector, same selector would only have one Trial instance, if Trial(selector) be called twice with same selector, the second calling would return the same instance created in first calling.
selector could be query string, NodeList or $ object

Trial.fn.within(options, callback)

@params options {Object}
@params callback {Function}
@return {Trial instance}

This method sets a circular area on matched element, when mouse pointer moving within this area, event handler would be called

Distance options

options:
distance {Number} : determine the radius of the circular area
cord {String} : determine the center of the circular area, could be center, topLeft, topCenter, topRight, centerLeft, centerRight, bottomLeft, bottomCenter, bottomRight

Coordinate options

callback
An event handler to be called when mouse pointer moving within the circular area, arguments:
distance {Number} : current distance between mouse pointer and matched element ele {Node} : matched element event {Event} : mousemove event

Trial.fn.enter(options, callback)

@params options {Object}
@params callback {Function}
@return {Trial instance}

same as Trial.fn.within, but only call the event handler when mouse pointer enter the circular area
options:
distance {Number} : determine the radius of the circular area
cord {String} : determine the center of the circular area, could be center, topLeft, topCenter, topRight, centerLeft, centerRight, bottomLeft, bottomCenter, bottomRight
callback
An event handler to be called when mouse pointer enter the circular area, arguments:
distance {Number} : current distance between mouse pointer and matched element ele {Node} : matched element event {Event} : mousemove event

Trial.fn.leave(options, callback)

@params options {Object}
@params callback {Function}
@return {Trial instance}

same as Trial.fn.within, but only call the event handler when mouse pointer leave the circular area
options:
distance {Number} : determine the radius of the circular area
cord {String} : determine the center of the circular area, could be center, topLeft, topCenter, topRight, centerLeft, centerRight, bottomLeft, bottomCenter, bottomRight
callback
An event handler to be called when mouse pointer leave the circular area, arguments:
distance {Number} : current distance between mouse pointer and matched element ele {Node} : matched element event {Event} : mousemove event

Trial.fn.off(eventName)

@params eventName {String}
@return {Trial instance}

Unbind an event handler for specific event, eventName could be within, enter, leave

Browser Supports

IE 9+

License

MIT

You can’t perform that action at this time.