{"id":13496097,"url":"https://github.com/any86/any-touch","last_synced_at":"2025-04-14T06:50:00.845Z","repository":{"id":34809693,"uuid":"146555975","full_name":"any86/any-touch","owner":"any86","description":":wave: Touch gesture library, 1kb~5kb, compatible with PC / mobile","archived":false,"fork":false,"pushed_at":"2023-12-24T07:26:40.000Z","size":8839,"stargazers_count":1224,"open_issues_count":18,"forks_count":120,"subscribers_count":14,"default_branch":"master","last_synced_at":"2024-10-29T17:53:17.082Z","etag":null,"topics":["angular","drag","finger","gesture","javascript","mouse","pan","pinch","press","react","rotate","swipe","tap","touch","typescript","vanilla","vue"],"latest_commit_sha":null,"homepage":"https://any86.github.io/any-touch","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/any86.png","metadata":{"files":{"readme":"README.CN.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-08-29T06:34:52.000Z","updated_at":"2024-10-08T03:30:22.000Z","dependencies_parsed_at":"2024-06-18T13:37:03.985Z","dependency_job_id":"ff2a8aa6-b015-4c80-9043-7da8746e3eb0","html_url":"https://github.com/any86/any-touch","commit_stats":{"total_commits":1382,"total_committers":2,"mean_commits":691.0,"dds":"0.0014471780028944004","last_synced_commit":"293edec7ea7c6706bbc79b460b1031da9df18721"},"previous_names":[],"tags_count":124,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/any86%2Fany-touch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/any86%2Fany-touch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/any86%2Fany-touch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/any86%2Fany-touch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/any86","download_url":"https://codeload.github.com/any86/any-touch/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248837274,"owners_count":21169373,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","drag","finger","gesture","javascript","mouse","pan","pinch","press","react","rotate","swipe","tap","touch","typescript","vanilla","vue"],"created_at":"2024-07-31T19:01:42.237Z","updated_at":"2025-04-14T06:50:00.814Z","avatar_url":"https://github.com/any86.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","JavaScript","Touch Gestures"],"sub_categories":["Reactive Programming"],"readme":"# any-touch [![NPM Version][npm-image]][npm-url] [![NPM Downloads][downloads-image]][downloads-url] [![size-image]][size-url] [![codecov](https://codecov.io/gh/any86/any-touch/branch/master/graph/badge.svg)](https://codecov.io/gh/any86/any-touch) [![CircleCI](https://circleci.com/gh/any86/any-touch.svg?style=svg)](https://circleci.com/gh/any86/any-touch)\n\n[size-image]: https://badgen.net/bundlephobia/minzip/@any-touch/core\n[size-url]: https://bundlephobia.com/result?p=@any-touch/core\n[npm-image]: https://badgen.net/npm/v/any-touch\n[npm-url]: https://npmjs.org/package/any-touch\n[downloads-image]: https://badgen.net/npm/dt/any-touch\n[downloads-url]: https://npmjs.org/package/any-touch\n\n![6类手势](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/102a244991064824900ac45efeb9251d~tplv-k3u1fbpfcp-zoom-1.image)\n\n-   支持 PC 端 / 移动端 / [微信小程序](docs/wx.CN.md).\n-   **默认加载6 个手势识别器**, 也可[按需加载](docs/optional.CN.md), 核心**1kb**, 完整**5kb**.\n-   **无依赖, 不限于 Vue / React / Angular 等...**\n\n## 语言\n **中文** | [English](README.CN.md)\n\n## 演示\n\n\u003cdetails\u003e\n\u003csummary\u003e查看二维码\u003c/summary\u003e\n\u003cimg src=\"https://user-images.githubusercontent.com/8264787/104836031-a55ca780-58e5-11eb-936a-7e2d1a05ee86.png\" /\u003e\n\u003c/details\u003e\n\n[简单演示](https://any86.github.io/any-touch)\n\n[衍生产物: any-scroll(虚拟滚动)](https://github.com/any86/any-scroll)\n\n## 安装\n\n```javascript\nnpm i -S any-touch\n```\n\n## CDN\n\n```html\n\u003cscript src=\"https://unpkg.com/any-touch/dist/any-touch.umd.min.js\"\u003e\u003c/script\u003e\n\u003cscript\u003e\n    console.log(AnyTouch.version); // 2.x.x\n\u003c/script\u003e\n```\n\n## 目录\n\n[⚡ 快速开始](#快速开始)\n\n-   [👋 手势事件](#-手势事件)\n-   [🍭 事件对象](#lollipop-事件对象event)\n-   [🔹 Typescript](#Typescript)\n\n[🌱 vue\u0026指令](docs/vue.CN.md)\n\n[🍀 微信小程序](docs/wx.CN.md)\n\n[📐 按需加载](docs/optional.CN.md)\n\n[🌈 进阶使用](docs/advanced.CN.md)\n\n-   [阻止默认事件](docs/advanced.CN.md#阻止默认事件)\n-   [双击(doubletap)](https://github.com/any86/any-touch/tree/master/packages/doubletap)\n\n[:bulb: API](docs/API.CN.md)\n\n[🍳 常见问题](docs/question.CN.md)\n\n\n## 快速开始\n\n```javascript\nimport AnyTouch from 'any-touch';\n\n// 被监视的元素\nconst el = document.getElementById('box');\n\n// 开始监视el上的手势变化\nconst at = new AnyTouch(el);\n\n// 当拖拽的时候pan事件触发\nat.on('pan', (e) =\u003e {\n    // e包含位移/速度/方向等信息\n    console.log(e);\n});\n```\n\n这里的`pan`叫做[手势事件](#-手势事件). `e`是[事件对象](#lollipop-事件对象event), 其包含\"位置/速度/缩放/角度\"等数据,\n\n### 👋 手势事件\n\n每个手势的不同状态都对应一个事件.\n\n\u003ctable\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e手势\u003c/td\u003e\n        \u003ctd\u003e事件名\u003c/td\u003e\n        \u003ctd\u003e说明\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd rowspan=\"5\"\u003e\u003c/td\u003e\n        \u003ctd\u003epan\u003c/td\u003e\n        \u003ctd\u003e拖拽时持续触发\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003epanstart\u003c/td\u003e\n        \u003ctd\u003e拖拽开始\u003c/td\u003e\n    \u003c/tr\u003e   \n    \u003ctr\u003e\n        \u003ctd\u003epanmove\u003c/td\u003e\n        \u003ctd\u003e拖拽中\u003c/td\u003e\n    \u003c/tr\u003e  \n    \u003ctr\u003e\n        \u003ctd\u003epanstart\u003c/td\u003e\n        \u003ctd\u003e拖拽停止(离开屏幕)\u003c/td\u003e\n    \u003c/tr\u003e  \n    \u003ctr\u003e\n        \u003ctd\u003epanup / pandown / panright / panleft\u003c/td\u003e\n        \u003ctd\u003e不同方向的拖拽事件\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd rowspan=\"2\"\u003epress\u003c/td\u003e\n        \u003ctd\u003epress\u003c/td\u003e\n        \u003ctd\u003e按压\u003c/td\u003e\n    \u003c/tr\u003e  \n        \u003ctr\u003e\n        \u003ctd\u003epress\u003c/td\u003e\n        \u003ctd\u003e按压释放(离开屏幕)\u003c/td\u003e\n    \u003c/tr\u003e     \n    \u003ctr\u003e\n        \u003ctd\u003etap\u003c/td\u003e\n        \u003ctd\u003etap\u003c/td\u003e\n        \u003ctd\u003e点击\u003c/td\u003e\n    \u003c/tr\u003e  \n    \u003ctr\u003e\n        \u003ctd rowspan=\"2\"\u003eswipe\u003c/td\u003e\n        \u003ctd\u003eswipe\u003c/td\u003e\n        \u003ctd\u003e快划\u003c/td\u003e\n    \u003c/tr\u003e  \n    \u003ctr\u003e\n        \u003ctd\u003e swipeup / swipedown / swiperight / swipeleft\u003c/td\u003e\n        \u003ctd\u003e不同方向快划\u003c/td\u003e\n    \u003c/tr\u003e  \n    \u003ctr\u003e\n        \u003ctd rowspan=\"6\"\u003epinch\u003c/td\u003e\n        \u003ctd\u003epinch\u003c/td\u003e\n        \u003ctd\u003e缩放\u003c/td\u003e\n    \u003c/tr\u003e  \n    \u003ctr\u003e\n        \u003ctd\u003e pinchstart \u003c/td\u003e\n        \u003ctd\u003e缩放开始\u003c/td\u003e\n    \u003c/tr\u003e  \n    \u003ctr\u003e\n        \u003ctd\u003e pinchmove \u003c/td\u003e\n        \u003ctd\u003e缩放中\u003c/td\u003e\n    \u003c/tr\u003e  \n    \u003ctr\u003e\n        \u003ctd\u003e pinchend \u003c/td\u003e\n        \u003ctd\u003e缩放结束(离开屏幕)\u003c/td\u003e\n    \u003c/tr\u003e  \n        \u003ctr\u003e\n        \u003ctd\u003e pinchin \u003c/td\u003e\n        \u003ctd\u003e放大\u003c/td\u003e\n    \u003c/tr\u003e  \n        \u003ctr\u003e\n        \u003ctd\u003e pinchout \u003c/td\u003e\n        \u003ctd\u003e缩小\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd rowspan=\"6\"\u003erotate\u003c/td\u003e\n        \u003ctd\u003erotate\u003c/td\u003e\n        \u003ctd\u003e旋转\u003c/td\u003e\n    \u003c/tr\u003e  \n    \u003ctr\u003e\n        \u003ctd\u003e rotatestart \u003c/td\u003e\n        \u003ctd\u003e旋转开始\u003c/td\u003e\n    \u003c/tr\u003e  \n    \u003ctr\u003e\n        \u003ctd\u003e rotatemove \u003c/td\u003e\n        \u003ctd\u003e旋转中\u003c/td\u003e\n    \u003c/tr\u003e  \n    \u003ctr\u003e\n        \u003ctd\u003e rotateend \u003c/td\u003e\n        \u003ctd\u003e旋转结束(离开屏幕)\u003c/td\u003e\n    \u003c/tr\u003e\n\n\u003c/table\u003e\n\n#### 组合事件\n\n可以通过数组监听多个事件, 比如同时监听`panleft`和`panright`, 这样就实现监听\"x 轴拖拽\".\n\n```javascript\nat.on(['panleft', 'panright'], () =\u003e {\n    console.log('x轴拖拽');\n});\n```\n\n[:rocket: 返回目录](#目录)\n\n### :lollipop: 事件对象(event)\n\n事件触发的时候, 可以获取\"位置/速度/缩放/角度\"等数据.\n\n```javascript\nat.on('pan', (event) =\u003e {\n    // event包含速度/方向等数据\n});\n```\n\n#### event\n\n| 名称            | 数据类型        | 说明                                                                                                                     |\n| --------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------ |\n| name            | `String`        | **识别器名**, 如:pan/tap/swipe等.                                                                                      |\n| type            | `String`        | **事件名**,如 tap/panstart 等,他比`name`字段范围大,如:当`type`是 panstart 或 panmove, 而`name`返回的都是 pan             |\n| phase           | `String`        | 当前触碰状态: start \\| move \\|end \\| cancel 对应: 第一下触碰 \\| 屏幕上移动 \\| 离开屏幕 \\| 非正常离开 \\\"可 anyTouch\\\"元素 |\n| x               | `Number`        | **当前触点中心**x 坐标                                                                                                   |\n| y               | `Number`        | **当前触点中心**y 坐标                                                                                                   |\n| deltaX          | `Number`        | **当前触点**和**前触点**的 x 轴偏移距离                                                                                  |\n| deltaY          | `Number`        | **当前触点**和**前触点**的 y 轴偏移距离                                                                                  |\n| displacementX   | `Number`        | **当前触点**与**起始触点**的 x 位移(矢量)                                                                                |\n| displacementY   | `Number`        | **当前触点**与**起始触点**的 y 位移(矢量)                                                                                |\n| distanceX       | `Number`        | displacementX 的绝对值                                                                                                   |\n| distanceY       | `Number`        | displacementY 的绝对值                                                                                                   |\n| distance        | `Number`        | **当前触点**与**起始触点**的距离(标量)                                                                                   |\n| deltaTime       | `Number`        | **当前时间**与**起始触碰时间**的差值                                                                                     |\n| velocityX       | `Number`        | 当前 x 轴速度                                                                                                            |\n| velocityY       | `Number`        | 当前 y 轴速度                                                                                                            |\n| direction       | `Number`        | **前触点**与**当前触点**的方向,可以理解为瞬时方向                                                                        |\n| angle           | `Number`        | 多点触摸时,**起始触点**与**当前触点**的旋转角度                                                                          |\n| deltaAngle      | `Number`        | 多点触摸时,**前触点**与**当前触点**的旋转角度                                                                            |\n| scale           | `Number`        | 多点触摸时,**起始触点**与**当前触点**的缩放比例                                                                          |\n| deltaScale      | `Number`        | 多点触摸时,**前触点**与**当前触点**的缩放比例                                                                            |\n| maxPointLength  | `Number`        | 本轮识别周期出现过的最大触点数                                                                                           |\n| isStart         | `Boolean`       | 是否当前识别周期的开始, 规律为从 touchstart-\u003etouchend 即是一个周期, 即便多点触碰, 有一个点离开,本轮识别结束              |\n| isEnd           | `Boolean`       | 是否当前识别周期的结束                                                                                                   |\n| target          | `EventTarget`   | 绑定事件的元素                                                                                                           |\n| targets         | `EventTarget[]` | 对应多个触点会存储 touches 中的每一个 target                                                                             |\n| currentTarget   | `EventTarget`   | 实际触发绑定事件的元素                                                                                                   |\n| **nativeEvent** | `TouchEvent`    | 原生事件对象                                                                                                             |\n\n[:rocket: 返回目录](#目录)\n\n## Typescript\n\n如果在 vue 模板中绑定事件函数, 那么事件对象的类型是没法推导的, 所以需要我们自己手动标注.\n\n```html\n\u003cdiv @tap=\"onTap\"\u003e\u003c/div\u003e\n```\n\n```typescript\n// xxx.vue\nimport type { AnyTouchEvent } from 'any-touch';\nfunction onTap(e: AnyTouchEvent) {\n    // 可以正确推导出e上有x属性\n    console.log(e.x);\n}\n```\n\n[:rocket: 返回目录](#目录)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fany86%2Fany-touch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fany86%2Fany-touch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fany86%2Fany-touch/lists"}