ember-keyboard - npm Package Versions

v6.0.2 (2020-10-30)

:rocket: Enhancement

• #281 support binding to "+" key (@marcoow)

:memo: Documentation

• #271 Update README to add logo and adjust order (@lukemelia)
• #269 Adds logo, also as favicon (@MinThaMie)

:house: Internal

• #285 Update ember/ember-cli (@lukemelia)
• #279 Bump release-it-lerna-changelog from 2.3.0 to 3.0.0 (@dependabot-preview[bot])

Committers: 4

• Anne-Greeth van Herwijnen (@MinThaMie)
• Luke Melia (@lukemelia)
• Marco Otte-Witte (@marcoow)
• @dependabot-preview[bot]

v6.0.1 (2020-09-07)

:house: Internal

• #251 Bump release-it from 13.6.9 to 14.0.2 (@dependabot-preview[bot])
• #236 Bump eslint from 7.5.0 to 7.7.0 (@dependabot-preview[bot])
• #226 Bump ember-modifier from 1.0.3 to 2.1.0 (@dependabot-preview[bot])
• #219 [Security] Bump elliptic from 6.5.2 to 6.5.3 (@dependabot-preview[bot])
• #218 Bump @glimmer/component from 1.0.0 to 1.0.1 (@dependabot-preview[bot])
• #216 Bump @glimmer/tracking from 1.0.0 to 1.0.1 (@dependabot-preview[bot])
• #224 Bump qunit-dom from 1.2.0 to 1.4.0 (@dependabot-preview[bot])
• #199 Bump ember-auto-import from 1.5.3 to 1.6.0 (@dependabot-preview[bot])
• #213 Bump eslint-plugin-ember from 8.9.1 to 8.9.2 (@dependabot-preview[bot])
• #211 Bump eslint from 7.4.0 to 7.5.0 (@dependabot-preview[bot])
• #208 Bump marked from 1.1.0 to 1.1.1 (@dependabot-preview[bot])
• #215 Bump release-it from 13.6.5 to 13.6.6 (@dependabot-preview[bot])
• #189 Add test to make sure ember-keybaord doesn't break fastboot rendering (@lukemelia)

Committers: 2

• Luke Melia (@lukemelia)
• @dependabot-preview[bot]

v6.0.0 (2020-06-10)

This major release sports new Octane-friendly API. You can see examples and read about the reasons for the API choices in our API Design doc.

Upgrading from ember-keyboard 6.0.0-beta.1 to 6.0.0

The only changes since 6.0.0-beta.1 were internal dependency updates. Upgrading should be smooth.

Upgrading from ember-keyboard 6.0.0-beta.0 to 6.0.0

The keyboard-press component has been deprecated and replaced with the on-key helper. The on-keyboard and keyboard-shortut modifiers have been deprecated and replaced with the on-key modifier. The deprecations page has more info, along with the 5 to 6 upgrade guide immediately below.

Upgrading from ember-keyboard 5.0.0 to 6.0.0

ember-keyboard 6.0.0-beta.1 introduces new APIs to bring ember-keyboard into the Ember Octane era. The old mixins-based API still works but is deprecated in this release and slated for removal in version 7.

Version 6 requires Ember 3.8 or higher, so if you are on a version of Ember before that, you should stick with 5.0.0 until you are able to upgrade your app's Ember version.

If your app is on a recent version of Ember, you are good to go. The path is to upgrade to ember-keyboard 6.x and you can iteratively update to the new APIs until you have no more deprecation warnings left.

The deprecations page discusses migration paths for each warning you may encounter, but our broader advice is to consider moving as much of your keyboard handling logic to templates as possible. We think that you'll find the on-key helper and modifier to be very convenient to work with. The decorator API (which required ember 3.10 or higher) is closest equivalent to the mixins API, but it should be used sparingly in situations where the template approach isn't a good fit.

There is one other potential breaking change to be aware of when upgrading from v5 to v6: ember-keyboard versions before 6.0 had an ambiguous API when it came to specifying key combos and required the use of code identifiers, like KeyT, Digit1, etc. Be sure to read the docs regarding key vs. code properties and be sure you are specifying the key combo consistent with your intended behavior. You will likely find that you want to update some key combos to the key equivalent. e.g. replace ctrl+KeyT with ctrl+t.

v4.0.0 (2018-09-05)

Support software keymaps

Big thanks to @NullVoxPopuli for this PR. Now, ember-keyboard will respond to the key mapping, rather than the key itself. For instance, with a Dvorak key mapping, pressing 'k' will give a code of 'KeyV' and a key of 'k'. Now, ember-keyboard will treat a Dvorak 'KeyV' as a 'k'.

This may introduce a regression if you intended to map to the key themselves, rather than to their code. If that's the case, please take out an issue and we'll figure out a way to support that behavior as well.

v3.0.0 (2018-01-16)

Remove jQuery and make touch/mouse events opt-in

This release has two potential breaking changes:

1. jQuery's been removed! This means that responders will now receive vanilla events, instead of jQuery events. For instance, using jQuery's isImmediatePropagationStopped will no longer work:

responder: Ember.on(keyDown('KeyA'), function(event) {
  event.isImmediatePropagationStopped();
})

1. Mouse/touch events are now opt-in. You'll have to specify them in your config/environment.js file:

emberKeyboard: {
  listeners: ['keyUp', 'keyDown', 'keyPress', 'click', 'mouseDown', 'mouseUp', 'touchStart', 'touchEnd']
}

...