https://github.com/rozek/svelte-touch-to-mouse
maps touch events to mouse events (not only for Svelte)
https://github.com/rozek/svelte-touch-to-mouse
mouse-emulation mouse-events touch-events
Last synced: 5 months ago
JSON representation
maps touch events to mouse events (not only for Svelte)
- Host: GitHub
- URL: https://github.com/rozek/svelte-touch-to-mouse
- Owner: rozek
- License: mit
- Created: 2021-05-30T11:59:57.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-29T09:06:06.000Z (almost 3 years ago)
- Last Synced: 2024-08-09T20:51:08.763Z (9 months ago)
- Topics: mouse-emulation, mouse-events, touch-events
- Language: TypeScript
- Homepage:
- Size: 83 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# svelte-touch-to-mouse #
maps touch events to mouse events (not only for Svelte)
**NPM users**: please consider the [Github README](https://github.com/rozek/svelte-touch-to-mouse/blob/main/README.md) for the latest description of this package (as updating the docs would otherwise always require a new NPM package version)
> Note: this code generates events of type `mousemove`, `mousedown` and `mouseup` - it does _not_ (yet) generate `mouseenter`, `mouseleave`, `mouseover` or `mouseout` events. Additionally, `mousemove` events continue to fire even after the touchpoint has left the HTML element where the touch started
> Just a small note: if you like this module and plan to use it, consider "starring" this repository (you will find the "Star" button on the top right of this page), so that I know which of my repositories to take most care of.
## Installation ##
`svelte-touch-to-mouse` may be used as an ECMAScript module (ESM), a CommonJS or AMD module or from a global variable.
You may either install the package into your build environment using [NPM](https://docs.npmjs.com/) with the command
```
npm install svelte-touch-to-mouse
```
or load the plain script file directly
```html
```
## Access ##
How to access the package depends on the type of module you prefer
* ESM (or Svelte): `import mapTouchToMouseFor from 'svelte-touch-to-mouse'`
* CommonJS: `const mapTouchToMouseFor = require('svelte-touch-to-mouse')`
* AMD: `require(['svelte-touch-to-mouse'], (mapTouchToMouseFor) => {...})`
Alternatively, you may access the global variable `mapTouchToMouseFor` directly.
## Usage within Svelte ##
For Svelte, it is recommended to import the package in a module context. From then on, its exports may be used as usual:
```html
div {
-webkit-touch-callout:none;
-ms-touch-action:none; touch-action:none;
}
import mapTouchToMouseFor from 'svelte-touch-to-mouse'
mapTouchToMouseFor('div')
just as an example - works with other elements as well
```
## Usage as ECMAScript, CommonJS or AMD Module (or as a global Variable) ##
Let's assume that you already "required" or "imported" (or simply loaded) the module according to your local environment. In that case, you may use it as follows:
```javascript
mapTouchToMouseFor('div')
```
## Examples ##
This module was initially developed in order to make [svelte-agnostic-draggable](https://github.com/rozek/svelte-agnostic-draggable) "mobile capable" - for that reason, please, look there for some meaningful examples.
## Background Information ##
There still exist numerous JavaScript libraries and frameworks dealing with `MouseEvent`s only - ignoring the `TouchEvent`s used on mobile devices. This simple module maps `TouchEvent`s to corresponding `MouseEvent`s and, thus, allows such libraries to be used on mobile devices as well.
It does so by mapping events for certain HTML elements only in order to avoid undesired side effects on other elements.
`mapTouchToMouseFor()`
maps `TouchEvent`s for all HTML elements matching the given ``. `mapTouchToMouseFor` may well be called multiple times (for different selectors) - or (in the extreme case) once with selector `*` to map events for all HTML elements
**Important Note**
Presumably, you also want to apply the following CSS settings to all HTML elements affected by `mapTouchToMouseFor`
```
-webkit-touch-callout:none;
-ms-touch-action:none; touch-action:none;
```
for the `MouseEvent` consumers to work as expected.
## Build Instructions ##
You may easily build this package yourself.
Just install [NPM](https://docs.npmjs.com/) according to the instructions for your platform and follow these steps:
1. either clone this repository using [git](https://git-scm.com/) or [download a ZIP archive](https://github.com/rozek/svelte-touch-to-mouse/archive/refs/heads/main.zip) with its contents to your disk and unpack it there
2. open a shell and navigate to the root directory of this repository
3. run `npm install` in order to install the complete build environment
4. execute `npm run build` to create a new build
You may also look into the author's [build-configuration-study](https://github.com/rozek/build-configuration-study) for a general description of his build environment.
## License ##
[MIT License](LICENSE.md)