Skip to content

Fix inline shortcut registration failure when multiple EditorJS instances share a page #3003

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

Open
Copilot wants to merge 8 commits into
base: next
Choose a base branch
from
+142 −26
Open

Fix inline shortcut registration failure when multiple EditorJS instances share a page #3003

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
10b7045
Initial plan
Copilot May 6, 2026
bd5c631
fix: allow multiple editor instances to register inline shortcuts on …
Copilot May 6, 2026
95e9659
test: add multi-instance inline shortcut test, bump version to 2.31.7…
Copilot May 6, 2026
dbef3a5
test: rename multi-instance shortcut test to describe exact behaviour
Copilot May 6, 2026
c5bff13
test: use cy.clock() to exercise shortcuts.ts duplicate-registration fix
Copilot May 6, 2026
3abfa3c
test: simplify multi-instance shortcut test; remove cy.clock() (Firef…
Copilot May 6, 2026
882fa3d
test: dispatch shortcut keydown on paragraph element, not document
Copilot May 6, 2026
be18268
test: dispatch keydown on paragraph element in read-only mode test too
Copilot May 6, 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
2 changes: 1 addition & 1 deletion src/components/modules/toolbar/inline.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ export default class InlineToolbar extends Module<InlineToolbarNodes> {
const shortcut = this.getToolShortcut(tool.name);

if (shortcut !== undefined) {
Shortcuts.remove(this.Editor.UI.nodes.redactor, shortcut);
Shortcuts.remove(document, shortcut);
}

/**
Expand Down
16 changes: 4 additions & 12 deletions src/components/utils/shortcuts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,24 +41,16 @@ class Shortcuts {
/**
* All registered shortcuts
*
* @type {Map<Element, Shortcut[]>}
* @type {Map<HTMLElement | Document, Shortcut[]>}
*/
private registeredShortcuts: Map<Element, Shortcut[]> = new Map();
private registeredShortcuts: Map<HTMLElement | Document, Shortcut[]> = new Map();

/**
* Register shortcut
*
* @param shortcut - shortcut options
*/
public add(shortcut: ShortcutData): void {
const foundShortcut = this.findShortcut(shortcut.on, shortcut.name);

if (foundShortcut) {
throw Error(
`Shortcut ${shortcut.name} is already registered for ${shortcut.on}. Please remove it before add a new handler.`
);
}

const newShortcut = new Shortcut({
name: shortcut.name,
on: shortcut.on,
Expand All @@ -75,7 +67,7 @@ class Shortcuts {
* @param element - Element shortcut is set for
* @param name - shortcut name
*/
public remove(element: Element, name: string): void {
public remove(element: HTMLElement | Document, name: string): void {
const shortcut = this.findShortcut(element, name);

if (!shortcut) {
Expand Down Expand Up @@ -104,7 +96,7 @@ class Shortcuts {
* @param shortcut - shortcut name
* @returns {number} index - shortcut index if exist
*/
private findShortcut(element: Element, shortcut: string): Shortcut | void {
private findShortcut(element: HTMLElement | Document, shortcut: string): Shortcut | void {
const shortcuts = this.registeredShortcuts.get(element) || [];

return shortcuts.find(({ name }) => name === shortcut);
Expand Down