Skip to content

JumpNav

function JumpNav(__namedParameters): Element;

Vim-style quick-jump navigation to any focusable element.

Press the activation key (default Ctrl+O) to overlay hint labels next to every visible focusable element. Then press the hint character(s) to instantly focus that element.

Trap-aware — automatically scopes hints to the active FocusScope trap (e.g. a modal). Place a single <JumpNav> at the root of your app.

ParameterType
__namedParametersJumpNavProps

Element

function App() {
return (
<JumpNav>
<Box>
<Input placeholder="Name" />
<Button label="Submit" onPress={submit} />
</Box>
</JumpNav>
);
}

PropertyTypeDescription
activationKey?stringKeybind to activate jump mode (default: “ctrl+o”)
children?ReactNode-
debug?booleanEnable debug logging
enabled?booleanWhether jump nav is enabled (default: true)
hintBg?ColorColor for hint background (default: “yellow”)
hintChars?stringCharacters to use for hints (default: “asdfghjklqwertyuiopzxcvbnm”)
hintFg?ColorColor for hint text (default: “black”)
hintStyle?StyleStyle for the hint labels