From 1a737d02c60bc150bfb25c6f4c1e439f62e4603a Mon Sep 17 00:00:00 2001 From: dmitrykurmanov Date: Wed, 6 Mar 2024 18:40:32 +0400 Subject: [PATCH 01/15] renamed menuKeyUX to focusGroupKeyUX with all files and tests --- README.md | 18 +++++++++--------- menu.js => focus-group.js | 2 +- index.d.ts | 12 ++++++------ index.js | 2 +- package.json | 2 +- test/demo/index.tsx | 4 ++-- test/{menu.test.ts => focus-group.test.ts} | 16 ++++++++-------- 7 files changed, 28 insertions(+), 28 deletions(-) rename menu.js => focus-group.js (98%) rename test/{menu.test.ts => focus-group.test.ts} (94%) diff --git a/README.md b/README.md index a4f0a49..5697b86 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ import { hiddenKeyUX, hotkeyKeyUX, jumpKeyUX, - menuKeyUX, + focusGroupKeyUX, pressKeyUX, startKeyUX } from 'keyux' @@ -55,7 +55,7 @@ const overrides = {} startKeyUX(window, [ hotkeyKeyUX(overrides), - menuKeyUX(), + focusGroupKeyUX(), pressKeyUX('is-pressed'), jumpKeyUX(), hiddenKeyUX() @@ -217,13 +217,13 @@ with arrow navigation. Users will use Tab to get inside the menu, and will use either arrows or Home, End or an item name to navigate inside. -To enable this feature, call `menuKeyUX`. +To enable this feature, call `focusGroupKeyUX`. ```js -import { menuKeyUX } from 'keyux' +import { focusGroupKeyUX } from 'keyux' startKeyUX(window, [ - menuKeyUX() + focusGroupKeyUX() ]) ``` @@ -260,10 +260,10 @@ You can add `aria-controls` to `` to make the focus jump on Enter { let inMenu = false let typingDelayMs = options?.searchDelayMs || 300 diff --git a/index.d.ts b/index.d.ts index d3604b3..d4f3e67 100644 --- a/index.d.ts +++ b/index.d.ts @@ -28,7 +28,7 @@ export interface KeyUXModule { (window: MinimalWindow): () => void } -export interface MenuKeyUXOptions { +export interface focusGroupKeyUXOptions { /** * Maximum allowed pause between key presses when searching * for a list item by name. Default is 300. @@ -55,14 +55,14 @@ export function hotkeyKeyUX(overrides?: HotkeyOverride): KeyUXModule * Add arrow-navigation on `role="menu"`. * * ```js - * import { startKeyUX, menuKeyUX } from 'keyux' + * import { startKeyUX, focusGroupKeyUX } from 'keyux' * * startKeyUX(window, [ - * menuKeyUX() + * focusGroupKeyUX() * ]) * ``` */ -export function menuKeyUX(options?: MenuKeyUXOptions): KeyUXModule +export function focusGroupKeyUX(options?: focusGroupKeyUXOptions): KeyUXModule /** * Add pressed style on button activation from keyboard. @@ -111,7 +111,7 @@ export function hiddenKeyUX(): KeyUXModule * import { * startKeyUX, * hotkeyKeyUX, - * menuKeyUX, + * focusGroupKeyUX, * pressKeyUX, * jumpKeyUX, * hiddenKeyUX @@ -119,7 +119,7 @@ export function hiddenKeyUX(): KeyUXModule * * startKeyUX(window, [ * hotkeyKeyUX(), - * menuKeyUX(), + * focusGroupKeyUX(), * pressKeyUX('is-pressed'), * jumpKeyUX(), * hiddenKeyUX() diff --git a/index.js b/index.js index 875b9a3..f97b57f 100644 --- a/index.js +++ b/index.js @@ -1,7 +1,7 @@ +export * from './focus-group.js' export * from './hotkey.js' export * from './hidden.js' export * from './press.js' -export * from './menu.js' export * from './jump.js' export function startKeyUX(window, plugins) { diff --git a/package.json b/package.json index e721ae3..a8eecb4 100644 --- a/package.json +++ b/package.json @@ -83,7 +83,7 @@ { "name": "All modules", "import": { - "./index.js": "{ startKeyUX, hotkeyKeyUX, pressKeyUX, menuKeyUX, jumpKeyUX, hiddenKeyUX, likelyWithKeyboard, getHotKeyHint }" + "./index.js": "{ startKeyUX, hotkeyKeyUX, pressKeyUX, focusGroupKeyUX, jumpKeyUX, hiddenKeyUX, likelyWithKeyboard, getHotKeyHint }" }, "limit": "1737 B" } diff --git a/test/demo/index.tsx b/test/demo/index.tsx index 3defb7b..dd6177a 100644 --- a/test/demo/index.tsx +++ b/test/demo/index.tsx @@ -3,12 +3,12 @@ import { createRoot } from 'react-dom/client' import type { HotkeyOverride } from '../../index.js' import { + focusGroupKeyUX, getHotKeyHint, hiddenKeyUX, hotkeyKeyUX, jumpKeyUX, likelyWithKeyboard, - menuKeyUX, pressKeyUX, startKeyUX } from '../../index.js' @@ -17,7 +17,7 @@ let overrides: HotkeyOverride = {} startKeyUX(window, [ hotkeyKeyUX(overrides), - menuKeyUX(), + focusGroupKeyUX(), pressKeyUX('is-pressed'), jumpKeyUX(), hiddenKeyUX() diff --git a/test/menu.test.ts b/test/focus-group.test.ts similarity index 94% rename from test/menu.test.ts rename to test/focus-group.test.ts index 8a3e52f..d6c1fdd 100644 --- a/test/menu.test.ts +++ b/test/focus-group.test.ts @@ -3,7 +3,7 @@ import { equal } from 'node:assert' import { test } from 'node:test' import { setTimeout } from 'node:timers/promises' -import { hotkeyKeyUX, menuKeyUX, startKeyUX } from '../index.js' +import { focusGroupKeyUX, hotkeyKeyUX, startKeyUX } from '../index.js' function press(window: DOMWindow, key: string): void { let down = new window.KeyboardEvent('keydown', { bubbles: true, key }) @@ -14,7 +14,7 @@ function press(window: DOMWindow, key: string): void { test('adds menu navigation', () => { let window = new JSDOM().window - startKeyUX(window, [menuKeyUX()]) + startKeyUX(window, [focusGroupKeyUX()]) window.document.body.innerHTML = '