yukey🔗

a ui framework for the keyboard lover

Lit web components for application UIs where the keyboard is on par with the mouse, or better. The pitch, with a screenshot, is in the repository README; the precepts the kit follows are in its docs/.

Install🔗

npm install yukey lit

lit is a peer dependency: the components are plain Lit elements and share your app's copy.

Use🔗

Every module is importable by its file name:

import "yukey/yk-button";                                  // registers the custom element
import { MegacolumnController } from "yukey/megacolumn-controller";
import { installTokens } from "yukey/tokens";

installTokens();                                           // once, at startup: the design tokens into :root

Components (yk-button, yk-list, yk-live-list, yk-infopop) register themselves on import. Mechanisms (megacolumn-controller, tab-cycle, focus-stack, press-flash, and so on) are plain exports. The gallery (yukey/gallery/main) is the living documentation: every component, every variant, driven by the real thing.

License🔗

SPDX-License-Identifier: Apache-2.0 OR MIT