keyborg 2.3.1-canary.0 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/WeakRefInstance.ts","../../src/FocusEvent.ts","../../src/Keyborg.ts","../../src/index.ts"],"sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// IE11 compat, checks if WeakRef is supported\nexport const _canUseWeakRef = typeof WeakRef !== \"undefined\";\n\n/**\n * Allows disposable instances to be used\n */\nexport interface Disposable {\n isDisposed?(): boolean;\n}\n\n/**\n * WeakRef wrapper around a HTMLElement that also supports IE11\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakRef}\n * @internal\n */\nexport class WeakRefInstance<T extends Disposable | object> {\n private _weakRef?: WeakRef<T>;\n private _instance?: T;\n\n constructor(instance: T) {\n if (_canUseWeakRef && typeof instance === \"object\") {\n this._weakRef = new WeakRef(instance);\n } else {\n this._instance = instance;\n }\n }\n\n /**\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakRef/deref}\n */\n deref(): T | undefined {\n let instance: T | undefined;\n\n if (this._weakRef) {\n instance = this._weakRef?.deref();\n\n if (!instance) {\n delete this._weakRef;\n }\n } else {\n instance = this._instance;\n if ((instance as Disposable)?.isDisposed?.()) {\n delete this._instance;\n }\n }\n\n return instance;\n }\n}\n","/*!\n * Copyright (c) Microsoft Corporation. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { WeakRefInstance } from \"./WeakRefInstance\";\n\nexport const KEYBORG_FOCUSIN = \"keyborg:focusin\";\n\ninterface KeyborgFocus {\n /**\n * This is the native `focus` function that is retained so that it can be restored when keyborg is disposed\n */\n __keyborgNativeFocus?: (options?: FocusOptions | undefined) => void;\n}\n\ninterface KeyborgFocusEventData {\n focusInHandler: (e: FocusEvent) => void;\n lastFocusedProgrammatically?: WeakRefInstance<HTMLElement>;\n}\n\n/**\n * Extends the global window with keyborg focus event data\n */\ninterface WindowWithKeyborgFocusEvent extends Window {\n HTMLElement: typeof HTMLElement;\n __keyborgData?: KeyborgFocusEventData;\n}\n\nfunction canOverrideNativeFocus(win: Window): boolean {\n const HTMLElement = (win as WindowWithKeyborgFocusEvent).HTMLElement;\n const origFocus = HTMLElement.prototype.focus;\n\n let isCustomFocusCalled = false;\n\n HTMLElement.prototype.focus = function focus(): void {\n isCustomFocusCalled = true;\n };\n\n const btn = win.document.createElement(\"button\");\n\n btn.focus();\n\n HTMLElement.prototype.focus = origFocus;\n\n return isCustomFocusCalled;\n}\n\nlet _canOverrideNativeFocus = false;\n\nexport interface KeyborgFocusInEventDetails {\n relatedTarget?: HTMLElement;\n isFocusedProgrammatically?: boolean;\n}\n\nexport interface KeyborgFocusInEvent\n extends CustomEvent<KeyborgFocusInEventDetails> {\n /**\n * @deprecated - used `event.detail`\n */\n details?: KeyborgFocusInEventDetails;\n}\n\n/**\n * Guarantees that the native `focus` will be used\n */\nexport function nativeFocus(element: HTMLElement): void {\n const focus = element.focus as KeyborgFocus;\n\n if (focus.__keyborgNativeFocus) {\n focus.__keyborgNativeFocus.call(element);\n } else {\n element.focus();\n }\n}\n\n/**\n * Overrides the native `focus` and setups the keyborg focus event\n */\nexport function setupFocusEvent(win: Window): void {\n const kwin = win as WindowWithKeyborgFocusEvent;\n\n if (!_canOverrideNativeFocus) {\n _canOverrideNativeFocus = canOverrideNativeFocus(kwin);\n }\n\n const origFocus = kwin.HTMLElement.prototype.focus;\n\n if ((origFocus as KeyborgFocus).__keyborgNativeFocus) {\n // Already set up.\n return;\n }\n\n kwin.HTMLElement.prototype.focus = focus;\n\n const focusOutShadowRootHandler = (e: FocusEvent) => {\n const relatedTarget = e.relatedTarget as HTMLElement | null;\n const currentTarget = e.currentTarget as ShadowRoot;\n\n // cleanup polyfill event handlers once focus leaves the shadow root\n if (!currentTarget.contains(relatedTarget)) {\n currentTarget.removeEventListener(\"focusin\", focusInHandler, true);\n currentTarget.removeEventListener(\n \"focusout\",\n focusOutShadowRootHandler,\n true,\n );\n }\n };\n\n const focusInHandler = (e: FocusEvent) => {\n const target = e.target as HTMLElement;\n\n if (!target) {\n return;\n }\n\n if (target.shadowRoot) {\n /**\n * https://bugs.chromium.org/p/chromium/issues/detail?id=1512028\n * focusin events don't bubble up through an open shadow root once focus is inside\n * once focus moves into a shadow root - we drop the same focusin handler there\n * keyborg's custom event will still bubble up since it is composed\n * event handlers should be cleaned up once focus leaves the shadow root.\n * \n * When a focusin event is dispatched from a shadow root, its target is the shadow root parent.\n * Each shadow root encounter requires a new capture listener.\n * Why capture? - we want to follow the focus event in order or descending nested shadow roots\n * When there are no more shadow root targets - dispatch the keyborg:focusin event\n * \n * 1. no focus event\n * > document - capture listener ✅\n * > shadow root 1\n * > shadow root 2\n * > shadow root 3\n * > focused element\n * \n * 2. focus event received by document listener\n * > document - capture listener ✅ (focus event here)\n * > shadow root 1 - capture listener ✅\n * > shadow root 2\n * > shadow root 3\n * > focused element\n\n * 3. focus event received by root l1 listener\n * > document - capture listener ✅\n * > shadow root 1 - capture listener ✅ (focus event here)\n * > shadow root 2 - capture listener ✅\n * > shadow root 3\n * > focused element\n *\n * 4. focus event received by root l2 listener\n * > document - capture listener ✅\n * > shadow root 1 - capture listener ✅\n * > shadow root 2 - capture listener ✅ (focus event here)\n * > shadow root 3 - capture listener ✅ \n * > focused element\n * \n * 5. focus event received by root l3 listener, no more shadow root targets\n * > document - capture listener ✅\n * > shadow root 1 - capture listener ✅\n * > shadow root 2 - capture listener ✅\n * > shadow root 3 - capture listener ✅ (focus event here)\n * > focused element ✅ (no shadow root - dispatch keyborg event)\n */\n target.shadowRoot.addEventListener(\"focusin\", focusInHandler, true);\n target.shadowRoot.addEventListener(\n \"focusout\",\n focusOutShadowRootHandler,\n true,\n );\n\n return;\n }\n\n const details: KeyborgFocusInEventDetails = {\n relatedTarget: (e.relatedTarget as HTMLElement) || undefined,\n };\n\n const event: KeyborgFocusInEvent = new CustomEvent(KEYBORG_FOCUSIN, {\n cancelable: true,\n bubbles: true,\n // Allows the event to bubble past an open shadow root\n composed: true,\n detail: details,\n });\n\n // Tabster (and other users) can still use the legacy details field - keeping for backwards compat\n event.details = details;\n\n if (_canOverrideNativeFocus || data.lastFocusedProgrammatically) {\n details.isFocusedProgrammatically =\n target === data.lastFocusedProgrammatically?.deref();\n\n data.lastFocusedProgrammatically = undefined;\n }\n\n target.dispatchEvent(event);\n };\n\n const data: KeyborgFocusEventData = (kwin.__keyborgData = {\n focusInHandler,\n });\n\n kwin.document.addEventListener(\n \"focusin\",\n kwin.__keyborgData.focusInHandler,\n true,\n );\n\n function focus(this: HTMLElement) {\n const keyborgNativeFocusEvent = (kwin as WindowWithKeyborgFocusEvent)\n .__keyborgData;\n\n if (keyborgNativeFocusEvent) {\n keyborgNativeFocusEvent.lastFocusedProgrammatically = new WeakRefInstance(\n this,\n );\n }\n\n // eslint-disable-next-line prefer-rest-params\n return origFocus.apply(this, arguments);\n }\n\n (focus as KeyborgFocus).__keyborgNativeFocus = origFocus;\n}\n\n/**\n * Removes keyborg event listeners and custom focus override\n * @param win The window that stores keyborg focus events\n */\nexport function disposeFocusEvent(win: Window): void {\n const kwin = win as WindowWithKeyborgFocusEvent;\n const proto = kwin.HTMLElement.prototype;\n const origFocus = (proto.focus as KeyborgFocus).__keyborgNativeFocus;\n const keyborgNativeFocusEvent = kwin.__keyborgData;\n\n if (keyborgNativeFocusEvent) {\n kwin.document.removeEventListener(\n \"focusin\",\n keyborgNativeFocusEvent.focusInHandler,\n true,\n );\n delete kwin.__keyborgData;\n }\n\n if (origFocus) {\n proto.focus = origFocus;\n }\n}\n\n/**\n * @param win The window that stores keyborg focus events\n * @returns The last element focused with element.focus()\n */\nexport function getLastFocusedProgrammatically(\n win: Window,\n): HTMLElement | null | undefined {\n const keyborgNativeFocusEvent = (win as WindowWithKeyborgFocusEvent)\n .__keyborgData;\n\n return keyborgNativeFocusEvent\n ? keyborgNativeFocusEvent.lastFocusedProgrammatically?.deref() || null\n : undefined;\n}\n","/*!\n * Copyright (c) Microsoft Corporation. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n disposeFocusEvent,\n KeyborgFocusInEvent,\n KEYBORG_FOCUSIN,\n setupFocusEvent,\n} from \"./FocusEvent\";\nimport { Disposable, WeakRefInstance } from \"./WeakRefInstance\";\n\ninterface WindowWithKeyborg extends Window {\n __keyborg?: {\n core: KeyborgCore;\n refs: { [id: string]: Keyborg };\n };\n}\n\nconst _dismissTimeout = 500; // When a key from dismissKeys is pressed and the focus is not moved\n// during _dismissTimeout time, dismiss the keyboard navigation mode.\n\nlet _lastId = 0;\n\nexport interface KeyborgProps {\n // Keys to be used to trigger keyboard navigation mode. By default, any key will trigger\n // it. Could be limited to, for example, just Tab (or Tab and arrow keys).\n triggerKeys?: number[];\n // Keys to be used to dismiss keyboard navigation mode using keyboard (in addition to\n // mouse clicks which dismiss it). For example, Esc could be used to dismiss.\n dismissKeys?: number[];\n}\n\nexport type KeyborgCallback = (isNavigatingWithKeyboard: boolean) => void;\n\n/**\n * Source of truth for all the keyborg core instances and the current keyboard navigation state\n */\nexport class KeyborgState {\n private __keyborgCoreRefs: { [id: string]: WeakRefInstance<KeyborgCore> } =\n {};\n private _isNavigatingWithKeyboard = false;\n\n add(keyborg: KeyborgCore): void {\n const id = keyborg.id;\n\n if (!(id in this.__keyborgCoreRefs)) {\n this.__keyborgCoreRefs[id] = new WeakRefInstance<KeyborgCore>(keyborg);\n }\n }\n\n remove(id: string): void {\n delete this.__keyborgCoreRefs[id];\n\n if (Object.keys(this.__keyborgCoreRefs).length === 0) {\n this._isNavigatingWithKeyboard = false;\n }\n }\n\n setVal(isNavigatingWithKeyboard: boolean): void {\n if (this._isNavigatingWithKeyboard === isNavigatingWithKeyboard) {\n return;\n }\n\n this._isNavigatingWithKeyboard = isNavigatingWithKeyboard;\n\n for (const id of Object.keys(this.__keyborgCoreRefs)) {\n const ref = this.__keyborgCoreRefs[id];\n const keyborg = ref.deref();\n\n if (keyborg) {\n keyborg.update(isNavigatingWithKeyboard);\n } else {\n this.remove(id);\n }\n }\n }\n\n getVal(): boolean {\n return this._isNavigatingWithKeyboard;\n }\n}\n\nconst _state = new KeyborgState();\n\n/**\n * Manages a collection of Keyborg instances in a window/document and updates keyborg state\n */\nclass KeyborgCore implements Disposable {\n readonly id: string;\n\n private _win?: WindowWithKeyborg;\n private _isMouseUsedTimer: number | undefined;\n private _dismissTimer: number | undefined;\n private _triggerKeys?: Set<number>;\n private _dismissKeys?: Set<number>;\n\n constructor(win: WindowWithKeyborg, props?: KeyborgProps) {\n this.id = \"c\" + ++_lastId;\n this._win = win;\n const doc = win.document;\n\n if (props) {\n const triggerKeys = props.triggerKeys;\n const dismissKeys = props.dismissKeys;\n\n if (triggerKeys?.length) {\n this._triggerKeys = new Set(triggerKeys);\n }\n\n if (dismissKeys?.length) {\n this._dismissKeys = new Set(dismissKeys);\n }\n }\n\n doc.addEventListener(KEYBORG_FOCUSIN, this._onFocusIn, true); // Capture!\n doc.addEventListener(\"mousedown\", this._onMouseDown, true); // Capture!\n win.addEventListener(\"keydown\", this._onKeyDown, true); // Capture!\n\n setupFocusEvent(win);\n\n _state.add(this);\n }\n\n dispose(): void {\n const win = this._win;\n\n if (win) {\n if (this._isMouseUsedTimer) {\n win.clearTimeout(this._isMouseUsedTimer);\n this._isMouseUsedTimer = undefined;\n }\n\n if (this._dismissTimer) {\n win.clearTimeout(this._dismissTimer);\n this._dismissTimer = undefined;\n }\n\n disposeFocusEvent(win);\n\n const doc = win.document;\n\n doc.removeEventListener(KEYBORG_FOCUSIN, this._onFocusIn, true); // Capture!\n doc.removeEventListener(\"mousedown\", this._onMouseDown, true); // Capture!\n win.removeEventListener(\"keydown\", this._onKeyDown, true); // Capture!\n\n delete this._win;\n\n _state.remove(this.id);\n }\n }\n\n isDisposed(): boolean {\n return !!this._win;\n }\n\n /**\n * Updates all keyborg instances with the keyboard navigation state\n */\n update(isNavigatingWithKeyboard: boolean): void {\n const keyborgs = this._win?.__keyborg?.refs;\n\n if (keyborgs) {\n for (const id of Object.keys(keyborgs)) {\n Keyborg.update(keyborgs[id], isNavigatingWithKeyboard);\n }\n }\n }\n\n private _onFocusIn = (e: KeyborgFocusInEvent) => {\n // When the focus is moved not programmatically and without keydown events,\n // it is likely that the focus is moved by screen reader (as it might swallow\n // the events when the screen reader shortcuts are used). The screen reader\n // usage is keyboard navigation.\n\n if (this._isMouseUsedTimer) {\n // There was a mouse event recently.\n return;\n }\n\n if (_state.getVal()) {\n return;\n }\n\n const details = e.detail;\n\n if (!details.relatedTarget) {\n return;\n }\n\n if (\n details.isFocusedProgrammatically ||\n details.isFocusedProgrammatically === undefined\n ) {\n // The element is focused programmatically, or the programmatic focus detection\n // is not working.\n return;\n }\n\n _state.setVal(true);\n };\n\n private _onMouseDown = (e: MouseEvent): void => {\n if (\n e.buttons === 0 ||\n (e.clientX === 0 && e.clientY === 0 && e.screenX === 0 && e.screenY === 0)\n ) {\n // This is most likely an event triggered by the screen reader to perform\n // an action on an element, do not dismiss the keyboard navigation mode.\n return;\n }\n\n const win = this._win;\n\n if (win) {\n if (this._isMouseUsedTimer) {\n win.clearTimeout(this._isMouseUsedTimer);\n }\n\n this._isMouseUsedTimer = win.setTimeout(() => {\n delete this._isMouseUsedTimer;\n }, 1000); // Keeping the indication of the mouse usage for some time.\n }\n\n _state.setVal(false);\n };\n\n private _onKeyDown = (e: KeyboardEvent): void => {\n const isNavigatingWithKeyboard = _state.getVal();\n\n const keyCode = e.keyCode;\n const triggerKeys = this._triggerKeys;\n\n if (\n !isNavigatingWithKeyboard &&\n (!triggerKeys || triggerKeys.has(keyCode))\n ) {\n const activeElement = this._win?.document.activeElement as\n | HTMLElement\n | null\n | undefined;\n\n if (\n activeElement &&\n (activeElement.tagName === \"INPUT\" ||\n activeElement.tagName === \"TEXTAREA\" ||\n activeElement.contentEditable === \"true\")\n ) {\n // We're inside an input, textarea or contenteditable, it's not\n // keyboard navigation, it is text editing scenario.\n return;\n }\n\n _state.setVal(true);\n } else if (isNavigatingWithKeyboard && this._dismissKeys?.has(keyCode)) {\n this._scheduleDismiss();\n }\n };\n\n private _scheduleDismiss(): void {\n const win = this._win;\n\n if (win) {\n if (this._dismissTimer) {\n win.clearTimeout(this._dismissTimer);\n this._dismissTimer = undefined;\n }\n\n const was = win.document.activeElement;\n\n this._dismissTimer = win.setTimeout(() => {\n this._dismissTimer = undefined;\n\n const cur = win.document.activeElement;\n\n if (was && cur && was === cur) {\n // Esc was pressed, currently focused element hasn't changed.\n // Just dismiss the keyboard navigation mode.\n _state.setVal(false);\n }\n }, _dismissTimeout);\n }\n }\n}\n\n/**\n * Used to determine the keyboard navigation state\n */\nexport class Keyborg {\n private _id: string;\n private _win?: WindowWithKeyborg;\n private _core?: KeyborgCore;\n private _cb: KeyborgCallback[] = [];\n\n static create(win: WindowWithKeyborg, props?: KeyborgProps): Keyborg {\n return new Keyborg(win, props);\n }\n\n static dispose(instance: Keyborg): void {\n instance.dispose();\n }\n\n /**\n * Updates all subscribed callbacks with the keyboard navigation state\n */\n static update(instance: Keyborg, isNavigatingWithKeyboard: boolean): void {\n instance._cb.forEach((callback) => callback(isNavigatingWithKeyboard));\n }\n\n private constructor(win: WindowWithKeyborg, props?: KeyborgProps) {\n this._id = \"k\" + ++_lastId;\n this._win = win;\n\n const current = win.__keyborg;\n\n if (current) {\n this._core = current.core;\n current.refs[this._id] = this;\n } else {\n this._core = new KeyborgCore(win, props);\n win.__keyborg = {\n core: this._core,\n refs: { [this._id]: this },\n };\n }\n }\n\n private dispose(): void {\n const current = this._win?.__keyborg;\n\n if (current?.refs[this._id]) {\n delete current.refs[this._id];\n\n if (Object.keys(current.refs).length === 0) {\n current.core.dispose();\n // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n delete this._win!.__keyborg;\n }\n } else if (process.env.NODE_ENV !== \"production\") {\n console.error(\n `Keyborg instance ${this._id} is being disposed incorrectly.`,\n );\n }\n\n this._cb = [];\n delete this._core;\n delete this._win;\n }\n\n /**\n * @returns Whether the user is navigating with keyboard\n */\n isNavigatingWithKeyboard(): boolean {\n return _state.getVal();\n }\n\n /**\n * @param callback - Called when the keyboard navigation state changes\n */\n subscribe(callback: KeyborgCallback): void {\n this._cb.push(callback);\n }\n\n /**\n * @param callback - Registered with subscribe\n */\n unsubscribe(callback: KeyborgCallback): void {\n const index = this._cb.indexOf(callback);\n\n if (index >= 0) {\n this._cb.splice(index, 1);\n }\n }\n\n /**\n * Manually set the keyboard navigtion state\n */\n setVal(isNavigatingWithKeyboard: boolean): void {\n _state.setVal(isNavigatingWithKeyboard);\n }\n}\n\nexport function createKeyborg(win: Window, props?: KeyborgProps): Keyborg {\n return Keyborg.create(win, props);\n}\n\nexport function disposeKeyborg(instance: Keyborg) {\n Keyborg.dispose(instance);\n}\n","/*!\n * Copyright (c) Microsoft Corporation. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport type { Keyborg, KeyborgCallback } from \"./Keyborg\";\nexport { createKeyborg, disposeKeyborg } from \"./Keyborg\";\n\nexport type {\n KeyborgFocusInEvent,\n KeyborgFocusInEventDetails,\n} from \"./FocusEvent\";\nexport {\n getLastFocusedProgrammatically,\n nativeFocus,\n KEYBORG_FOCUSIN,\n} from \"./FocusEvent\";\n\nexport const version = process.env.PKG_VERSION;\n"],"mappings":";AAMO,IAAM,iBAAiB,OAAO,YAAY;AAc1C,IAAM,kBAAN,MAAqD;AAAA,EAI1D,YAAY,UAAa;AACvB,QAAI,kBAAkB,OAAO,aAAa,UAAU;AAClD,WAAK,WAAW,IAAI,QAAQ,QAAQ;AAAA,IACtC,OAAO;AACL,WAAK,YAAY;AAAA,IACnB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,QAAuB;AAnCzB;AAoCI,QAAI;AAEJ,QAAI,KAAK,UAAU;AACjB,kBAAW,UAAK,aAAL,mBAAe;AAE1B,UAAI,CAAC,UAAU;AACb,eAAO,KAAK;AAAA,MACd;AAAA,IACF,OAAO;AACL,iBAAW,KAAK;AAChB,WAAK,0CAAyB,eAAzB,mCAAyC;AAC5C,eAAO,KAAK;AAAA,MACd;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AACF;;;AC/CO,IAAM,kBAAkB;AAsB/B,SAAS,uBAAuB,KAAsB;AACpD,QAAM,cAAe,IAAoC;AACzD,QAAM,YAAY,YAAY,UAAU;AAExC,MAAI,sBAAsB;AAE1B,cAAY,UAAU,QAAQ,SAAS,QAAc;AACnD,0BAAsB;AAAA,EACxB;AAEA,QAAM,MAAM,IAAI,SAAS,cAAc,QAAQ;AAE/C,MAAI,MAAM;AAEV,cAAY,UAAU,QAAQ;AAE9B,SAAO;AACT;AAEA,IAAI,0BAA0B;AAkBvB,SAAS,YAAY,SAA4B;AACtD,QAAM,QAAQ,QAAQ;AAEtB,MAAI,MAAM,sBAAsB;AAC9B,UAAM,qBAAqB,KAAK,OAAO;AAAA,EACzC,OAAO;AACL,YAAQ,MAAM;AAAA,EAChB;AACF;AAKO,SAAS,gBAAgB,KAAmB;AACjD,QAAM,OAAO;AAEb,MAAI,CAAC,yBAAyB;AAC5B,8BAA0B,uBAAuB,IAAI;AAAA,EACvD;AAEA,QAAM,YAAY,KAAK,YAAY,UAAU;AAE7C,MAAK,UAA2B,sBAAsB;AAEpD;AAAA,EACF;AAEA,OAAK,YAAY,UAAU,QAAQ;AAEnC,QAAM,4BAA4B,CAAC,MAAkB;AACnD,UAAM,gBAAgB,EAAE;AACxB,UAAM,gBAAgB,EAAE;AAGxB,QAAI,CAAC,cAAc,SAAS,aAAa,GAAG;AAC1C,oBAAc,oBAAoB,WAAW,gBAAgB,IAAI;AACjE,oBAAc;AAAA,QACZ;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,QAAM,iBAAiB,CAAC,MAAkB;AA7G5C;AA8GI,UAAM,SAAS,EAAE;AAEjB,QAAI,CAAC,QAAQ;AACX;AAAA,IACF;AAEA,QAAI,OAAO,YAAY;AAgDrB,aAAO,WAAW,iBAAiB,WAAW,gBAAgB,IAAI;AAClE,aAAO,WAAW;AAAA,QAChB;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAEA;AAAA,IACF;AAEA,UAAM,UAAsC;AAAA,MAC1C,eAAgB,EAAE,iBAAiC;AAAA,IACrD;AAEA,UAAM,QAA6B,IAAI,YAAY,iBAAiB;AAAA,MAClE,YAAY;AAAA,MACZ,SAAS;AAAA;AAAA,MAET,UAAU;AAAA,MACV,QAAQ;AAAA,IACV,CAAC;AAGD,UAAM,UAAU;AAEhB,QAAI,2BAA2B,KAAK,6BAA6B;AAC/D,cAAQ,4BACN,aAAW,UAAK,gCAAL,mBAAkC;AAE/C,WAAK,8BAA8B;AAAA,IACrC;AAEA,WAAO,cAAc,KAAK;AAAA,EAC5B;AAEA,QAAM,OAA+B,KAAK,gBAAgB;AAAA,IACxD;AAAA,EACF;AAEA,OAAK,SAAS;AAAA,IACZ;AAAA,IACA,KAAK,cAAc;AAAA,IACnB;AAAA,EACF;AAEA,WAAS,QAAyB;AAChC,UAAM,0BAA2B,KAC9B;AAEH,QAAI,yBAAyB;AAC3B,8BAAwB,8BAA8B,IAAI;AAAA,QACxD;AAAA,MACF;AAAA,IACF;AAGA,WAAO,UAAU,MAAM,MAAM,SAAS;AAAA,EACxC;AAEA,EAAC,MAAuB,uBAAuB;AACjD;AAMO,SAAS,kBAAkB,KAAmB;AACnD,QAAM,OAAO;AACb,QAAM,QAAQ,KAAK,YAAY;AAC/B,QAAM,YAAa,MAAM,MAAuB;AAChD,QAAM,0BAA0B,KAAK;AAErC,MAAI,yBAAyB;AAC3B,SAAK,SAAS;AAAA,MACZ;AAAA,MACA,wBAAwB;AAAA,MACxB;AAAA,IACF;AACA,WAAO,KAAK;AAAA,EACd;AAEA,MAAI,WAAW;AACb,UAAM,QAAQ;AAAA,EAChB;AACF;AAMO,SAAS,+BACd,KACgC;AAhQlC;AAiQE,QAAM,0BAA2B,IAC9B;AAEH,SAAO,4BACH,6BAAwB,gCAAxB,mBAAqD,YAAW,OAChE;AACN;;;ACnPA,IAAM,kBAAkB;AAGxB,IAAI,UAAU;AAgBP,IAAM,eAAN,MAAmB;AAAA,EAAnB;AACL,SAAQ,oBACN,CAAC;AACH,SAAQ,4BAA4B;AAAA;AAAA,EAEpC,IAAI,SAA4B;AAC9B,UAAM,KAAK,QAAQ;AAEnB,QAAI,EAAE,MAAM,KAAK,oBAAoB;AACnC,WAAK,kBAAkB,EAAE,IAAI,IAAI,gBAA6B,OAAO;AAAA,IACvE;AAAA,EACF;AAAA,EAEA,OAAO,IAAkB;AACvB,WAAO,KAAK,kBAAkB,EAAE;AAEhC,QAAI,OAAO,KAAK,KAAK,iBAAiB,EAAE,WAAW,GAAG;AACpD,WAAK,4BAA4B;AAAA,IACnC;AAAA,EACF;AAAA,EAEA,OAAO,0BAAyC;AAC9C,QAAI,KAAK,8BAA8B,0BAA0B;AAC/D;AAAA,IACF;AAEA,SAAK,4BAA4B;AAEjC,eAAW,MAAM,OAAO,KAAK,KAAK,iBAAiB,GAAG;AACpD,YAAM,MAAM,KAAK,kBAAkB,EAAE;AACrC,YAAM,UAAU,IAAI,MAAM;AAE1B,UAAI,SAAS;AACX,gBAAQ,OAAO,wBAAwB;AAAA,MACzC,OAAO;AACL,aAAK,OAAO,EAAE;AAAA,MAChB;AAAA,IACF;AAAA,EACF;AAAA,EAEA,SAAkB;AAChB,WAAO,KAAK;AAAA,EACd;AACF;AAEA,IAAM,SAAS,IAAI,aAAa;AAKhC,IAAM,cAAN,MAAwC;AAAA,EAStC,YAAY,KAAwB,OAAsB;AAwE1D,SAAQ,aAAa,CAAC,MAA2B;AAM/C,UAAI,KAAK,mBAAmB;AAE1B;AAAA,MACF;AAEA,UAAI,OAAO,OAAO,GAAG;AACnB;AAAA,MACF;AAEA,YAAM,UAAU,EAAE;AAElB,UAAI,CAAC,QAAQ,eAAe;AAC1B;AAAA,MACF;AAEA,UACE,QAAQ,6BACR,QAAQ,8BAA8B,QACtC;AAGA;AAAA,MACF;AAEA,aAAO,OAAO,IAAI;AAAA,IACpB;AAEA,SAAQ,eAAe,CAAC,MAAwB;AAC9C,UACE,EAAE,YAAY,KACb,EAAE,YAAY,KAAK,EAAE,YAAY,KAAK,EAAE,YAAY,KAAK,EAAE,YAAY,GACxE;AAGA;AAAA,MACF;AAEA,YAAM,MAAM,KAAK;AAEjB,UAAI,KAAK;AACP,YAAI,KAAK,mBAAmB;AAC1B,cAAI,aAAa,KAAK,iBAAiB;AAAA,QACzC;AAEA,aAAK,oBAAoB,IAAI,WAAW,MAAM;AAC5C,iBAAO,KAAK;AAAA,QACd,GAAG,GAAI;AAAA,MACT;AAEA,aAAO,OAAO,KAAK;AAAA,IACrB;AAEA,SAAQ,aAAa,CAAC,MAA2B;AApOnD;AAqOI,YAAM,2BAA2B,OAAO,OAAO;AAE/C,YAAM,UAAU,EAAE;AAClB,YAAM,cAAc,KAAK;AAEzB,UACE,CAAC,6BACA,CAAC,eAAe,YAAY,IAAI,OAAO,IACxC;AACA,cAAM,iBAAgB,UAAK,SAAL,mBAAW,SAAS;AAK1C,YACE,kBACC,cAAc,YAAY,WACzB,cAAc,YAAY,cAC1B,cAAc,oBAAoB,SACpC;AAGA;AAAA,QACF;AAEA,eAAO,OAAO,IAAI;AAAA,MACpB,WAAW,8BAA4B,UAAK,iBAAL,mBAAmB,IAAI,WAAU;AACtE,aAAK,iBAAiB;AAAA,MACxB;AAAA,IACF;AA/JE,SAAK,KAAK,MAAM,EAAE;AAClB,SAAK,OAAO;AACZ,UAAM,MAAM,IAAI;AAEhB,QAAI,OAAO;AACT,YAAM,cAAc,MAAM;AAC1B,YAAM,cAAc,MAAM;AAE1B,UAAI,2CAAa,QAAQ;AACvB,aAAK,eAAe,IAAI,IAAI,WAAW;AAAA,MACzC;AAEA,UAAI,2CAAa,QAAQ;AACvB,aAAK,eAAe,IAAI,IAAI,WAAW;AAAA,MACzC;AAAA,IACF;AAEA,QAAI,iBAAiB,iBAAiB,KAAK,YAAY,IAAI;AAC3D,QAAI,iBAAiB,aAAa,KAAK,cAAc,IAAI;AACzD,QAAI,iBAAiB,WAAW,KAAK,YAAY,IAAI;AAErD,oBAAgB,GAAG;AAEnB,WAAO,IAAI,IAAI;AAAA,EACjB;AAAA,EAEA,UAAgB;AACd,UAAM,MAAM,KAAK;AAEjB,QAAI,KAAK;AACP,UAAI,KAAK,mBAAmB;AAC1B,YAAI,aAAa,KAAK,iBAAiB;AACvC,aAAK,oBAAoB;AAAA,MAC3B;AAEA,UAAI,KAAK,eAAe;AACtB,YAAI,aAAa,KAAK,aAAa;AACnC,aAAK,gBAAgB;AAAA,MACvB;AAEA,wBAAkB,GAAG;AAErB,YAAM,MAAM,IAAI;AAEhB,UAAI,oBAAoB,iBAAiB,KAAK,YAAY,IAAI;AAC9D,UAAI,oBAAoB,aAAa,KAAK,cAAc,IAAI;AAC5D,UAAI,oBAAoB,WAAW,KAAK,YAAY,IAAI;AAExD,aAAO,KAAK;AAEZ,aAAO,OAAO,KAAK,EAAE;AAAA,IACvB;AAAA,EACF;AAAA,EAEA,aAAsB;AACpB,WAAO,CAAC,CAAC,KAAK;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA,EAKA,OAAO,0BAAyC;AAhKlD;AAiKI,UAAM,YAAW,gBAAK,SAAL,mBAAW,cAAX,mBAAsB;AAEvC,QAAI,UAAU;AACZ,iBAAW,MAAM,OAAO,KAAK,QAAQ,GAAG;AACtC,gBAAQ,OAAO,SAAS,EAAE,GAAG,wBAAwB;AAAA,MACvD;AAAA,IACF;AAAA,EACF;AAAA,EA4FQ,mBAAyB;AAC/B,UAAM,MAAM,KAAK;AAEjB,QAAI,KAAK;AACP,UAAI,KAAK,eAAe;AACtB,YAAI,aAAa,KAAK,aAAa;AACnC,aAAK,gBAAgB;AAAA,MACvB;AAEA,YAAM,MAAM,IAAI,SAAS;AAEzB,WAAK,gBAAgB,IAAI,WAAW,MAAM;AACxC,aAAK,gBAAgB;AAErB,cAAM,MAAM,IAAI,SAAS;AAEzB,YAAI,OAAO,OAAO,QAAQ,KAAK;AAG7B,iBAAO,OAAO,KAAK;AAAA,QACrB;AAAA,MACF,GAAG,eAAe;AAAA,IACpB;AAAA,EACF;AACF;AAKO,IAAM,UAAN,MAAM,SAAQ;AAAA,EAqBX,YAAY,KAAwB,OAAsB;AAjBlE,SAAQ,MAAyB,CAAC;AAkBhC,SAAK,MAAM,MAAM,EAAE;AACnB,SAAK,OAAO;AAEZ,UAAM,UAAU,IAAI;AAEpB,QAAI,SAAS;AACX,WAAK,QAAQ,QAAQ;AACrB,cAAQ,KAAK,KAAK,GAAG,IAAI;AAAA,IAC3B,OAAO;AACL,WAAK,QAAQ,IAAI,YAAY,KAAK,KAAK;AACvC,UAAI,YAAY;AAAA,QACd,MAAM,KAAK;AAAA,QACX,MAAM,EAAE,CAAC,KAAK,GAAG,GAAG,KAAK;AAAA,MAC3B;AAAA,IACF;AAAA,EACF;AAAA,EA/BA,OAAO,OAAO,KAAwB,OAA+B;AACnE,WAAO,IAAI,SAAQ,KAAK,KAAK;AAAA,EAC/B;AAAA,EAEA,OAAO,QAAQ,UAAyB;AACtC,aAAS,QAAQ;AAAA,EACnB;AAAA;AAAA;AAAA;AAAA,EAKA,OAAO,OAAO,UAAmB,0BAAyC;AACxE,aAAS,IAAI,QAAQ,CAAC,aAAa,SAAS,wBAAwB,CAAC;AAAA,EACvE;AAAA,EAoBQ,UAAgB;AAxU1B;AAyUI,UAAM,WAAU,UAAK,SAAL,mBAAW;AAE3B,QAAI,mCAAS,KAAK,KAAK,MAAM;AAC3B,aAAO,QAAQ,KAAK,KAAK,GAAG;AAE5B,UAAI,OAAO,KAAK,QAAQ,IAAI,EAAE,WAAW,GAAG;AAC1C,gBAAQ,KAAK,QAAQ;AAErB,eAAO,KAAK,KAAM;AAAA,MACpB;AAAA,IACF,WAAW,QAAQ,IAAI,aAAa,cAAc;AAChD,cAAQ;AAAA,QACN,oBAAoB,KAAK,GAAG;AAAA,MAC9B;AAAA,IACF;AAEA,SAAK,MAAM,CAAC;AACZ,WAAO,KAAK;AACZ,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAKA,2BAAoC;AAClC,WAAO,OAAO,OAAO;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA,EAKA,UAAU,UAAiC;AACzC,SAAK,IAAI,KAAK,QAAQ;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA,EAKA,YAAY,UAAiC;AAC3C,UAAM,QAAQ,KAAK,IAAI,QAAQ,QAAQ;AAEvC,QAAI,SAAS,GAAG;AACd,WAAK,IAAI,OAAO,OAAO,CAAC;AAAA,IAC1B;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,OAAO,0BAAyC;AAC9C,WAAO,OAAO,wBAAwB;AAAA,EACxC;AACF;AAEO,SAAS,cAAc,KAAa,OAA+B;AACxE,SAAO,QAAQ,OAAO,KAAK,KAAK;AAClC;AAEO,SAAS,eAAe,UAAmB;AAChD,UAAQ,QAAQ,QAAQ;AAC1B;;;ACnXO,IAAM,UAAU;","names":[]}
@@ -1,87 +1,112 @@
1
- /*!
2
- * Copyright (c) Microsoft Corporation. All rights reserved.
3
- * Licensed under the MIT License.
4
- */
5
- import { Disposable } from "./WeakRefInstance";
6
- interface WindowWithKeyborg extends Window {
7
- __keyborg?: {
8
- core: KeyborgCore;
9
- refs: {
10
- [id: string]: Keyborg;
11
- };
12
- };
13
- }
14
- export interface KeyborgProps {
15
- triggerKeys?: number[];
16
- dismissKeys?: number[];
17
- }
18
- export declare type KeyborgCallback = (isNavigatingWithKeyboard: boolean) => void;
19
- /**
20
- * Source of truth for all the keyborg core instances and the current keyboard navigation state
21
- */
22
- export declare class KeyborgState {
23
- private __keyborgCoreRefs;
24
- private _isNavigatingWithKeyboard;
25
- add(keyborg: KeyborgCore): void;
26
- remove(id: string): void;
27
- setVal(isNavigatingWithKeyboard: boolean): void;
28
- getVal(): boolean;
29
- }
30
- /**
31
- * Manages a collection of Keyborg instances in a window/document and updates keyborg state
32
- */
33
- declare class KeyborgCore implements Disposable {
34
- readonly id: string;
35
- private _win?;
36
- private _isMouseUsedTimer;
37
- private _dismissTimer;
38
- private _triggerKeys?;
39
- private _dismissKeys?;
40
- constructor(win: WindowWithKeyborg, props?: KeyborgProps);
41
- dispose(): void;
42
- isDisposed(): boolean;
43
- /**
44
- * Updates all keyborg instances with the keyboard navigation state
45
- */
46
- update(isNavigatingWithKeyboard: boolean): void;
47
- private _onFocusIn;
48
- private _onMouseDown;
49
- private _onKeyDown;
50
- private _scheduleDismiss;
51
- }
52
- /**
53
- * Used to determine the keyboard navigation state
54
- */
55
- export declare class Keyborg {
56
- private _id;
57
- private _win?;
58
- private _core?;
59
- private _cb;
60
- static create(win: WindowWithKeyborg, props?: KeyborgProps): Keyborg;
61
- static dispose(instance: Keyborg): void;
62
- /**
63
- * Updates all subscribed callbacks with the keyboard navigation state
64
- */
65
- static update(instance: Keyborg, isNavigatingWithKeyboard: boolean): void;
66
- private constructor();
67
- private dispose;
68
- /**
69
- * @returns Whether the user is navigating with keyboard
70
- */
71
- isNavigatingWithKeyboard(): boolean;
72
- /**
73
- * @param callback - Called when the keyboard navigation state changes
74
- */
75
- subscribe(callback: KeyborgCallback): void;
76
- /**
77
- * @param callback - Registered with subscribe
78
- */
79
- unsubscribe(callback: KeyborgCallback): void;
80
- /**
81
- * Manually set the keyboard navigtion state
82
- */
83
- setVal(isNavigatingWithKeyboard: boolean): void;
84
- }
85
- export declare function createKeyborg(win: Window, props?: KeyborgProps): Keyborg;
86
- export declare function disposeKeyborg(instance: Keyborg): void;
87
- export {};
1
+ /**
2
+ * Allows disposable instances to be used
3
+ */
4
+ interface Disposable {
5
+ isDisposed?(): boolean;
6
+ }
7
+
8
+ /*!
9
+ * Copyright (c) Microsoft Corporation. All rights reserved.
10
+ * Licensed under the MIT License.
11
+ */
12
+
13
+ interface WindowWithKeyborg extends Window {
14
+ __keyborg?: {
15
+ core: KeyborgCore;
16
+ refs: {
17
+ [id: string]: Keyborg;
18
+ };
19
+ };
20
+ }
21
+ interface KeyborgProps {
22
+ triggerKeys?: number[];
23
+ dismissKeys?: number[];
24
+ }
25
+ type KeyborgCallback = (isNavigatingWithKeyboard: boolean) => void;
26
+ /**
27
+ * Manages a collection of Keyborg instances in a window/document and updates keyborg state
28
+ */
29
+ declare class KeyborgCore implements Disposable {
30
+ readonly id: string;
31
+ private _win?;
32
+ private _isMouseUsedTimer;
33
+ private _dismissTimer;
34
+ private _triggerKeys?;
35
+ private _dismissKeys?;
36
+ constructor(win: WindowWithKeyborg, props?: KeyborgProps);
37
+ dispose(): void;
38
+ isDisposed(): boolean;
39
+ /**
40
+ * Updates all keyborg instances with the keyboard navigation state
41
+ */
42
+ update(isNavigatingWithKeyboard: boolean): void;
43
+ private _onFocusIn;
44
+ private _onMouseDown;
45
+ private _onKeyDown;
46
+ private _scheduleDismiss;
47
+ }
48
+ /**
49
+ * Used to determine the keyboard navigation state
50
+ */
51
+ declare class Keyborg {
52
+ private _id;
53
+ private _win?;
54
+ private _core?;
55
+ private _cb;
56
+ static create(win: WindowWithKeyborg, props?: KeyborgProps): Keyborg;
57
+ static dispose(instance: Keyborg): void;
58
+ /**
59
+ * Updates all subscribed callbacks with the keyboard navigation state
60
+ */
61
+ static update(instance: Keyborg, isNavigatingWithKeyboard: boolean): void;
62
+ private constructor();
63
+ private dispose;
64
+ /**
65
+ * @returns Whether the user is navigating with keyboard
66
+ */
67
+ isNavigatingWithKeyboard(): boolean;
68
+ /**
69
+ * @param callback - Called when the keyboard navigation state changes
70
+ */
71
+ subscribe(callback: KeyborgCallback): void;
72
+ /**
73
+ * @param callback - Registered with subscribe
74
+ */
75
+ unsubscribe(callback: KeyborgCallback): void;
76
+ /**
77
+ * Manually set the keyboard navigtion state
78
+ */
79
+ setVal(isNavigatingWithKeyboard: boolean): void;
80
+ }
81
+ declare function createKeyborg(win: Window, props?: KeyborgProps): Keyborg;
82
+ declare function disposeKeyborg(instance: Keyborg): void;
83
+
84
+ declare const KEYBORG_FOCUSIN = "keyborg:focusin";
85
+ interface KeyborgFocusInEventDetails {
86
+ relatedTarget?: HTMLElement;
87
+ isFocusedProgrammatically?: boolean;
88
+ }
89
+ interface KeyborgFocusInEvent extends CustomEvent<KeyborgFocusInEventDetails> {
90
+ /**
91
+ * @deprecated - used `event.detail`
92
+ */
93
+ details?: KeyborgFocusInEventDetails;
94
+ }
95
+ /**
96
+ * Guarantees that the native `focus` will be used
97
+ */
98
+ declare function nativeFocus(element: HTMLElement): void;
99
+ /**
100
+ * @param win The window that stores keyborg focus events
101
+ * @returns The last element focused with element.focus()
102
+ */
103
+ declare function getLastFocusedProgrammatically(win: Window): HTMLElement | null | undefined;
104
+
105
+ /*!
106
+ * Copyright (c) Microsoft Corporation. All rights reserved.
107
+ * Licensed under the MIT License.
108
+ */
109
+
110
+ declare const version: string | undefined;
111
+
112
+ export { KEYBORG_FOCUSIN, Keyborg, type KeyborgCallback, type KeyborgFocusInEvent, type KeyborgFocusInEventDetails, createKeyborg, disposeKeyborg, getLastFocusedProgrammatically, nativeFocus, version };
package/dist/index.d.ts CHANGED
@@ -1,7 +1,112 @@
1
- /*!
2
- * Copyright (c) Microsoft Corporation. All rights reserved.
3
- * Licensed under the MIT License.
4
- */
5
- export { Keyborg, KeyborgCallback, createKeyborg, disposeKeyborg, } from "./Keyborg";
6
- export { getLastFocusedProgrammatically, nativeFocus, KEYBORG_FOCUSIN, KeyborgFocusInEvent, KeyborgFocusInEventDetails, } from "./FocusEvent";
7
- export declare const version: string;
1
+ /**
2
+ * Allows disposable instances to be used
3
+ */
4
+ interface Disposable {
5
+ isDisposed?(): boolean;
6
+ }
7
+
8
+ /*!
9
+ * Copyright (c) Microsoft Corporation. All rights reserved.
10
+ * Licensed under the MIT License.
11
+ */
12
+
13
+ interface WindowWithKeyborg extends Window {
14
+ __keyborg?: {
15
+ core: KeyborgCore;
16
+ refs: {
17
+ [id: string]: Keyborg;
18
+ };
19
+ };
20
+ }
21
+ interface KeyborgProps {
22
+ triggerKeys?: number[];
23
+ dismissKeys?: number[];
24
+ }
25
+ type KeyborgCallback = (isNavigatingWithKeyboard: boolean) => void;
26
+ /**
27
+ * Manages a collection of Keyborg instances in a window/document and updates keyborg state
28
+ */
29
+ declare class KeyborgCore implements Disposable {
30
+ readonly id: string;
31
+ private _win?;
32
+ private _isMouseUsedTimer;
33
+ private _dismissTimer;
34
+ private _triggerKeys?;
35
+ private _dismissKeys?;
36
+ constructor(win: WindowWithKeyborg, props?: KeyborgProps);
37
+ dispose(): void;
38
+ isDisposed(): boolean;
39
+ /**
40
+ * Updates all keyborg instances with the keyboard navigation state
41
+ */
42
+ update(isNavigatingWithKeyboard: boolean): void;
43
+ private _onFocusIn;
44
+ private _onMouseDown;
45
+ private _onKeyDown;
46
+ private _scheduleDismiss;
47
+ }
48
+ /**
49
+ * Used to determine the keyboard navigation state
50
+ */
51
+ declare class Keyborg {
52
+ private _id;
53
+ private _win?;
54
+ private _core?;
55
+ private _cb;
56
+ static create(win: WindowWithKeyborg, props?: KeyborgProps): Keyborg;
57
+ static dispose(instance: Keyborg): void;
58
+ /**
59
+ * Updates all subscribed callbacks with the keyboard navigation state
60
+ */
61
+ static update(instance: Keyborg, isNavigatingWithKeyboard: boolean): void;
62
+ private constructor();
63
+ private dispose;
64
+ /**
65
+ * @returns Whether the user is navigating with keyboard
66
+ */
67
+ isNavigatingWithKeyboard(): boolean;
68
+ /**
69
+ * @param callback - Called when the keyboard navigation state changes
70
+ */
71
+ subscribe(callback: KeyborgCallback): void;
72
+ /**
73
+ * @param callback - Registered with subscribe
74
+ */
75
+ unsubscribe(callback: KeyborgCallback): void;
76
+ /**
77
+ * Manually set the keyboard navigtion state
78
+ */
79
+ setVal(isNavigatingWithKeyboard: boolean): void;
80
+ }
81
+ declare function createKeyborg(win: Window, props?: KeyborgProps): Keyborg;
82
+ declare function disposeKeyborg(instance: Keyborg): void;
83
+
84
+ declare const KEYBORG_FOCUSIN = "keyborg:focusin";
85
+ interface KeyborgFocusInEventDetails {
86
+ relatedTarget?: HTMLElement;
87
+ isFocusedProgrammatically?: boolean;
88
+ }
89
+ interface KeyborgFocusInEvent extends CustomEvent<KeyborgFocusInEventDetails> {
90
+ /**
91
+ * @deprecated - used `event.detail`
92
+ */
93
+ details?: KeyborgFocusInEventDetails;
94
+ }
95
+ /**
96
+ * Guarantees that the native `focus` will be used
97
+ */
98
+ declare function nativeFocus(element: HTMLElement): void;
99
+ /**
100
+ * @param win The window that stores keyborg focus events
101
+ * @returns The last element focused with element.focus()
102
+ */
103
+ declare function getLastFocusedProgrammatically(win: Window): HTMLElement | null | undefined;
104
+
105
+ /*!
106
+ * Copyright (c) Microsoft Corporation. All rights reserved.
107
+ * Licensed under the MIT License.
108
+ */
109
+
110
+ declare const version: string | undefined;
111
+
112
+ export { KEYBORG_FOCUSIN, Keyborg, type KeyborgCallback, type KeyborgFocusInEvent, type KeyborgFocusInEventDetails, createKeyborg, disposeKeyborg, getLastFocusedProgrammatically, nativeFocus, version };