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.

Sign up for GitHub

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

implement keyboard shortcuts using KeyboardEvent.key api #3572

Merged
merged 1 commit into from
Jun 5, 2017
Merged

implement keyboard shortcuts using KeyboardEvent.key api #3572

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
144 changes: 134 additions & 10 deletions modules/lib/d3.keybinding.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import * as d3 from 'd3';
import _ from 'lodash';


/*
Expand All @@ -14,8 +15,24 @@ export function d3keybinding(namespace) {
var bindings = [];

function matches(binding, event) {
for (var p in binding.event) {
if (event[p] !== binding.event[p])
if (event.key !== undefined) {
if (binding.event.key === undefined) {
return false;
} else if (_.isArray(binding.event.key)) {
if (binding.event.key.map(function(s) { return s.toLowerCase(); }).indexOf(event.key.toLowerCase()) === -1)
return false;
} else {
if (event.key.toLowerCase() !== binding.event.key.toLowerCase())
return false;
}
} else {
// check keycodes if browser doesn't support KeyboardEvent.key
if (event.keyCode !== binding.event.keyCode)
return false;
}
// check modifier keys
for (var p in binding.event.modifiers) {
if (event[p] !== binding.event.modifiers[p])
return false;
}
return true;
Expand Down Expand Up @@ -64,11 +81,14 @@ export function d3keybinding(namespace) {
var code = arr[i];
var binding = {
event: {
keyCode: 0,
shiftKey: false,
ctrlKey: false,
altKey: false,
metaKey: false
key: undefined,
keyCode: 0, // only for browsers that don't support KeyboardEvent.key
modifiers: {
shiftKey: false,
ctrlKey: false,
altKey: false,
metaKey: false
}
},
capture: capture,
callback: callback
Expand All @@ -81,9 +101,12 @@ export function d3keybinding(namespace) {
if (code[j] === '++') code[i] = '+';

if (code[j] in d3keybinding.modifierCodes) {
binding.event[d3keybinding.modifierProperties[d3keybinding.modifierCodes[code[j]]]] = true;
} else if (code[j] in d3keybinding.keyCodes) {
binding.event.keyCode = d3keybinding.keyCodes[code[j]];
binding.event.modifiers[d3keybinding.modifierProperties[d3keybinding.modifierCodes[code[j]]]] = true;
} else {
binding.event.key = d3keybinding.keys[code[j]] || code[j];
if (code[j] in d3keybinding.keyCodes) {
binding.event.keyCode = d3keybinding.keyCodes[code[j]];
}
}
}

Expand Down Expand Up @@ -115,6 +138,107 @@ d3keybinding.modifierProperties = {
91: 'metaKey'
};

d3keybinding.keys = {
// Backspace key, on Mac: ⌫ (Backspace)
'⌫': 'Backspace', backspace: 'Backspace',
// Tab Key, on Mac: ⇥ (Tab), on Windows ⇥⇥
'⇥': 'Tab', '⇆': 'Tab', tab: 'Tab',
// Return key, ↩
'↩': 'Enter', 'return': 'Enter', enter: 'Enter', '⌅': 'Enter',
// Pause/Break key
'pause': 'Pause', 'pause-break': 'Pause',
// Caps Lock key, ⇪
'⇪': 'CapsLock', caps: 'CapsLock', 'caps-lock': 'CapsLock',
// Escape key, on Mac: ⎋, on Windows: Esc
'⎋': ['Escape', 'Esc'], escape: ['Escape', 'Esc'], esc: ['Escape', 'Esc'],
// Space key
space: [' ', 'Spacebar'],
// Page-Up key, or pgup, on Mac: ↖
'↖': 'PageUp', pgup: 'PageUp', 'page-up': 'PageUp',
// Page-Down key, or pgdown, on Mac: ↘
'↘': 'PageDown', pgdown: 'PageDown', 'page-down': 'PageDown',
// END key, on Mac: ⇟
'⇟': 'End', end: 'End',
// HOME key, on Mac: ⇞
'⇞': 'Home', home: 'Home',
// Insert key, or ins
ins: 'Insert', insert: 'Insert',
// Delete key, on Mac: ⌦ (Delete)
'⌦': ['Delete', 'Del'], del: ['Delete', 'Del'], 'delete': ['Delete', 'Del'],
// Left Arrow Key, or ←
'←': ['ArrowLeft', 'Left'], left: ['ArrowLeft', 'Left'], 'arrow-left': ['ArrowLeft', 'Left'],
// Up Arrow Key, or ↑
'↑': ['ArrowUp', 'Up'], up: ['ArrowUp', 'Up'], 'arrow-up': ['ArrowUp', 'Up'],
// Right Arrow Key, or →
'→': ['ArrowRight', 'Right'], right: ['ArrowDown', 'Down'], 'arrow-right': ['ArrowDown', 'Down'],
// Up Arrow Key, or ↓
'↓': ['ArrowDown', 'Down'], down: ['ArrowDown', 'Down'], 'arrow-down': ['ArrowDown', 'Down'],
// odities, stuff for backward compatibility (browsers and code):
// Num-Multiply, or *
'*': ['*', 'Multiply'], star: ['*', 'Multiply'], asterisk: ['*', 'Multiply'], multiply: ['*', 'Multiply'],
// Num-Plus or +
'+': ['+', 'Add'], 'plus': ['+', 'Add'],
// Num-Subtract, or -
'-': ['-', 'Subtract'], subtract: ['-', 'Subtract'], 'dash': ['-', 'Subtract'],
// Semicolon
semicolon: ';',
// = or equals
equals: '=',
// Comma, or ,
comma: ',',
// Period, or ., or full-stop
period: '.', 'full-stop': '.',
// Slash, or /, or forward-slash
slash: '/', 'forward-slash': '/',
// Tick, or `, or back-quote
tick: '`', 'back-quote': '`',
// Open bracket, or [
'open-bracket': '[',
// Back slash, or \
'back-slash': '\\',
// Close backet, or ]
'close-bracket': ']',
// Apostrophe, or Quote, or '
quote: '\'', apostrophe: '\'',
// NUMPAD 0-9
'num-0': '0',
'num-1': '1',
'num-2': '2',
'num-3': '3',
'num-4': '4',
'num-5': '5',
'num-6': '6',
'num-7': '7',
'num-8': '8',
'num-9': '9',
// F1-F25
f1: 'F1',
f2: 'F2',
f3: 'F3',
f4: 'F4',
f5: 'F5',
f6: 'F6',
f7: 'F7',
f8: 'F8',
f9: 'F9',
f10: 'F10',
f11: 'F11',
f12: 'F12',
f13: 'F13',
f14: 'F14',
f15: 'F15',
f16: 'F16',
f17: 'F17',
f18: 'F18',
f19: 'F19',
f20: 'F20',
f21: 'F21',
f22: 'F22',
f23: 'F23',
f24: 'F24',
f25: 'F25'
};

d3keybinding.keyCodes = {
// Backspace key, on Mac: ⌫ (Backspace)
'⌫': 8, backspace: 8,
Expand Down
2 changes: 1 addition & 1 deletion modules/ui/map_in_map.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ export function uiMapInMap(context) {
redraw();

var keybinding = d3keybinding('map-in-map')
.on(key, toggle);
.on([key, '⇧'+key], toggle);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd rather not bind Shift-/ here, because on US keyboards that's ?, which we're saving for #1481


d3.select(document)
.call(keybinding);
Expand Down