Expand description
Public API for keyhop.
keyhop is a system-wide keyboard navigation overlay. Press a leader
chord, see hint labels on every interactable control on screen, type the
hint, done.
The crate ships both:
- A binary (
keyhop) — an end-user tool that registers a global hotkey, walks the foreground window’s accessibility tree, and renders the hint overlay. - A library — the platform-agnostic core types and traits
(
Action,Backend,Element,HintEngine), plus a Windows backend inwindows(only compiled ontarget_os = "windows").
Other backends (Linux X11/Wayland, macOS) will land as future modules
gated behind their own cfgs.
Re-exports§
pub use action::Action;pub use backend::Backend;pub use config::Config;pub use hint::HintEngine;pub use hint::DEFAULT_ALPHABET;pub use model::Bounds;pub use model::Element;pub use model::ElementId;pub use model::Role;
Modules§
- action
- Actions that can be performed against an
crate::Element. - backend
- The contract every platform backend implements.
- config
- User configuration loaded from
%APPDATA%\keyhop\config.toml. - hint
- Generation of short keyboard labels (the strings shown over hints).
- model
- Normalized representation of on-screen interactable elements.
- windows
- Windows backend for keyhop.