1
1
mirror of https://github.com/wez/wezterm.git synced 2024-12-29 16:42:13 +03:00
wezterm/docs/config/lua/keyassignment/SplitPane.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.3 KiB

SplitPane

{{since('20220624-141144-bd1b7c5d')}}

Splits the active pane in a particular direction, spawning a new command into the newly created pane.

This assignment has a number of fields that control the overall action:

  • direction - can be one of "Up", "Down", "Left", "Right". Specifies where the new pane will end up. This field is required.
  • size - controls the size of the new pane. Can be {Cells=10} to specify eg: 10 cells or {Percent=50} to specify 50% of the available space. If omitted, {Percent=50} is the default
  • command - the SpawnCommand that specifies what program to launch into the new pane. If omitted, the default_prog is used
  • top_level - if set to true, rather than splitting the active pane, the split will be made at the root of the tab and effectively split the entire tab across the full extent possible. The default is false.
config.keys = {
  -- This will create a new split and run the `top` program inside it
  {
    key = '%',
    mods = 'CTRL|SHIFT|ALT',
    action = wezterm.action.SplitPane {
      direction = 'Left',
      command = { args = { 'top' } },
      size = { Percent = 50 },
    },
  },
}

See also: SplitHorizontal, SplitVertical and wezterm cli split-pane --help.