https://github.com/trustyoo86/jquery-events-util

Browser's event util using jquery or javascript
https://github.com/trustyoo86/jquery-events-util

browser desktop event javascript jquery mobile

Last synced: about 1 month ago
JSON representation

Browser's event util using jquery or javascript

• Host: GitHub
• URL: https://github.com/trustyoo86/jquery-events-util
• Owner: trustyoo86
• License: mit
• Created: 2018-03-28T05:09:33.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-07T02:13:36.000Z (about 2 years ago)
• Last Synced: 2024-10-23T02:12:10.113Z (3 months ago)
• Topics: browser, desktop, event, javascript, jquery, mobile
• Language: TypeScript
• Homepage:
• Size: 945 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jquery-event-util

[![Build Status](https://travis-ci.org/trustyoo86/jquery-events-util.svg?branch=master)](https://travis-ci.org/trustyoo86/jquery-events-util)

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

```bash

npm install jquery-event-util --save

```

yarn install

```bash

yarn add jquery-event-util

```

## build

development mode

```bash

# npm

npm run dev

# yarn

yarn dev

```

production mode

```bash

# npm 

npm run prod

# yarn

yarn prod

```

## Members



default





## Functions





hasTouch() ⇒ boolean





detect mobile device (touch device)





getEventPos(ev) ⇒ Object | number | number





get event posision





getEventOffset(ev) ⇒ Object | number | number





get event offset position





ua

Returns an object representing the user agent including data such as browser, device and platform(_ua, obj) ⇒ object









## default

**Kind**: global variable  

**Properties**

| Name | Type | Description |

| --- | --- | --- |

| hasTouch | function | has touch function |

| getEventPos | function | get event position |

| getEventOffset | function | get event offset |

| START | string | touch or mouse move start |

| MOVE | string | touch or mouse move |

| END | string | touch or mouse end |

| CANCEL | string | touch cancel or mouse up |

| CLICK | string | click event |

| DOUBLE_CLICK | string | double click event |

| OVER | string | mouse over event |

| OUT | string | mouse out event |

| RESIZE | string | orientation change or resize event |

| URL_CHANGE | string | pop state or hash change |

| INPUT_CHECK | string | input blur event |

| FILE_CHECK | string | file input change event |

| REFRESH | string | refresh event |

| SELECT | string | select change vent |

| DRAG_START | string | mouse drag start event |

| DRAG_END | string | mouse drag end event |

| KEY | string | keypress event |

| ONLOAD | string | onload event |

| DRAW_CLICK | string | click on draw event (specific) |

| DRAW_START | string | draw start event (specific) |

| DRAW_MOVE | string | draw move event (specific) |

| DRAW_END | string | draw end event (specific) |



## hasTouch() ⇒ boolean

detect mobile device (touch device)

**Kind**: global function  

**Returns**: boolean - touch device  

**Example**  

```js

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  

| Param | Type | Description |

| --- | --- | --- |

| ev | Object | event object |

**Example**  

```js

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  

| Param | Type | Description |

| --- | --- | --- |

| ev | Object | event object |

**Example**  

```js

import eventUtil from 'jquery-event-util'

 $('.test').on(eventUtil.MOVE, (e) => {

   eventUtil.getEventOffset(e) // {x: number, y: number}

 })

```