wez/wezterm
1
1
Fork 0
mirror of https://github.com/wez/wezterm.git synced 2024-12-29 16:42:13 +03:00
Code Issues Projects Releases Wiki Activity
7b40f01054
wezterm/docs/config/lua/keyassignment/ActivateKeyTable.md
Benoit de Chezelles f37c3ae5da
Fix some documentation pages (#3321) 
* Update ssh_backend.md

* Update normalize_output_to_unicode_nfc.md

* Update strikethrough_position.md

* Update underline_position.md

* Update underline_thickness.md

* Fix lua config docs titles to be formatted as inline code

* Mention how suggested alphabet for quick select is choosen

* Mention update-status and update-right-status for status_update_interval

* Fix docs for all keyassignments to be formatted as inline code

* Fix Lua object index titles

* Fix titles of `wezterm.*` module index pages

* Fix title of `Color` object & `wezterm.color` functions

We reduce titles from h2 to h1 because mkdocs defaults the page title to
the page file name if no h1 header is found.

* Unify title of all object methods

* Add index page for Gui events
2023-03-22 06:36:03 -07:00

2.3 KiB
Raw Blame History

ActivateKeyTable

{{since('20220408-101518-b908e2dd')}}

Activates a named key table.

See Key Tables for a detailed example.

The following parameters are possible:

  • name - the name of the table to activate. The name must match up to an entry in the key_tables configuration.
  • timeout_milliseconds - an optional duration expressed in milliseconds. If specified, then the activation will automatically expire and pop itself from the key table stack once that duration elapses. If omitted, this activation will not expire due to time.
    • {{since('20220807-113146-c2fee766', inline=True)}}: the timer is reset each time you press a key that matches this key table activation, allowing for repeated key presses
  • one_shot - an optional boolean that controls whether the activation will pop itself after a single additional key press. The default if left unspecified is one_shot=true. When set to false, pressing a key will not automatically pop the activation and you will need to use either a timeout or an explicit key assignment that triggers PopKeyTable to cancel the activation.
  • replace_current - an optional boolean. Defaults to false if unspecified. If set to true then behave as though PopKeyTable was triggered before pushing this new activation on the stack. This is most useful for key assignments in a table that was activated using one_shot=false.
  • until_unknown - an optional boolean. Defaults to false if unspecified. If set to true then a key press that doesn't match any entries in the named key table will implicitly pop this entry from the stack. This can be used together with timeout_milliseconds. {{since('20220807-113146-c2fee766', inline=True)}}
  • prevent_fallback - an optional boolean. Defaults to false if unspecified. If set to true then a key press that doesn't match any entries in the named key table will halt any further key table stack matching, allowing only key assignments that are defined in the current key table activation to match. Use with care: if you haven't defined an explicit PopKeyTable assignment in the key table, you can lock yourself out of the keyboard and will need to reload the configuration file (eg: by re-saving it) to get back in. {{since('20221119-145034-49b9839f', inline=True)}}