Kbd

[FocusGuard]{#FocusGuard data-4search="ui/kbd.js:FocusGuard;section"}

Install a FocusGuard to allow only a restricted set of elements to get focus.

Constants

[kbd_modifiers]{#kbd_modifiers data-4search="ui/kbd.js:kbd_modifiers;var"} : Keyboard modifiers used for hotkeys.

[KeyCode]{#KeyCode data-4search="ui/kbd.js:KeyCode;export"} : Symbolic names for key codes

Functions

[display_keyname]{#display_keyname data-4search="ui/kbd.js:display_keyname;func"} (keyname) : Create display name from KeyEvent.code names.

[hotkey_name_from_event]{#hotkey_name_from_event data-4search="ui/kbd.js:hotkey_name_from_event;func"} (event) : Create hotkey name from KeyboardEvent.

[match_key_event]{#match_key_event data-4search="ui/kbd.js:match_key_event;func"} (event, keyname) : Match an event's key code, considering modifiers.

[is_navigation_key_code]{#is_navigation_key_code data-4search="ui/kbd.js:is_navigation_key_code;func"} (keycode) : Check if a key code is used of rnavigaiton (and non alphanumeric).

[activeElement]{#activeElement data-4search="ui/kbd.js:activeElement;func"} () : Get the currently focussed Element, also inspecting open shadowRoot hierarchies.

[list_focusables]{#list_focusables data-4search="ui/kbd.js:list_focusables;func"} (element) : List elements that can take focus including shadow DOMs and are descendants of element or the document

[push_focus_root]{#push_focus_root data-4search="ui/kbd.js:push_focus_root;func"} (element, escapecb) : Constrain focus to element and its descendants

[remove_focus_root]{#remove_focus_root data-4search="ui/kbd.js:remove_focus_root;func"} (element) : Remove an element previously installed via push_focus_root()

[element_rect]{#element_rect data-4search="ui/kbd.js:element_rect;func"} (element) : Compute element rectangle, e.g. for focus movement

[keydown_move_focus]{#keydown_move_focus data-4search="ui/kbd.js:keydown_move_focus;func"} (event) : Move focus on UP/DOWN/HOME/END keydown events

[move_focus]{#move_focus data-4search="ui/kbd.js:move_focus;func"} (dir, subfocus) : Move focus to prev or next focus widget

[forget_focus]{#forget_focus data-4search="ui/kbd.js:forget_focus;func"} (element) : Forget the last focus element inside element

[hotkey_handler]{#hotkey_handler data-4search="ui/kbd.js:hotkey_handler;func"} (event) : Global key handler to dispatch key events according to global keymaps.

[add_hotkey]{#add_hotkey data-4search="ui/kbd.js:add_hotkey;func"} (hotkey, callback, subtree_element) : Add a global hotkey handler.

[remove_hotkey]{#remove_hotkey data-4search="ui/kbd.js:remove_hotkey;func"} (hotkey, callback) : Remove a global hotkey handler.

[add_key_filter]{#add_key_filter data-4search="ui/kbd.js:add_key_filter;func"} (keycode, callback) : Add a global keymap.

[remove_key_filter]{#remove_key_filter data-4search="ui/kbd.js:remove_key_filter;func"} (keycode) : Remove a global keymap.

[add_keymap]{#add_keymap data-4search="ui/kbd.js:add_keymap;func"} (keymap) : Add a global keymap.

[remove_keymap]{#remove_keymap data-4search="ui/kbd.js:remove_keymap;func"} (keymap) : Remove a global keymap.

[is_button_input]{#is_button_input data-4search="ui/kbd.js:is_button_input;func"} (element) : Check if element is button-like input

[is_nav_input]{#is_nav_input data-4search="ui/kbd.js:is_nav_input;func"} (element) : Check if element has inner input navigation

[shortcut_lookup]{#shortcut_lookup data-4search="ui/kbd.js:shortcut_lookup;func"} (mapname, label, shortcut) : Lookup shortcut for label in mapname, default to shortcut

[shortcut_dialog]{#shortcut_dialog data-4search="ui/kbd.js:shortcut_dialog;func"} (mapname, label, shortcut) : Display shortcut editing dialog