Skip to main content

KeymapProvider

Function KeymapProvider 

Source
pub fn KeymapProvider(props: KeymapProviderProps) -> impl IntoView
Expand description

Installs a global keydown listener that matches keys against registered command bindings and runs the first match, supporting chord sequences (for example g d).

Wrap your app in this once. When which_key is enabled (the default) and a chord prefix is pending, it renders an overlay listing the possible completions. Bindings are ignored while a text input is focused unless a modifier is held or a chord is already in progress.

§Required Props

§Optional Props