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
60566c7119
wezterm/docs/config/lua/keyassignment/ShowLauncherArgs.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

1.8 KiB
Raw Blame History

ShowLauncherArgs

{{since('20220319-142410-0fcdea07')}}

Activate the Launcher Menu in the current tab, scoping it to a set of items and with an optional title.

The arguments are a lua table with the following keys:

  • flags - required; the set of flags that specifies what to show in the launcher
  • title - optional; the title to show in the tab while the launcher is active

The possible flags are listed below. You must explicitly list each item that you want to include in the launcher. If you only specify "FUZZY" then you will see an empty launcher:

  • "FUZZY" - activate in fuzzy-only mode. By default the launcher will allow using the number keys to select from the first few items, as well as vi movement keys to select items. Pressing / will enter fuzzy filtering mode, allowing you to type a search term and reduce the set of matches. When you use the "FUZZY" flag, the launcher activates directly in fuzzy filtering mode.
  • "TABS" - include the list of tabs from the current window
  • "LAUNCH_MENU_ITEMS" - include the launch_menu items
  • "DOMAINS" - include multiplexing domains
  • "KEY_ASSIGNMENTS" - include items taken from your key assignments
  • "WORKSPACES" - include workspaces
  • "COMMANDS" - include a number of default commands {{since('20220408-101518-b908e2dd', inline=True)}}

The flags can be joined together using a | character, so "TABS|DOMAINS" is an example of a set of flags that will include both tabs and domains in the list.

This example shows how to make ALT-9 activate the launcher directly in fuzzy matching mode, and have it show only tabs:

config.keys = {
  {
    key = '9',
    mods = 'ALT',
    action = wezterm.action.ShowLauncherArgs { flags = 'FUZZY|TABS' },
  },
}