Skip to content

fix(keyborg): Multiple bundles should not override instances #104

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
mathis-m wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(keyborg): Multiple bundles should not override instances #104

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c18d11
fix(keyborg): Multiple Bundles should not override instances
mathis-m Jun 20, 2025
c6e39d6
fix: remove blank line
mathis-m Jun 20, 2025
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
62 changes: 48 additions & 14 deletions src/Keyborg.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import { Disposable } from "./WeakRefInstance";

interface WindowWithKeyborg extends Window {
__keyborg?: {
lastId?: number;
core: KeyborgCore;
refs: { [id: string]: Keyborg };
};
Expand All @@ -21,7 +22,44 @@ interface WindowWithKeyborg extends Window {
const _dismissTimeout = 500; // When a key from dismissKeys is pressed and the focus is not moved
// during _dismissTimeout time, dismiss the keyboard navigation mode.

let _lastId = 0;
/**
* Function to get the next unique ID for a Keyborg instance or Core instance.
*/
function getNextId(
keyborg: NonNullable<WindowWithKeyborg["__keyborg"]>,
): number {
if (keyborg.lastId === undefined) {
keyborg.lastId = 0;
}

return ++keyborg.lastId;
}

/**
* Ensures that the global keyborg instance is initialized in the window.
* If it doesn't exist, it creates a new instance incorporating the KeyborgCore instance provided via the coreFactory.
*/
function ensureGlobalKeyborgInitialized(
win: WindowWithKeyborg,
coreFactory: () => KeyborgCore,
): NonNullable<WindowWithKeyborg["__keyborg"]> {
if (win.__keyborg) {
return win.__keyborg;
}

const core = coreFactory();

// Core factory might already register the global keyborg instance so we only need to set it up if it doesn't exist
if (!win.__keyborg) {
win.__keyborg = {
lastId: 0,
core,
refs: {},
};
}

return win.__keyborg;
}

export interface KeyborgProps {
// Keys to be used to trigger keyboard navigation mode. By default, any key will trigger
Expand All @@ -48,7 +86,8 @@ class KeyborgCore implements Disposable {
private _isNavigatingWithKeyboard_DO_NOT_USE = false;

constructor(win: WindowWithKeyborg, props?: KeyborgProps) {
this.id = "c" + ++_lastId;
const current = ensureGlobalKeyborgInitialized(win, () => this);
this.id = "c_" + getNextId(current);
this._win = win;
const doc = win.document;

Expand Down Expand Up @@ -291,21 +330,16 @@ export class Keyborg {
}

private constructor(win: WindowWithKeyborg, props?: KeyborgProps) {
this._id = "k" + ++_lastId;
this._win = win;

const current = win.__keyborg;
const current = ensureGlobalKeyborgInitialized(
win,
() => new KeyborgCore(win, props),
);

if (current) {
this._core = current.core;
current.refs[this._id] = this;
} else {
this._core = new KeyborgCore(win, props);
win.__keyborg = {
core: this._core,
refs: { [this._id]: this },
};
}
this._core = current.core;
this._id = "k_" + getNextId(current);
current.refs[this._id] = this;
}

private dispose(): void {
Expand Down