Git Product home page Git Product logo

ember-shortcuts's Introduction

Ember Shortcuts

Inspiration

keymaster. This library could not exists without it, and is, in fact, an adaptation of it that integrates cleanly with Ember.

Installation

Get the code:

bower install ember-shortcuts

Include it on your page somewhere after ember.js.

Usage

In any route:

Ember.Route.extend({
  shortcuts: {
    'shift+a': 'someAction'
  },

  actions: {
    someAction: function() {
      console.log('someAction');
    }
  }
});

Like actions, shortcuts get dispatch bottom-up through the currently active routes.

Unlike actions, the shortcut handling does not bubble. In the example above, if a child of that route defined a shift+a: 'otherAction' handler and was active when the shortcut was pressed, the action otherAction would get sent instead of someAction.

KeyDown/KeyUp

Passing in an object rather than a string enables listening for keydown and key up events separately.

In any route:

Ember.Route.extend({
  shortcuts: {
    'shift+a': { keyDown: 'triggeredOnKeyDown', keyUp: 'triggeredOnKeyUp' },
  },

  actions: {
    triggeredOnKeyDown: function() {
      console.log('keyDown!');
    },
    triggeredOnKeyUp: function() {
      console.log('keyUp!');
    },
  }
});

Injection

Ember.Shortcuts, once includes, is available to you as an injected singleton on your controllers, components and routes as the shortcuts property.

this.shortcuts.disable this.shortcuts.enable

Call this to toggle whether or not the global keyboard shortcut handlers will fire.

Filters

Before any event is triggered this.shortcuts.filters is checked to determine if the event will fire.

By default, ember-shortcuts checks the event target isn't an input, select or text area.

Modify this.shortcuts.filters to add extra filters, for example:

function modalIsNotOpen() {
  return !Ember.$('.modal').length;
}

function targetIsNotInput(event) {
  const tagName = event.target.tagName;
  return (tagName !== 'INPUT') && (tagName !== 'SELECT') && (tagName !== 'TEXTAREA');
}

Ember.Shortcuts.reopen({
  filters: [modalIsNotOpen, targetIsNotInput]
});

ember-shortcuts's People

Contributors

novaugust avatar pezmc avatar satchmorun avatar westlywright avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.