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

Jump to bottom

Allow platform aware key shortcuts #7589

Merged
merged 14 commits into from Dec 23, 2019
Merged

Allow platform aware key shortcuts #7589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
0e47b33
Normalize keys taking in a platform aware way.
groutr Dec 4, 2019
a85feb3
Allow shortcuts to be empty and to have win/mac/linux-specific keys.
jasongrout Oct 12, 2019
748ac19
Fix wording of warning messages.
groutr Dec 4, 2019
af97ff0
Reorganize shortcuts documentation for clarity.
groutr Dec 4, 2019
ad40e24
Merge branch 'master' into platformshortcuts
groutr Dec 10, 2019
0125bdf
Use normalizeKeys from lumino/commands.
groutr Dec 10, 2019
f637e72
Upgrade @lumino/commands
groutr Dec 10, 2019
cefdaa4
Update yarn.lock
groutr Dec 11, 2019
689d762
Update @lumino/commands.
groutr Dec 12, 2019
44b4f04
Package integrity updates
groutr Dec 12, 2019
7032827
Merge branch 'master' into platformshortcuts
groutr Dec 12, 2019
7675ea2
Update @lumino/commands (try 3)
groutr Dec 12, 2019
0a50bbf
Merge branch 'master' into platformshortcuts
groutr Dec 16, 2019
fb2a273
Merge remote-tracking branch 'origin/master' into pr/groutr/7589
jasongrout Dec 23, 2019
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
25 changes: 20 additions & 5 deletions packages/coreutils/src/settingregistry.ts
View file
Open in desktop
Expand Up @@ -5,6 +5,8 @@ import Ajv from 'ajv';

import * as json from 'json5';

import { CommandRegistry } from '@lumino/commands';

import {
JSONExt,
JSONObject,
Expand Down Expand Up @@ -913,11 +915,16 @@ export namespace SettingRegistry {

// If a user shortcut collides with another user shortcut warn and filter.
user = user.filter(shortcut => {
const keys = shortcut.keys.join(RECORD_SEPARATOR);
const keys = CommandRegistry.normalizeKeys(shortcut).join(
RECORD_SEPARATOR
);
const { selector } = shortcut;

if (!keys) {
console.warn('Shortcut skipped because `keys` are [""].', shortcut);
console.warn(
'Skipping this shortcut because there are no actionable keys on this platform',
shortcut
);
return false;
}
if (!(keys in memo)) {
Expand All @@ -928,7 +935,10 @@ export namespace SettingRegistry {
return true;
}

console.warn('Shortcut skipped due to collision.', shortcut);
console.warn(
'Skipping this shortcut because it collides with another shortcut.',
shortcut
);
return false;
});

Expand All @@ -937,7 +947,9 @@ export namespace SettingRegistry {
// out too (this includes shortcuts that are disabled by user preferences).
defaults = defaults.filter(shortcut => {
const { disabled } = shortcut;
const keys = shortcut.keys.join(RECORD_SEPARATOR);
const keys = CommandRegistry.normalizeKeys(shortcut).join(
RECORD_SEPARATOR
);

if (disabled || !keys) {
return false;
Expand All @@ -955,7 +967,10 @@ export namespace SettingRegistry {

// Only warn if a default shortcut collides with another default shortcut.
if (memo[keys][selector]) {
console.warn('Shortcut skipped due to collision.', shortcut);
console.warn(
'Skipping this shortcut because it collides with another shortcut.',
shortcut
);
}

return false;
Expand Down
14 changes: 12 additions & 2 deletions packages/shortcuts-extension/schema/shortcuts.json
View file
Open in desktop
Expand Up @@ -8,7 +8,6 @@
"additionalProperties": false,
"properties": {
"shortcuts": {
"title": "Keyboard Shortcuts",
"description": "The list of keyboard shortcuts.",
"items": { "$ref": "#/definitions/shortcut" },
"type": "array",
Expand All @@ -22,7 +21,18 @@
"command": { "type": "string" },
"keys": {
"items": { "type": "string" },
"minItems": 1,
"type": "array"
},
"winKeys": {
"items": { "type": "string" },
"type": "array"
},
"macKeys": {
"items": { "type": "string" },
"type": "array"
},
"linuxKeys": {
"items": { "type": "string" },
"type": "array"
},
"selector": { "type": "string" }
Expand Down
12 changes: 5 additions & 7 deletions packages/shortcuts-extension/src/index.ts
View file
Open in desktop
Expand Up @@ -71,10 +71,8 @@ const shortcuts: JupyterFrontEndPlugin<void> = {
})
.reduce((acc, val) => acc.concat(val), [])
.sort((a, b) => a.command.localeCompare(b.command));
schema.properties!.shortcuts.title =
'List of Commands (followed by shortcuts)';

const disableShortcutInstructions = `Note: To disable a system default shortcut,
schema.properties!.shortcuts.description = `Note: To disable a system default shortcut,
copy it to User Preferences and add the
"disabled" key, for example:
{
Expand All @@ -84,12 +82,12 @@ copy it to User Preferences and add the
],
"selector": "body",
"disabled": true
}`;
schema.properties!.shortcuts.description = `${commands}
}

${disableShortcutInstructions}
List of commands followed by keyboard shortcuts:
${commands}

List of Keyboard Shortcuts`;
List of keyboard shortcuts:`;
}

registry.pluginChanged.connect(async (sender, plugin) => {
Expand Down