@kazzkiq/svelte-hammer
v0.1.1
Published
hammerjs for svelte
Downloads
5
Readme
Hammer.js wrapper for Svelte to support some operation in the mobile.
This is directive of svelte for Hammer.js 2.x.
This is easy for using Hammer.js. It just use directive of svelte.
Install
This library support Svelte >= 3.0. And use Hammer.js > 2.x.
NPM
npm install svelte-hammer
or
yarn add svelte-hammer
Usage
See Hammer.js documentation for all available events.
Pan
<script>
import { pan } from 'svelte-hammer'
</script>
<div
use:pan
on:panstart={() => /* Pan Start */}
on:panmove={() => /* Pan Move */}
on:panend={() => /* Pan End */}
>
</div>
Directives
on:pan
: Detect all pan eventon:panstart
: Detect start pan eventon:panmove
: Detect move pan eventon:panend
: Detect end pan eventon:pancancel
: Detect cancel pan eventon:panleft
: Detect left pan eventon:panright
: Detect right pan eventon:panup
: Detect up pan eventon:pandown
: Detect down pan event
Pinch
<script>
import { pinch } from 'svelte-hammer'
</script>
<div
use:pinch
on:pinchstart={() => /* Pinch Start */}
on:pinchmove={() => /* Pinch Move */}
on:pinchend={() => /* Pinch End */}
>
</div>
Directives
on:pinch
: Detect all pinch eventon:pinchstart
: Detect start pinch eventon:pinchmove
: Detect move pinch eventon:pinchend
: Detect end pinch eventon:pinchcancel
: Detect cancel pinch eventon:pinchin
: Detect in pinch eventon:pinchout
: Detect out pinch event
Press
<script>
import { press } from 'svelte-hammer'
</script>
<div
use:press
on:press={() => /* Press */}
on:pressup={() => /* Press Up */}
>
</div>
Directives
on:press
: Detect press eventon:pressup
: Detect up press event
Rotate
<script>
import { rotate } from 'svelte-hammer'
</script>
<div
use:rotate
on:rotatestart={() => /* Rotate Start */}
on:rotatemove={() => /* Rotate Move */}
on:rotateend={() => /* Rotate End */}
>
</div>
Directives
on:rotate
: Detect all rotate eventon:rotatestart
: Detect start rotate eventon:rotatemove
: Detect move rotate eventon:rotateend
: Detect end rotate eventon:rotatecancel
: Detect cancel rotate event
Swipe
<script>
import { swipe } from 'svelte-hammer'
</script>
<div
use:swipe
on:swipeleft={(ev) => /* Swipe Left */}
on:swiperight={(ev) => /* Swipe Right */}
on:swipeup={(ev) => /* Swipe Up */}
on:swipedown={(ev) => /* Swipe Down */}
>
</div>
Directives
on:swipe
: Detect all swipe eventon:swipeleft
: Detect left swipe eventon:swiperight
: Detect right swipe eventon:swipeup
: Detect up swipe eventon:swipedown
: Detect down swipe event
Tap
<script>
import { tap } from 'svelte-hammer'
</script>
<div
use:tap
on:tap={() => /* Tap */}
>
</div>
Directives
on:tap
: Detect tap event
Using Custom Options
Using custom recognizer options such as direction
and threshold
:
<script>
import { Hammer, swipe } from 'svelte-hammer'
</script>
<div
use:swipe={{ direction: Hammer.DIRECTION_ALL }}
on:swipeleft={(ev) => /* Swipe Left */}
on:swiperight={(ev) => /* Swipe Right */}
on:swipeup={(ev) => /* Swipe Up */}
on:swipedown={(ev) => /* Swipe Down */}
>
</div>
All gestures same usage.
License
MIT