{"id":16701113,"url":"https://github.com/scriptex/touchsweep","last_synced_at":"2026-03-13T22:36:04.797Z","repository":{"id":41045342,"uuid":"138967734","full_name":"scriptex/touchsweep","owner":"scriptex","description":"Detect your swipe gestures direction","archived":false,"fork":false,"pushed_at":"2024-04-30T11:31:03.000Z","size":1532,"stargazers_count":10,"open_issues_count":0,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-02T06:13:52.325Z","etag":null,"topics":["event-detection","mouse-event-detection","mouse-events","swipe-detector","touch-event-detection","touch-events"],"latest_commit_sha":null,"homepage":"https://touchsweep.atanas.info","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/scriptex.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":["scriptex"],"patreon":"atanas","open_collective":null,"ko_fi":"scriptex","tidelift":null,"community_bridge":null,"liberapay":"scriptex","issuehunt":"scriptex","otechie":null,"custom":["paypal.me/scriptex","revolut.me/scriptex"]}},"created_at":"2018-06-28T04:54:37.000Z","updated_at":"2024-05-04T00:22:19.144Z","dependencies_parsed_at":"2023-10-15T09:30:07.796Z","dependency_job_id":"436c6359-937f-465a-9b9f-58568ced23db","html_url":"https://github.com/scriptex/touchsweep","commit_stats":{"total_commits":328,"total_committers":9,"mean_commits":36.44444444444444,"dds":0.6189024390243902,"last_synced_commit":"3e51fc13a4317b10c33d218206d5faacf7d21986"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scriptex%2Ftouchsweep","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scriptex%2Ftouchsweep/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scriptex%2Ftouchsweep/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scriptex%2Ftouchsweep/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scriptex","download_url":"https://codeload.github.com/scriptex/touchsweep/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243835942,"owners_count":20355611,"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":["event-detection","mouse-event-detection","mouse-events","swipe-detector","touch-event-detection","touch-events"],"created_at":"2024-10-12T18:28:47.653Z","updated_at":"2026-03-13T22:35:59.744Z","avatar_url":"https://github.com/scriptex.png","language":"TypeScript","readme":"[![Travis CI](https://travis-ci.com/scriptex/touchsweep.svg?branch=master)](https://travis-ci.com/scriptex/touchsweep)\n[![Github Build](https://github.com/scriptex/touchsweep/workflows/Build/badge.svg)](https://github.com/scriptex/touchsweep/actions?query=workflow%3ABuild)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/34d3d75710534dc6a38c3584a1dcd068)](https://www.codacy.com/gh/scriptex/touchsweep/dashboard?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=scriptex/touchsweep\u0026utm_campaign=Badge_Grade)\n[![Codebeat Badge](https://codebeat.co/badges/d765a4c8-2c0e-44f2-89c3-fa364fdc14e6)](https://codebeat.co/projects/github-com-scriptex-touchsweep-master)\n[![CodeFactor Badge](https://www.codefactor.io/repository/github/scriptex/touchsweep/badge)](https://www.codefactor.io/repository/github/scriptex/touchsweep)\n[![DeepScan grade](https://deepscan.io/api/teams/3574/projects/5257/branches/40799/badge/grade.svg)](https://deepscan.io/dashboard#view=project\u0026tid=3574\u0026pid=5257\u0026bid=40799)\n[![Analytics](https://ga-beacon-361907.ew.r.appspot.com/UA-83446952-1/github.com/scriptex/touchsweep/README.md?pixel)](https://github.com/scriptex/touchsweep/)\n\n# TouchSweep\n\n\u003e Super tiny vanilla JS module to detect swipe direction and trigger custom events accordingly.\n\n## Visitor stats\n\n![GitHub stars](https://img.shields.io/github/stars/scriptex/touchsweep?style=social)\n![GitHub forks](https://img.shields.io/github/forks/scriptex/touchsweep?style=social)\n![GitHub watchers](https://img.shields.io/github/watchers/scriptex/touchsweep?style=social)\n![GitHub followers](https://img.shields.io/github/followers/scriptex?style=social)\n\n## Code stats\n\n![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/scriptex/touchsweep)\n![GitHub repo size](https://img.shields.io/github/repo-size/scriptex/touchsweep?style=plastic)\n![GitHub language count](https://img.shields.io/github/languages/count/scriptex/touchsweep?style=plastic)\n![GitHub top language](https://img.shields.io/github/languages/top/scriptex/touchsweep?style=plastic)\n![GitHub last commit](https://img.shields.io/github/last-commit/scriptex/touchsweep?style=plastic)\n\n## Install\n\n```sh\nnpm i touchsweep\n```\n\nor\n\n```sh\nyarn add touchsweep\n```\n\n## Usage\n\n```javascript\nimport TouchSweep from 'touchsweep';\n\nconst area = document.getElementById('swipe-area');\nconst data = {\n\tvalue: 1\n};\nconst touchThreshold = 20;\n\nconst touchSweepInstance = new TouchSweep(area, data, touchThreshold);\n\n// Then listen for custom swipe events and do your magic:\n\narea.addEventListener('swipeleft', event =\u003e {\n\t// You have swiped left\n\t// Custom event data is located in `event.detail`\n\t// Details about coordinates are also available under `event.detail`\n});\n\narea.addEventListener('swiperight', event =\u003e {\n\t// You have swiped right\n\t// Custom event data is located in `event.detail`\n\t// Details about coordinates are also available under `event.detail`\n});\n\narea.addEventListener('swipedown', event =\u003e {\n\t// You have swiped down\n\t// Custom event data is located in `event.detail`\n\t// Details about coordinates are also available under `event.detail`\n});\n\narea.addEventListener('swipeup', event =\u003e {\n\t// You have swiped up\n\t// Custom event data is located in `event.detail`\n\t// Details about coordinates are also available under `event.detail`\n});\n\narea.addEventListener('swipemove', event =\u003e {\n\t// You are swiped continuously\n\t// Custom event data is located in `event.detail`\n\t// Details about coordinates are also available under `event.detail`\n});\n\narea.addEventListener('tap', event =\u003e {\n\t// You have tapped\n\t// Custom event data is located in `event.detail`\n\t// Details about coordinates are also available under `event.detail`\n});\n```\n\n## Options and default settings\n\nThe module constructor accepts three (3) arguments:\n\n-   `element`: A HTML Element. Default is `document.body`\n-   `eventData`: A plain JS object. Default is `{}`\n-   `threshold`: How many pixels to count until an event is fired. Default is 40\n\n## API\n\nTouchSweep provides a minimal API for you to use.\n\nThe `TouchSweep` instance exposes two public methods which allow you to add or to remove all event listeners responsible for the module functionality.\n\nThis is useful in cases where you want to remove the `TouchSweep` container/area from the DOM and prevent possible memory leaks by removing all event listeners related to this DOM element.\n\nIn order to remove all previously attached event listeners:\n\n```javascript\ntouchSweepInstance.unbind();\n```\n\nIn order to add all previously removed event listeners:\n\n```javascript\ntouchSweepInstance.bind();\n```\n\n## Supported Browsers\n\nCurrently all evergreen browsers are supported.\n\n## Demo\n\nThere is a simple demo illustrating how the TouchSweep library works.\n\nCheck the code [here](https://github.com/scriptex/touchsweep/blob/master/demo/index.html) and the live demo [here](https://touchsweep.atanas.info)\n\n## Typescript\n\n`TouchSweep` is written in Typescript and provides full Typescript support out of the box.\n\n## LICENSE\n\nMIT\n\n---\n\n\u003cdiv align=\"center\"\u003e\n    Connect with me:\n\u003c/div\u003e\n\n\u003cbr /\u003e\n\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://atanas.info\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/logo.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"mailto:hi@atanas.info\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/email.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://www.linkedin.com/in/scriptex/\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/linkedin.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://github.com/scriptex\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/github.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://gitlab.com/scriptex\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/gitlab.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://twitter.com/scriptexbg\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/twitter.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://www.npmjs.com/~scriptex\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/npm.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://www.youtube.com/user/scriptex\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/youtube.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://stackoverflow.com/users/4140082/atanas-atanasov\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/stackoverflow.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://codepen.io/scriptex/\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/codepen.svg\" width=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://profile.codersrank.io/user/scriptex\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/codersrank.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://linktr.ee/scriptex\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/linktree.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n---\n\n\u003cdiv align=\"center\"\u003e\nSupport and sponsor my work:\n\u003cbr /\u003e\n\u003cbr /\u003e\n\u003ca href=\"https://twitter.com/intent/tweet?text=Checkout%20this%20awesome%20developer%20profile%3A\u0026url=https%3A%2F%2Fgithub.com%2Fscriptex\u0026via=scriptexbg\u0026hashtags=software%2Cgithub%2Ccode%2Cawesome\" title=\"Tweet\"\u003e\n\t\u003cimg src=\"https://img.shields.io/badge/Tweet-Share_my_profile-blue.svg?logo=twitter\u0026color=38A1F3\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://paypal.me/scriptex\" title=\"Donate on Paypal\"\u003e\n\t\u003cimg src=\"https://img.shields.io/badge/Donate-Support_me_on_PayPal-blue.svg?logo=paypal\u0026color=222d65\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://revolut.me/scriptex\" title=\"Donate on Revolut\"\u003e\n\t\u003cimg src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/revolut.json\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://patreon.com/atanas\" title=\"Become a Patron\"\u003e\n\t\u003cimg src=\"https://img.shields.io/badge/Become_Patron-Support_me_on_Patreon-blue.svg?logo=patreon\u0026color=e64413\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://ko-fi.com/scriptex\" title=\"Buy Me A Coffee\"\u003e\n\t\u003cimg src=\"https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-yellow.svg?logo=ko-fi\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://liberapay.com/scriptex/donate\" title=\"Donate on Liberapay\"\u003e\n\t\u003cimg src=\"https://img.shields.io/liberapay/receives/scriptex?label=Donate%20on%20Liberapay\u0026logo=liberapay\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/bitcoin.json\" title=\"Donate Bitcoin\"\u003e\n\t\u003cimg src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/bitcoin.json\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/etherium.json\" title=\"Donate Etherium\"\u003e\n\t\u003cimg src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/etherium.json\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/shiba-inu.json\" title=\"Donate Shiba Inu\"\u003e\n\t\u003cimg src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/shiba-inu.json\" /\u003e\n\u003c/a\u003e\n\u003c/div\u003e\n","funding_links":["https://github.com/sponsors/scriptex","https://patreon.com/atanas","https://ko-fi.com/scriptex","https://liberapay.com/scriptex","https://issuehunt.io/r/scriptex","paypal.me/scriptex","revolut.me/scriptex","https://paypal.me/scriptex","https://liberapay.com/scriptex/donate"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscriptex%2Ftouchsweep","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscriptex%2Ftouchsweep","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscriptex%2Ftouchsweep/lists"}