Release 6.0.4

This will be the last release in the 6.x series. 7.0 will drop code related to several deprecations.

💥 Breaking Change

• #492 [Breaking] Drop support for Node.js 10, 13, 15 (@SergeAstapov)

🚀 Enhancement

• #494 Update ember-modifier to add support for 3.22 modifier capabilities (@SergeAstapov)
• #499 Deprecate old propagation model (@SergeAstapov)

🏠 Internal

• #490 Update npmignore file (@SergeAstapov)
• #498 Fix CI for latest Ember v4 beta/canary scenarios (@SergeAstapov)

Committers: 1

• Sergey Astapov (@SergeAstapov)

Release 6.0.3

highlightjs/highlight.js#2877

v6.0.3 (2021-05-28)

ember-cli-babel has been updated in this release.

🐛 Bug Fix

• #347 fix: ES6 @keyResponder decorator fails with params (@urbany)

🏠 Internal

• #413 Update dependencies including ember-cli-babel to fix address some deprecations (@lukemelia)
• #339 Bump eslint from 7.13.0 to 7.19.0 (@dependabot-preview[bot])
• #341 Bump @glimmer/component from 1.0.2 to 1.0.3 (@dependabot-preview[bot])
• #337 Bump @glimmer/tracking from 1.0.2 to 1.0.3 (@dependabot-preview[bot])
• #331 Bump eslint from 7.13.0 to 7.18.0 (@dependabot-preview[bot])
• #335 Bump ember-template-lint from 2.14.0 to 2.18.0 (@dependabot-preview[bot])
• #301 Bump ember-compatibility-helpers from 1.2.1 to 1.2.2 (@dependabot-preview[bot])
• #309 Bump release-it from 14.2.1 to 14.2.2 (@dependabot-preview[bot])
• #334 Bump marked from 1.2.3 to 1.2.8 (@dependabot-preview[bot])
• #302 Bump qunit-dom from 1.5.0 to 1.6.0 (@dependabot-preview[bot])
• #336 Replace Travis CI with Github Actions (@lukemelia)
• #295 Bump marked from 1.2.2 to 1.2.3 (@dependabot-preview[bot])
• #297 Bump eslint from 7.12.1 to 7.13.0 (@dependabot-preview[bot])
• #298 Bump ember-load-initializers from 2.1.1 to 2.1.2 (@dependabot-preview[bot])
• #290 Bump ember-modifier from 2.1.0 to 2.1.1 (@dependabot-preview[bot])
• #291 Bump eslint-plugin-ember from 9.3.0 to 9.4.0 (@dependabot-preview[bot])
• #294 Bump ember-auto-import from 1.6.0 to 1.7.0 (@dependabot-preview[bot])
• #292 Bump release-it-lerna-changelog from 3.0.0 to 3.1.0 (@dependabot-preview[bot])
• #293 Bump release-it from 14.2.0 to 14.2.1 (@dependabot-preview[bot])

Committers: 3

• João Teixeira (@urbany)
• Luke Melia (@lukemelia)
• @dependabot-preview[bot]

Release 6.0.2

🚀 Enhancement

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

📝 Documentation

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

🏠 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]

Release 6.0.1

🏠 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]

Release 6.0.0

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 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.

Here's an example of upgrading an Ember app that happens to be open-source: rust-lang/crates.io#2563

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 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.

🏠 Internal Changes since 6.0.0-beta.1

• #186 [Security] Bump websocket-extensions from 0.1.3 to 0.1.4 (@dependabot-preview[bot])
• #188 Bump eslint from 7.1.0 to 7.2.0 (@dependabot-preview[bot])
• #187 Bump ember-angle-bracket-invocation-polyfill from 2.0.2 to 2.1.0 (@dependabot-preview[bot])
• #181 Bump eslint-plugin-ember from 7.11.1 to 8.6.0 (@dependabot-preview[bot])
• #183 [Security] Bump tar from 2.2.1 to 2.2.2 (@dependabot-preview[bot])

Committers: 2

• Luke Melia (@lukemelia)

Other contributors

Thank you to @optikalefx, @NullVoxPopuli @mattmcmanus, @seanCodes, and @bendemboski for helping to shape the API Design for this release.

v6.0.0-beta.1

This 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.0 to 6.0.0-beta.1

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.x to 6.x

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.

🚀 💥 Breaking Change

• #135 New Octane-friendly APIs (@lukemelia)

📝 Documentation

• #179 Improve readability of docs site (@lukemelia)

🏠 Internal

* [#180](https://github.com//pull/180) Bump ember-cli-babel from 7.20.4 to 7.20.5 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#178](https://github.com//pull/178) Bump release-it from 13.6.1 to 13.6.2 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#177](https://github.com//pull/177) Bump ember-cli-babel from 7.20.0 to 7.20.4 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#171](https://github.com//pull/171) Bump qunit-dom from 1.1.0 to 1.2.0 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#169](https://github.com//pull/169) Bump eslint from 7.0.0 to 7.1.0 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#166](https://github.com//pull/166) Bump ember-template-lint from 2.4.1 to 2.8.0 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#167](https://github.com//pull/167) Bump ember-compatibility-helpers from 1.2.0 to 1.2.1 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#168](https://github.com//pull/168) Bump markdown-code-highlighting from 0.2.0 to 0.2.1 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#160](https://github.com//pull/160) [Security] Bump tar from 2.2.1 to 2.2.2 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#161](https://github.com//pull/161) [Security] Bump lodash from 4.17.10 to 4.17.15 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#162](https://github.com//pull/162) Bump eslint-plugin-node from 11.0.0 to 11.1.0 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#156](https://github.com//pull/156) [Security] Bump jquery from 3.4.1 to 3.5.1 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#157](https://github.com//pull/157) [Security] Bump lodash.defaultsdeep from 4.6.0 to 4.6.1 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#158](https://github.com//pull/158) [Security] Bump lodash.merge from 4.6.1 to 4.6.2 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#159](https://github.com//pull/159) [Security] Bump mixin-deep from 1.3.1 to 1.3.2 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#155](https://github.com//pull/155) Adopt release-it to help with changelog and release management ([@lukemelia](https://github.com/lukemelia)) * [#154](https://github.com//pull/154) Fix an issue in the keyboard service unit test that left key responders registered ([@lukemelia](https://github.com/lukemelia)) * [#153](https://github.com//pull/153) Bump ember-cli-babel from 7.19.0 to 7.20.0 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#152](https://github.com//pull/152) Bump marked from 0.3.19 to 1.1.0 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#148](https://github.com//pull/148) Bump @babel/plugin-proposal-object-rest-spread from 7.3.1 to 7.9.6 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#141](https://github.com//pull/141) Bump markdown-code-highlighting from 0.2.0 to 0.2.1 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#138](https://github.com//pull/138) Bump eslint from 6.8.0 to 7.0.0 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#142](https://github.com//pull/142) Bump qunit-dom from 1.1.0 to 1.2.0 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#128](https://github.com//pull/128) [Security] Bump lodash.merge from 4.6.1 to 4.6.2 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#136](https://github.com//pull/136) [Security] Bump jquery from 3.4.1 to 3.5.1 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#131](https://github.com//pull/131) Bump ember-cli-github-pages from 0.2.0 to 0.2.2 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#130](https://github.com//pull/130) [Security] Bump lodash from 4.17.10 to 4.17.15 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#132](https://github.com//pull/132) [Security] Bump mixin-deep from 1.3.1 to 1.3.2 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#133](https://github.com//pull/133) [Security] Bump tar from 2.2.1 to 2.2.2 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) * [#137](https://github.com//pull/137) Bump ember-test-selectors from 1.0.0 to 4.1.0 ([@dependabot-preview[bot]](https://github.com/apps/dependabot-preview))

Committers: 2

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

Other contributors

Thank you to @optikalefx, @NullVoxPopuli @mattmcmanus, @seanCodes, and @bendemboski for helping to shape the API Design for this release.

6.0.0-beta.0 (Octane-friendly!)

This is the first beta of ember-keyboard 6.0.0!

• [BREAKING] Now requires ember >= 3.8 and node >= 10.x
• [FEATURE] Add on-keyboard and keyboard-shortcut element modifiers and make keyboard-press component public and documented #111 (lukemelia)

The best place for documentation on the new features is https://github.com/adopted-ember-addons/ember-keyboard/blob/master/tests/dummy/app/templates/usage.hbs -- our docs site will be updated when 6.0.0 final is released)

Note: ember-keyboard has been moved to the adopted-ember-addons org. We're grateful to @briarsweetbriar for maintaining the project prior to this transition and for facilitating a smooth transition and ensuring this addon can continue to evolve with Ember.

upgrade ember-cli-babel

upgrades to ember-cli-babel 7.

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.

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();
})

2. 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']
}