ai/keyux là dự án mã nguồn mở trên GitHub, viết chủ yếu bằng TypeScript, với 550 sao. JS library to improve keyboard UI of web apps
Tóm tắt dựng từ metadata GitHub của chính dự án — chưa có bài review TopGit. Trang sẽ tự động cập nhật khi bài review đầy đủ được xuất bản.
VÌ SAO CHƯA CÓ REVIEW
TopGit viết bài đầy đủ cho repo có nhiều sao nhất và được yêu cầu nhiều nhất. Trang này là snapshot trong thời gian chờ — xem README gốc ở tab READ ME.
JS library to improve the keyboard UI of web apps. It is designed not only
for a11y, but also to create professions tools where users prefer
to use the keyboard.
Add hotkeys with aria-keyshortcuts.
Show a button’s :active state when a hotkey is pressed.
Enable navigation with keyboard arrows in role="menu" lists.
Jump to the next section according to aria-controls and back
with Esc.
Show and hide submenus of role="menu".
Allow users to override hotkeys.
2 KB (minified and brotlied). No dependencies.
Vanilla JS and works with any framework including React, Vue, Svelte.
likelyWithKeyboard() returns false on mobile devices where user is unlikely
to be able to use hotkeys (but it is still possible by connecting an
external keyboard).
getHotKeyHint() replaces modifiers for Mac and makes text prettier.
For instance, for alt+b it will return Alt + B on Windows/Linux or ⌥ B
on Mac.
If you’re using overrides, pass the same override config both to hotkeyKeyUX()
and getHotKeyHint() for accurate hints:
import { getHotKeyHint, hotkeyOverrides, hotkeyKeyUX, startKeyUX } from 'keyux'
let config = { 'alt+b': 'b' }
startKeyUX(window, [
hotkeyKeyUX([hotkeyOverrides(config)]) // Override B to Alt + B
])
getHotKeyHint(window, 'b', [hotkeyOverrides(config)]) // Alt + B
One-letter hotkeys (like B) will be ignored if user’s focus is inside
text inputs or focus groups. This is why for general hotkeys
we recommend add some modifier like Alt+B.
Pressed State
KeyUX can set class to show pressed state for a button when user
presses a hotkey. It will make the UI more responsive.
overriding
You can use
postcss-pseudo-classes
to automatically add class for every :active state in your CSS.
Hotkeys Override
Many users want to override hotkeys because your hotkeys can conflict with
their browser’s extensions, system, or screen reader.
KeyUX allows overriding hotkeys using tranforms. Use the hotkeyOverrides()
tranformer with hotkeyKeyUX() and getHotKeyHint().
You will need to create some UI for users to fill this object like:
const overrides = {
'alt+b': 'b' // Override B to Alt + B
}
Then KeyUX will click on aria-keyshortcuts="b" when
Alt+B is pressed, and
getHotKeyHint(window, 'b', [hotkeyOverrides(overrides)]) will return
Alt + B/⌥ B.
Hotkeys for List
Websites may have hotkeys for each list element. For instance, for “Add to card”
button in shopping list.
To implement it:
Hide list item’s buttons by data-keyux-ignore-hotkeys from global search.
Make list item focusable by tabindex="0". When item has a focus,
KeyUX ignores data-keyux-ignore-hotkeys.
It’s common to use the Meta (or ⌘) modifier for hotkeys
on Mac, while Windows and Linux usually favor the Ctrl key. To provide
familiar experience on all platforms, enable the Mac compatibility transform:
import { hotkeyMacCompat, hotkeyKeyUX, startKeyUX, getHotKeyHint } from 'keyux'
const mac = hotkeyMacCompat()
startKeyUX(window, [hotkeyKeyUX([mac])])
getHotKeyHint(window, 'ctrl+b', [mac]) // Ctrl+B on Windows/Linux and ⌘+b on Mac
Hotkeys pressed with the Meta modifier will work as if
the Ctrl modifier was pressed.
Focus Groups
Using only Tab for navigation is not very useful. User may need to
press it too many times to get to their button (also non-screen-reader users
don’t have quick navigation).
focusgroup attribute
Key UX has limited polyfill for focusgroup attribute to mark groups where user will move :focus
by arrows.
Users will use Tab to get inside the menu, and will use either
arrows or Home,
End or an item name to navigate inside. User can search the menu item
by typing the first characters of the item text.
To enable this feature, call focusGroupKeyUX.
import { focusGroupKeyUX } from 'keyux'
startKeyUX(window, [focusGroupKeyUX()])
Listbox
The role="listbox"
is used for lists from which a user may select one or
more items which are static and, unlike HTML <select> elements,
may contain images.
Users will use Tab to get inside the tablist, and will use either
arrows or Home,
End.
To enable this feature, call focusGroupKeyUX.
import { focusGroupKeyUX } from 'keyux'
startKeyUX(window, [focusGroupKeyUX()])
Toolbar
The role="toolbar"
defines the containing element as a collection of commonly used function buttons
or controls represented in a compact visual forms. Buttons inside the toolbar
must have type="button" attribute because the default one is submit.
Users will use Tab to get inside the tablist, and will use either
arrows or Home,
End.
To enable this feature, call focusGroupKeyUX.
import { focusGroupKeyUX } from 'keyux'
startKeyUX(window, [focusGroupKeyUX()])
Focus Jumps
After finishing in one section, you can move user’s focus to the next step
to save time. For example, you can move the cursor to the page after the user
selects it from the menu. Or, you can move the focus to the item’s form after
the user selects an item in the list.
You can control where the focus moves next with aria-controls.
ai/keyux có 550 sao GitHub — tải lại trang để xem số mới nhất, hoặc xem trực tiếp github.com/ai/keyux. TopGit phản chiếu số sao của GitHub nhưng không cam kết đến từng phút.
ai/keyux có phải mã nguồn mở không?
Có — ai/keyux phát hành theo license MIT, nghĩa là mã nguồn mở để đọc, fork và (tùy license) tái sử dụng. Mã: github.com/ai/keyux.
ai/keyux có tag gì không?
Bản đồng bộ chưa ghi nhận topic GitHub nào cho ai/keyux. GitHub topics hiển thị ở thanh bên phải trang repo — đó là nơi đáng kiểm tra nhất.
ai/keyux có trang demo không?
Dự án có trang chủ ở https://ai.github.io/keyux/. Tab "Readme" ở trang này thường có ảnh chụp và hướng dẫn bắt đầu nhanh.
ai/keyux còn đang phát triển không?
Commit gần nhất trên ai/keyux là 3 tháng trước (theo timestamp GitHub). Repo có 28 fork — một chỉ báo về mức độ quan tâm của cộng đồng.
Đọc thêm về ai/keyux ở đâu?
Trang TopGit này là một snapshot — tab "Readme" hiển thị nguyên văn README của repo (đã bỏ link, giữ ảnh). Repo GitHub ở github.com/ai/keyux là nguồn chính thức.
Đọc đầy đủ README ở tab phía trên.
Vẫn đang phân vân về keyux?
Một cú bấm sẽ gửi câu hỏi kèm trang này cho AI — xem AI nói gì về keyux.