1.0.0 • Published 6 years ago

jquery-events-util v1.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

jquery-event-util

Build Status

Event-related utility that returns the position or offset at which the event occurred. It also allows you to apply event names organically according to the device.

install

npm install

npm install jquery-event-util --save

yarn install

yarn add jquery-event-util

build

development mode

# npm
npm run dev
# yarn
yarn dev

production mode

# npm 
npm run prod
# yarn
yarn prod

Members

Functions

default

Kind: global variable
Properties

NameTypeDescription
hasTouchfunctionhas touch function
getEventPosfunctionget event position
getEventOffsetfunctionget event offset
STARTstringtouch or mouse move start
MOVEstringtouch or mouse move
ENDstringtouch or mouse end
CANCELstringtouch cancel or mouse up
CLICKstringclick event
DOUBLE_CLICKstringdouble click event
OVERstringmouse over event
OUTstringmouse out event
RESIZEstringorientation change or resize event
URL_CHANGEstringpop state or hash change
INPUT_CHECKstringinput blur event
FILE_CHECKstringfile input change event
REFRESHstringrefresh event
SELECTstringselect change vent
DRAG_STARTstringmouse drag start event
DRAG_ENDstringmouse drag end event
KEYstringkeypress event
ONLOADstringonload event
DRAW_CLICKstringclick on draw event (specific)
DRAW_STARTstringdraw start event (specific)
DRAW_MOVEstringdraw move event (specific)
DRAW_ENDstringdraw end event (specific)

hasTouch() ⇒ boolean

detect mobile device (touch device)

Kind: global function
Returns: boolean - touch device
Example

import eventUtil from 'jquery-event-util'

 eventUtil.hasTouch()  // true on mobile, false on desktop

getEventPos(ev) ⇒ Object | number | number

get event posision

Kind: global function
Returns: Object - event position objectnumber - x position xnumber - y position y

ParamTypeDescription
evObjectevent object

Example

import eventUtil from 'jquery-event-util'

 $('.test').on(eventUtil.MOVE, (e) => {
   eventUtil.getEventPos(e) // {x: number, y: number}
 })

getEventOffset(ev) ⇒ Object | number | number

get event offset position

Kind: global function
Returns: Object - offset position objectnumber - x offset x positionnumber - y offset y position

ParamTypeDescription
evObjectevent object

Example

import eventUtil from 'jquery-event-util'

 $('.test').on(eventUtil.MOVE, (e) => {
   eventUtil.getEventOffset(e) // {x: number, y: number}
 })