Skip to content

feat: add display text to shortcuts #9743

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

Merged
maribethb merged 2 commits into from
Apr 21, 2026
Merged

feat: add display text to shortcuts #9743

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb8aaf5
feat: add display text to shortcuts
maribethb Apr 21, 2026
ac40fd3
fix: remove duplicated message
maribethb Apr 21, 2026
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
29 changes: 29 additions & 0 deletions packages/blockly/core/shortcut_items.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ export function registerEscape() {
return true;
},
keyCodes: [KeyCodes.ESC],
displayText: () => Msg['SHORTCUTS_ESCAPE'],
};
ShortcutRegistry.registry.register(escapeAction);
}
Expand Down Expand Up @@ -119,6 +120,7 @@ export function registerDelete() {
return true;
},
keyCodes: [KeyCodes.DELETE, KeyCodes.BACKSPACE],
displayText: () => Msg['SHORTCUTS_DELETE'],
};
ShortcutRegistry.registry.register(deleteShortcut);
}
Expand Down Expand Up @@ -208,6 +210,7 @@ export function registerCopy() {
return !!clipboard.copy(focused, copyCoords);
},
keyCodes: [ctrlC],
displayText: () => Msg['COPY_SHORTCUT'],
};
ShortcutRegistry.registry.register(copyShortcut);
}
Expand Down Expand Up @@ -252,6 +255,7 @@ export function registerCut() {
return !!copyData;
},
keyCodes: [ctrlX],
displayText: () => Msg['CUT_SHORTCUT'],
};

ShortcutRegistry.registry.register(cutShortcut);
Expand Down Expand Up @@ -334,6 +338,7 @@ export function registerPaste() {
return !!clipboard.paste(copyData, targetWorkspace, centerCoords);
},
keyCodes: [ctrlV],
displayText: () => Msg['PASTE_SHORTCUT'],
};

ShortcutRegistry.registry.register(pasteShortcut);
Expand Down Expand Up @@ -364,6 +369,7 @@ export function registerUndo() {
return true;
},
keyCodes: [ctrlZ],
displayText: () => Msg['UNDO'],
};
ShortcutRegistry.registry.register(undoShortcut);
}
Expand Down Expand Up @@ -400,6 +406,7 @@ export function registerRedo() {
return true;
},
keyCodes: [ctrlShiftZ, ctrlY],
displayText: () => Msg['REDO'],
};
ShortcutRegistry.registry.register(redoShortcut);
}
Expand Down Expand Up @@ -445,13 +452,15 @@ export function registerMovementShortcuts() {
);
},
keyCodes: [KeyCodes.M],
displayText: () => Msg['SHORTCUTS_START_MOVE'],
};
const shortcuts: ShortcutRegistry.KeyboardShortcut[] = [
startMoveShortcut,
{
...startMoveShortcut,
name: names.START_MOVE_STACK,
keyCodes: [shiftM],
displayText: () => Msg['SHORTCUTS_START_MOVE_STACK'],
},
{
name: names.FINISH_MOVE,
Expand All @@ -460,6 +469,7 @@ export function registerMovementShortcuts() {
KeyboardMover.mover.finishMove(e as KeyboardEvent),
keyCodes: [KeyCodes.ENTER, KeyCodes.SPACE],
allowCollision: true,
displayText: () => Msg['SHORTCUTS_FINISH_MOVE'],
},
{
name: names.ABORT_MOVE,
Expand All @@ -468,6 +478,7 @@ export function registerMovementShortcuts() {
KeyboardMover.mover.abortMove(e as KeyboardEvent),
keyCodes: [KeyCodes.ESC],
allowCollision: true,
displayText: () => Msg['SHORTCUTS_ABORT_MOVE'],
},
{
name: names.MOVE_LEFT,
Expand All @@ -483,6 +494,7 @@ export function registerMovementShortcuts() {
]),
],
allowCollision: true,
displayText: () => Msg['SHORTCUTS_MOVE_LEFT'],
},
{
name: names.MOVE_RIGHT,
Expand All @@ -498,6 +510,7 @@ export function registerMovementShortcuts() {
]),
],
allowCollision: true,
displayText: () => Msg['SHORTCUTS_MOVE_RIGHT'],
},
{
name: names.MOVE_UP,
Expand All @@ -513,6 +526,7 @@ export function registerMovementShortcuts() {
]),
],
allowCollision: true,
displayText: () => Msg['SHORTCUTS_MOVE_UP'],
},
{
name: names.MOVE_DOWN,
Expand All @@ -528,6 +542,7 @@ export function registerMovementShortcuts() {
]),
],
allowCollision: true,
displayText: () => Msg['SHORTCUTS_MOVE_DOWN'],
},
];

Expand Down Expand Up @@ -562,6 +577,7 @@ export function registerShowContextMenu() {
return false;
},
keyCodes: [ctrlEnter],
displayText: () => Msg['SHORTCUTS_SHOW_CONTEXT_MENU'],
};
ShortcutRegistry.registry.register(contextMenuShortcut);
}
Expand Down Expand Up @@ -592,6 +608,7 @@ export function registerArrowNavigation() {
},
keyCodes: [KeyCodes.RIGHT],
allowCollision: true,
displayText: () => Msg['SHORTCUTS_NAVIGATE_RIGHT'],
},

/** Go to the next location to the left. */
Expand All @@ -613,6 +630,7 @@ export function registerArrowNavigation() {
},
keyCodes: [KeyCodes.LEFT],
allowCollision: true,
displayText: () => Msg['SHORTCUTS_NAVIGATE_LEFT'],
},

/** Go down to the next location. */
Expand All @@ -635,6 +653,7 @@ export function registerArrowNavigation() {
},
keyCodes: [KeyCodes.DOWN],
allowCollision: true,
displayText: () => Msg['SHORTCUTS_NAVIGATE_DOWN'],
},
/** Go up to the previous location. */
up: {
Expand All @@ -656,6 +675,7 @@ export function registerArrowNavigation() {
},
keyCodes: [KeyCodes.UP],
allowCollision: true,
displayText: () => Msg['SHORTCUTS_NAVIGATE_UP'],
},
};

Expand Down Expand Up @@ -687,6 +707,7 @@ export function registerFocusWorkspace() {
return true;
},
keyCodes: [KeyCodes.W],
displayText: () => Msg['SHORTCUTS_FOCUS_WORKSPACE'],
};
ShortcutRegistry.registry.register(focusWorkspaceShortcut);
}
Expand Down Expand Up @@ -714,6 +735,7 @@ export function registerFocusToolbox() {
}
},
keyCodes: [KeyCodes.T],
displayText: () => Msg['SHORTCUTS_FOCUS_TOOLBOX'],
};
ShortcutRegistry.registry.register(focusToolboxShortcut);
}
Expand Down Expand Up @@ -763,6 +785,7 @@ export function registerWorkspaceOverview() {
return true;
},
keyCodes: [KeyCodes.I],
displayText: () => Msg['SHORTCUTS_INFORMATION'],
};
ShortcutRegistry.registry.register(shortcut);
}
Expand Down Expand Up @@ -790,6 +813,7 @@ export function registerDisconnectBlock() {
return true;
},
keyCodes: [KeyCodes.X, shiftX],
displayText: () => Msg['SHORTCUTS_DISCONNECT'],
};
ShortcutRegistry.registry.register(disconnectShortcut);
}
Expand Down Expand Up @@ -838,6 +862,7 @@ export function registerStackNavigation() {
return true;
},
keyCodes: [KeyCodes.N],
displayText: () => Msg['SHORTCUTS_NEXT_STACK'],
};

const previousStackShortcut: KeyboardShortcut = {
Expand All @@ -863,6 +888,7 @@ export function registerStackNavigation() {
return true;
},
keyCodes: [KeyCodes.B],
displayText: () => Msg['SHORTCUTS_PREVIOUS_STACK'],
};

ShortcutRegistry.registry.register(nextStackShortcut);
Expand Down Expand Up @@ -891,6 +917,7 @@ export function registerPerformAction() {
},
keyCodes: [KeyCodes.ENTER, KeyCodes.SPACE],
allowCollision: true,
displayText: () => Msg['SHORTCUTS_PERFORM_ACTION'],
};
ShortcutRegistry.registry.register(performActionShortcut);
}
Expand Down Expand Up @@ -919,6 +946,7 @@ export function registerDuplicate() {
},
keyCodes: [KeyCodes.D],
allowCollision: true,
displayText: () => Msg['SHORTCUTS_DUPLICATE'],
};
ShortcutRegistry.registry.register(duplicateShortcut);
}
Expand All @@ -938,6 +966,7 @@ export function registerCleanup() {
},
keyCodes: [KeyCodes.C],
allowCollision: true,
displayText: () => Msg['SHORTCUTS_CLEANUP'],
};
ShortcutRegistry.registry.register(cleanupShortcut);
}
Expand Down
7 changes: 7 additions & 0 deletions packages/blockly/core/shortcut_registry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -434,6 +434,13 @@ export namespace ShortcutRegistry {
* name.
*/
allowCollision?: boolean;

/**
* Display text for the shortcut. This is not used in core but may
* be used by plugins or applications to provide a user-facing
* label for the shortcut.
*/
displayText?: string | (() => string);
}

/** Supported modifiers. */
Expand Down
22 changes: 21 additions & 1 deletion packages/blockly/msg/json/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"@metadata": {
"author": "Ellen Spertus <ellen.spertus@gmail.com>",
"lastupdated": "2026-04-20 12:26:14.946401",
"lastupdated": "2026-04-21 12:36:42.927221",
"locale": "en",
"messagedocumentation" : "qqq"
},
Expand Down Expand Up @@ -417,6 +417,26 @@
"SHORTCUTS_GENERAL": "General",
"SHORTCUTS_EDITING": "Editing",
"SHORTCUTS_CODE_NAVIGATION": "Code navigation",
"SHORTCUTS_ESCAPE": "Exit",
"SHORTCUTS_DELETE": "Delete",
"SHORTCUTS_START_MOVE": "Start move",
"SHORTCUTS_START_MOVE_STACK": "Start move stack",
"SHORTCUTS_MOVE_LEFT": "Move left",
"SHORTCUTS_MOVE_RIGHT": "Move right",
"SHORTCUTS_MOVE_UP": "Move up",
"SHORTCUTS_MOVE_DOWN": "Move down",
"SHORTCUTS_FINISH_MOVE": "Finish move",
"SHORTCUTS_ABORT_MOVE": "Abort move",
"SHORTCUTS_SHOW_CONTEXT_MENU": "Show menu",
"SHORTCUTS_FOCUS_WORKSPACE": "Focus workspace",
"SHORTCUTS_FOCUS_TOOLBOX": "Focus toolbox",
"SHORTCUTS_INFORMATION": "Announce information",
"SHORTCUTS_DISCONNECT": "Disconnect block",
"SHORTCUTS_NEXT_STACK": "Next stack",
"SHORTCUTS_PREVIOUS_STACK": "Previous stack",
"SHORTCUTS_PERFORM_ACTION": "Edit or confirm",
"SHORTCUTS_DUPLICATE": "Duplicate",
"SHORTCUTS_CLEANUP": "Clean up workspace",
"KEYBOARD_NAV_UNCONSTRAINED_MOVE_HINT": "Hold %1 and use arrow keys to move freely, then %2 to accept the position",
"KEYBOARD_NAV_CONSTRAINED_MOVE_HINT": "Use the arrow keys to move, then %1 to accept the position",
"KEYBOARD_NAV_COPIED_HINT": "Copied. Press %1 to paste.",
Expand Down
22 changes: 21 additions & 1 deletion packages/blockly/msg/json/qqq.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"@metadata": {
"@metadata": {
"authors": [
"Ajeje Brazorf",
"Amire80",
Expand Down Expand Up @@ -424,6 +424,26 @@
"SHORTCUTS_GENERAL": "shortcut list section header - Label for general purpose keyboard shortcuts.",
"SHORTCUTS_EDITING": "shortcut list section header - Label for keyboard shortcuts related to editing a workspace.",
"SHORTCUTS_CODE_NAVIGATION": "shortcut list section header - Label for keyboard shortcuts related to moving around the workspace.",
"SHORTCUTS_ESCAPE": "shortcut display text for the escape shortcut, which is used in various contexts to exit or cancel an action.",
"SHORTCUTS_DELETE": "shortcut display text for the delete shortcut, which is used in various contexts to delete items.",
"SHORTCUTS_START_MOVE": "shortcut display text for the start move shortcut, which enters the keyboard navigation 'move mode'.",
"SHORTCUTS_START_MOVE_STACK": "shortcut display text for the start move stack shortcut, which enters the keyboard navigation 'move mode' for a stack of blocks.",
"SHORTCUTS_MOVE_LEFT": "shortcut display text for the move left shortcut, which moves a block left during keyboard navigation.",
"SHORTCUTS_MOVE_RIGHT": "shortcut display text for the move right shortcut, which moves a block right during keyboard navigation.",
"SHORTCUTS_MOVE_UP": "shortcut display text for the move up shortcut, which moves a block up during keyboard navigation.",
"SHORTCUTS_MOVE_DOWN": "shortcut display text for the move down shortcut, which moves a block down during keyboard navigation.",
"SHORTCUTS_FINISH_MOVE": "shortcut display text for the finish move shortcut, which exits the keyboard navigation 'move mode'.",
"SHORTCUTS_ABORT_MOVE": "shortcut display text for the abort move shortcut, which cancels the keyboard navigation 'move mode'.",
"SHORTCUTS_SHOW_CONTEXT_MENU": "shortcut display text for the shortcut that opens the context menu.",
"SHORTCUTS_FOCUS_WORKSPACE": "shortcut display text for the focus workspace shortcut, which moves focus to the workspace.",
"SHORTCUTS_FOCUS_TOOLBOX": "shortcut display text for the focus toolbox shortcut, which moves focus to the toolbox or flyout.",
"SHORTCUTS_INFORMATION": "shortcut display text for the information shortcut, which announces information about a focused element.",
"SHORTCUTS_DISCONNECT": "shortcut display text for the disconnect shortcut, which disconnects a block from its neighbor.",
"SHORTCUTS_NEXT_STACK": "shortcut display text for the next stack shortcut, which navigates to the next block stack.",
"SHORTCUTS_PREVIOUS_STACK": "shortcut display text for the previous stack shortcut, which navigates to the previous block stack.",
"SHORTCUTS_PERFORM_ACTION": "shortcut display text for the perform action shortcut, which triggers an action on the focused element.",
"SHORTCUTS_DUPLICATE": "shortcut display text for the duplicate shortcut, which duplicates the focused block or comment.",
"SHORTCUTS_CLEANUP": "shortcut display text for the cleanup shortcut, which organizes blocks on the workspace.",
"KEYBOARD_NAV_UNCONSTRAINED_MOVE_HINT": "Message shown to inform users how to move blocks to arbitrary locations with the keyboard.",
"KEYBOARD_NAV_CONSTRAINED_MOVE_HINT": "Message shown to inform users how to move blocks with the keyboard.",
"KEYBOARD_NAV_COPIED_HINT": "Message shown when an item is copied in keyboard navigation mode.",
Expand Down
60 changes: 60 additions & 0 deletions packages/blockly/msg/messages.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1684,6 +1684,66 @@ Blockly.Msg.SHORTCUTS_EDITING = 'Editing'
/// moving around the workspace.
Blockly.Msg.SHORTCUTS_CODE_NAVIGATION = 'Code navigation';
/** @type {string} */
/// shortcut display text for the escape shortcut, which is used in various contexts to exit or cancel an action.
Blockly.Msg.SHORTCUTS_ESCAPE = 'Exit';
/** @type {string} */
/// shortcut display text for the delete shortcut, which is used in various contexts to delete items.
Blockly.Msg.SHORTCUTS_DELETE = 'Delete';
/** @type {string} */
/// shortcut display text for the start move shortcut, which enters the keyboard navigation "move mode".
Comment thread
maribethb marked this conversation as resolved.
Blockly.Msg.SHORTCUTS_START_MOVE = 'Start move';
/** @type {string} */
/// shortcut display text for the start move stack shortcut, which enters the keyboard navigation "move mode" for a stack of blocks.
Blockly.Msg.SHORTCUTS_START_MOVE_STACK = 'Start move stack';
/** @type {string} */
/// shortcut display text for the move left shortcut, which moves a block left during keyboard navigation.
Blockly.Msg.SHORTCUTS_MOVE_LEFT = 'Move left';
/** @type {string} */
/// shortcut display text for the move right shortcut, which moves a block right during keyboard navigation.
Blockly.Msg.SHORTCUTS_MOVE_RIGHT = 'Move right';
/** @type {string} */
/// shortcut display text for the move up shortcut, which moves a block up during keyboard navigation.
Blockly.Msg.SHORTCUTS_MOVE_UP = 'Move up';
/** @type {string} */
/// shortcut display text for the move down shortcut, which moves a block down during keyboard navigation.
Blockly.Msg.SHORTCUTS_MOVE_DOWN = 'Move down';
/** @type {string} */
/// shortcut display text for the finish move shortcut, which exits the keyboard navigation "move mode".
Blockly.Msg.SHORTCUTS_FINISH_MOVE = 'Finish move';
/** @type {string} */
/// shortcut display text for the abort move shortcut, which cancels the keyboard navigation "move mode".
Blockly.Msg.SHORTCUTS_ABORT_MOVE = 'Abort move';
/** @type {string} */
/// shortcut display text for the shortcut that opens the context menu.
Blockly.Msg.SHORTCUTS_SHOW_CONTEXT_MENU = 'Show menu';
/** @type {string} */
/// shortcut display text for the focus workspace shortcut, which moves focus to the workspace.
Blockly.Msg.SHORTCUTS_FOCUS_WORKSPACE = 'Focus workspace';
/** @type {string} */
/// shortcut display text for the focus toolbox shortcut, which moves focus to the toolbox or flyout.
Blockly.Msg.SHORTCUTS_FOCUS_TOOLBOX = 'Focus toolbox';
/** @type {string} */
/// shortcut display text for the information shortcut, which announces information about a focused element.
Blockly.Msg.SHORTCUTS_INFORMATION = 'Announce information';
/** @type {string} */
/// shortcut display text for the disconnect shortcut, which disconnects a block from its neighbor.
Blockly.Msg.SHORTCUTS_DISCONNECT = 'Disconnect block';
/** @type {string} */
/// shortcut display text for the next stack shortcut, which navigates to the next block stack.
Blockly.Msg.SHORTCUTS_NEXT_STACK = 'Next stack';
/** @type {string} */
/// shortcut display text for the previous stack shortcut, which navigates to the previous block stack.
Blockly.Msg.SHORTCUTS_PREVIOUS_STACK = 'Previous stack';
/** @type {string} */
/// shortcut display text for the perform action shortcut, which triggers an action on the focused element.
Blockly.Msg.SHORTCUTS_PERFORM_ACTION = 'Edit or confirm';
/** @type {string} */
/// shortcut display text for the duplicate shortcut, which duplicates the focused block or comment.
Blockly.Msg.SHORTCUTS_DUPLICATE = 'Duplicate';
/** @type {string} */
/// shortcut display text for the cleanup shortcut, which organizes blocks on the workspace.
Blockly.Msg.SHORTCUTS_CLEANUP = 'Clean up workspace';
/** @type {string} */
/// Message shown to inform users how to move blocks to arbitrary locations
/// with the keyboard.
Blockly.Msg.KEYBOARD_NAV_UNCONSTRAINED_MOVE_HINT = 'Hold %1 and use arrow keys to move freely, then %2 to accept the position';
Expand Down