npm

Need private packages and team management tools?Check out npm Orgs. »

ember-orientation

0.1.0 • Public • Published

Ember-orientation

Greenkeeper badge

Build Status Code Climate npm version Dependency Status devDependency Status Ember Observer Score

Effortlessly respond to device orientation events and changes

Use

  • ember-cli < 0.2.3 ember install:addon ember-orientation
  • ember-cli >= 0.2.3 ember install ember-orientation

Service: DeviceOrientation

Included in this addon is a service that emits events on orientation change...

let MyComponent = Ember.Component.extend({
 
  didInsertElement() {
    this._super(...arguments);
 
    this.get('orientation').on('tilt', evt => {
      console.log(`alpha: ${evt.alpha}\tbeta: ${evt.beta}\tgamma: ${evt.gamma}`);
    });
  }
 
});

...and has properties with the latest orientation values that you can bind to

let MyComponent = Ember.Component.extend({
  alphaTiltAngle: Ember.computed.alias('orientation.alpha')
});

The service also has two methods to make the tilt data more easily consumable

  • transformationMatrix - a 9-length transformation matrix calculated from alpha, beta and gamma as follows: Rotation Matrix
  • normalVector - a 3-length unit vector normal to the screen of the device.

Mixin: DeviceOrientationAware

To make this service even easier to use, a mixin is included

import DeviceOrientationAware from 'ember-orientation/mixins/device-orientation-aware';
 
let MyComponent = Ember.Component.extend(DeviceOrientationAware, {
 
  // Fires whenever tilt exceeds "sensitivity"
  didTilt(evt) {
    let {alpha, beta, gamma} = evt;
    ...
  },
 
  // A debounced version
  debouncedDidTilt(evt) {
    let {alpha, beta, gamma} = evt;
    ...
  },
 
  // tiltAlpha, tiltBeta, tiltGamma properties are included
  transformStyle: Ember.computed('tiltAlpha', 'tiltBeta', 'tiltGamma', {
    get() {
      return `transform: rotateZ(${(this.get('tiltAlpha') - 180 )}deg) ` +
             `rotateX(${this.get('tiltBeta')}deg) ` +
             `rotateY(${- this.get('tiltGamma')}deg)`;
    }
  })
});

Configuration

in your config/environment.js, you may configure some options

module.exports = function(environment) {
  var ENV = {
    orientationServiceDefaults: {
      debounceTimeout    : 50, // ms
      tiltAngleSensitivity: 1, // degrees
      injectionFactories : [ 'view', 'component']
    }
  }
}
  • debounceTimeout - Debounce time used for debouncedDidTilt hook
  • tiltAngleSensitivity - didTilt and debouncedDidTilt will only be called when tilt angle along any access is >= this value (in degrees)
  • injectionFactories - customize which types of objects the orientation service will be injected onto upon initialization

Installation

  • git clone this repository
  • npm install
  • bower install

Running

Running Tests

  • ember test
  • ember test --server

Building

  • ember build

Credits

    • Image Source: Opera developer docs

For more information on using ember-cli, visit http://www.ember-cli.com/.

Analytics

install

npm i ember-orientation

Downloadsweekly downloads

2

version

0.1.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
Report a vulnerability