Protected callbacksCallback to be executed for a specified input.
Protected whenCallback that determines whether keyboard input should be handled. By default, always handle keyboard navigation.
Set up the navigation key bindings on the given jQuery element.
Interpret the given keyboard event as navigation commands.
Provide a callback to be executed when the navigation is canceled.
This will be triggered by the Escape key.
Provide a callback to be executed when navigating downwards.
This will be triggered by the Down key.
Provide a callback to be executed when navigating leftwards.
This will be triggered by the Left key.
Provide a callback to be executed when previous input is removed.
This will be triggered by the Backspace key.
Provide a callback to be executed when navigating rightwards.
This will be triggered by the Right key.
Provide a callback to be executed when the current item is selected..
This will be triggered by the Return key (and Tab key, if not disabled).
Provide a callback to be executed when the current item is tabbed into.
This will be triggered by the Tab key.
Provide a callback to be executed when navigating upwards.
This will be triggered by the Up key.
Provide a callback that determines whether keyboard input should be handled.
Generated using TypeDoc v0.24.8
The
KeyboardNavigatableclass manages lists that can be navigated with the keyboard, calling callbacks for each actions.This helper encapsulates the key binding logic, providing a simple fluent API for use.