Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update deprecated KeyboardEvent properties #14598

Merged
merged 4 commits into from Mar 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions examples/layer-spy.js
Expand Up @@ -40,11 +40,11 @@ const map = new Map({

let radius = 75;
document.addEventListener('keydown', function (evt) {
if (evt.which === 38) {
if (evt.key === 'ArrowUp') {
radius = Math.min(radius + 5, 150);
map.render();
evt.preventDefault();
} else if (evt.which === 40) {
} else if (evt.key === 'ArrowDown') {
radius = Math.max(radius - 5, 25);
map.render();
evt.preventDefault();
Expand Down
4 changes: 2 additions & 2 deletions examples/magnify.js
Expand Up @@ -32,11 +32,11 @@ const map = new Map({

let radius = 75;
document.addEventListener('keydown', function (evt) {
if (evt.which === 38) {
if (evt.key === 'ArrowUp') {
radius = Math.min(radius + 5, 150);
map.render();
evt.preventDefault();
} else if (evt.which === 40) {
} else if (evt.key === 'ArrowDown') {
radius = Math.max(radius - 5, 25);
map.render();
evt.preventDefault();
Expand Down
14 changes: 14 additions & 0 deletions src/ol/events/Key.js
@@ -0,0 +1,14 @@
/**
* @module ol/events/Key
*/

/**
* @enum {string}
* @const
*/
export default {
LEFT: 'ArrowLeft',
UP: 'ArrowUp',
RIGHT: 'ArrowRight',
DOWN: 'ArrowDown',
};
14 changes: 0 additions & 14 deletions src/ol/events/KeyCode.js

This file was deleted.

18 changes: 9 additions & 9 deletions src/ol/interaction/KeyboardPan.js
Expand Up @@ -3,7 +3,7 @@
*/
import EventType from '../events/EventType.js';
import Interaction, {pan} from './Interaction.js';
import KeyCode from '../events/KeyCode.js';
import Key from '../events/Key.js';
import {noModifierKeys, targetNotEditable} from '../events/condition.js';
import {rotate as rotateCoordinate} from '../coordinate.js';

Expand Down Expand Up @@ -88,24 +88,24 @@ class KeyboardPan extends Interaction {
const keyEvent = /** @type {KeyboardEvent} */ (
mapBrowserEvent.originalEvent
);
const keyCode = keyEvent.keyCode;
const key = keyEvent.key;
if (
this.condition_(mapBrowserEvent) &&
(keyCode == KeyCode.DOWN ||
keyCode == KeyCode.LEFT ||
keyCode == KeyCode.RIGHT ||
keyCode == KeyCode.UP)
(key == Key.DOWN ||
key == Key.LEFT ||
key == Key.RIGHT ||
key == Key.UP)
) {
const map = mapBrowserEvent.map;
const view = map.getView();
const mapUnitsDelta = view.getResolution() * this.pixelDelta_;
let deltaX = 0,
deltaY = 0;
if (keyCode == KeyCode.DOWN) {
if (key == Key.DOWN) {
deltaY = -mapUnitsDelta;
} else if (keyCode == KeyCode.LEFT) {
} else if (key == Key.LEFT) {
deltaX = -mapUnitsDelta;
} else if (keyCode == KeyCode.RIGHT) {
} else if (key == Key.RIGHT) {
deltaX = mapUnitsDelta;
} else {
deltaY = mapUnitsDelta;
Expand Down
8 changes: 4 additions & 4 deletions test/browser/spec/ol/interaction/keyboardpan.test.js
Expand Up @@ -31,22 +31,22 @@ describe('ol.interaction.KeyboardPan', function () {
preventDefault: Event.prototype.preventDefault,
});

event.originalEvent.keyCode = 40; // DOWN
event.originalEvent.key = 'ArrowDown';
tschaub marked this conversation as resolved.
Show resolved Hide resolved
map.handleMapBrowserEvent(event);
expect(spy.getCall(0).args[0].center).to.eql([0, -128]);
view.setCenter([0, 0]);

event.originalEvent.keyCode = 38; // UP
event.originalEvent.key = 'ArrowUp';
map.handleMapBrowserEvent(event);
expect(spy.getCall(1).args[0].center).to.eql([0, 128]);
view.setCenter([0, 0]);

event.originalEvent.keyCode = 37; // LEFT
event.originalEvent.key = 'ArrowLeft';
map.handleMapBrowserEvent(event);
expect(spy.getCall(2).args[0].center).to.eql([-128, 0]);
view.setCenter([0, 0]);

event.originalEvent.keyCode = 39; // RIGHT
event.originalEvent.key = 'ArrowRight';
map.handleMapBrowserEvent(event);
expect(spy.getCall(3).args[0].center).to.eql([128, 0]);
view.setCenter([0, 0]);
Expand Down
2 changes: 1 addition & 1 deletion test/browser/spec/ol/interaction/keyboardzoom.test.js
Expand Up @@ -53,7 +53,7 @@ describe('ol.interaction.KeyboardZoom', function () {
preventDefault: Event.prototype.preventDefault,
});

event.originalEvent.charCode = '+';
event.originalEvent.key = '+';
map.handleMapBrowserEvent(event);
expect(spy.called).to.be(false);
});
Expand Down