Name: ember-hammerjs
Owner: HTMLNext
Description: Hammer.js primitives for Ember Applications.
Created: 2016-03-18 13:29:36.0
Updated: 2017-04-29 07:54:16.0
Pushed: 2018-01-18 20:30:58.0
Homepage: null
Size: 134
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Ember HammerJS provides an easy way to use hammer.js by making it simple to define and use HammerJS managers and recognizers throughout your app.
This library provides the base primitives which ember-gestures uses to give you hammer.js based event methods on your components.
If you are looking for a complete box solution, or “fast click” support you will want to check out ember-gestures and ember-hammertime. You should use this library directly when you need isolated, targeted use of managers and recognizers.
Make sure you stop and restart your ember-cli
asset server after installation.
via ember install
r install ember-hammerjs
This will run the default blueprint which additionally installs hammer.js
.
via npm install
If you installed this via npm
, you will need to run the default blueprint.
install --save-dev ember-hammerjs && ember g ember-hammerjs
This addon is part of the ember-gestures family, for support join the e-gestures channel on Slack.
A Recognizer
detects a gesture on a target element by listening to
received touch, mouse, and pointer events and passing through a series
of rules to determine whether it's gesture is occurring.
Recognizer
s are registered with a Manager
, which emits the recognized
gestures for consumption by your app. This addon does the grunt work of
creating Managers and wiring up Recognizers for you.
All you need to do to use gestures is tell your app where you want a Manager to be created and what Recognizers it should have.
Example
rt RecognizerMixin from 'ember-hammerjs/mixins/recognizers';
rt Ember from 'ember';
t {
mponent
Ember;
rt default Component.extend(RecognizerMixin, {
cognizers: 'pan tap press'
The component would create a new Manager and add the recognizers for pan, tap, and press.
The component would recognize gestures based on events originating on it or it's child elements.
You should be strategic about where you put your components with Managers.
You don't need a lot of Managers, you just need them placed strategically.
You could even put one at the base of your app, but be warned pinch
rotate
pan
and swipe
can break scrolling behavior if not placed correctly.
pan
and swipe
are horizontal only (configured this way to avoid
breaking vertical scroll). vertical-pan
and vertical-swipe
are
vertical only (configured this way to avoid breaking horizontal scroll).
vertical-
variants will still trigger the usual pan
and swipe
events,
and can be used together with pan
and swipe
to capture gestures both
horizontally and vertically at the same time.
Using gestures emitted by Hammer recognizers with Ember is almost like using any other event with Ember.
Your recognizers will be configured to emit Events
, so to consume a gesture, you just need to add an
event handler to your component. The handler's name just needs to match the camelCase version of a gesture
event.
Example
rt Ember from 'ember';
t {
mponent
Ember;
rt default Component.extend({
nStart(e) {
// do something with the event
Gesture events bubble through the DOM, so you can use them with actions as well.
{{action "foo" on="swipeRight"}}>
ember g recognizer <name>
This will generate the file ember-gestures/recognizers/name.js
.
Once you've filled out the recognizer (see ./addon/recognizers/ for examples),
it will be available to use in your app just like the default recognizers.
Sometimes smaller buttons or critical buttons need a larger capture area than their visible area. You can increase the area that recognizes touch events for a specific button with a little bit of CSS.
The jQuery events you need to trigger are the Hammer variant, meaning it
is entirely lowercase swiperight
, panup
.
jQuery events come with baggage, and using the trigger
helper executes
handlers in a different order than they would otherwise execute, and in
some situations will cause a handler to execute twice. If you are experiencing
issues with testing gesture events, try creating your own trigger
helper
that uses native APIs instead of jQuery to trigger the event.
Don't add recognizers to components created within an {{#each}}
loop.
Use a recognizer at the base of the each
instead.
Contributions are very welcome.
When making a PR try to use the following conventions:
Commit Messages:
type(shortname): action based description
Examples:
fast-action
componentBranch Naming:
type/short-description
Examples: