Skip to main content

Module which_key

Module which_key 

Source
Expand description

The which-key overlay (spec §8b) — the popup docked above the status bar that documents the pending leader sequence. It renders the node the LeaderEngine currently sits on, so it can never drift from the tree: same data, two surfaces.

Reveal policy: hidden while a sequence is typed fluently; shown once the user hesitates past leader_timeout_ms. Hidden the instant the sequence fires or cancels (the engine simply stops being pending).

Functions§

desired_height
Rows the overlay needs for the current node (header + grid + borders). The caller carves this out of the area directly above the status bar.
render
Render the overlay into rect (the caller positions it docked above the status bar, full width).