<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/keyassignment/SplitPane.md - fork/wezterm @ vtparse-0.7.0</title>
<meta name="description" content="docs/config/lua/keyassignment/SplitPane.md in fork/wezterm at vtparse-0.7.0.">
<meta property="og:title" content="docs/config/lua/keyassignment/SplitPane.md - fork/wezterm @ vtparse-0.7.0">
<meta property="og:description" content="docs/config/lua/keyassignment/SplitPane.md in fork/wezterm at vtparse-0.7.0.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="vtparse-0.7.0" data-tip="3bfe6df191af37bc33fe5fe6de12a40f7067f101">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/wezterm</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/wezterm</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Benoit de Chezelles</span><span class="commit-message" data-commit="f37c3ae5daaff27ecb885f4eed86ddb5784fdb59">Fix some documentation pages (#3321)</span><span class="snapshot-sha sha" data-commit="f37c3ae5daaff27ecb885f4eed86ddb5784fdb59">f37c3ae5d</span><time datetime="2023-03-22T14:36:03+01:00" title="2023-03-22 14:36:03 +0100">2023-03-22</time></p>
<header class="topbar"><details class="switcher"><summary>vtparse-0.7.0</summary><div class="menu"><strong>branches</strong><a href="/fork/wezterm/ref/main/">main</a><strong>tags</strong><a href="/fork/wezterm/ref/termiz-0.23.1/">termiz-0.23.1</a><a href="/fork/wezterm/ref/termiz-0.23.2/">termiz-0.23.2</a><a href="/fork/wezterm/ref/termiz-0.23.3/">termiz-0.23.3</a><a href="/fork/wezterm/ref/termwiz-0.23.0/">termwiz-0.23.0</a><a href="/fork/wezterm/ref/termwiz-0.23.1/">termwiz-0.23.1</a><a href="/fork/wezterm/ref/termwiz-0.23.2/">termwiz-0.23.2</a><a href="/fork/wezterm/ref/termwiz-0.23.3/">termwiz-0.23.3</a><a class="current" href="/fork/wezterm/ref/vtparse-0.7.0/">vtparse-0.7.0</a><a class="all" href="/fork/wezterm/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/wezterm/">wezterm</a> / <a href="/fork/wezterm/ref/vtparse-0.7.0/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/vtparse-0.7.0/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/vtparse-0.7.0/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/vtparse-0.7.0/tree/docs/config/lua/keyassignment/">keyassignment</a> / <span class="cur">SplitPane.md</span></nav>
<span class="view-stats"><span>1.3 KiB</span><span>29 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/7bc1c0a83fb182ae0de3c3ed84c4541777cae589/docs/config/lua/keyassignment/SplitPane.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1><code>SplitPane</code></h1>
<p>{{since('20220624-141144-bd1b7c5d')}}</p>
<p>Splits the active pane in a particular direction, spawning a new command into the newly created pane.</p>
<p>This assignment has a number of fields that control the overall action:</p>
<ul>
<li><code>direction</code> - can be one of <code>"Up"</code>, <code>"Down"</code>, <code>"Left"</code>, <code>"Right"</code>. Specifies where the new pane will end up. This field is required.</li>
<li><code>size</code> - controls the size of the new pane. Can be <code>{Cells=10}</code> to specify eg: 10 cells or <code>{Percent=50}</code> to specify 50% of the available space.  If omitted, <code>{Percent=50}</code> is the default</li>
<li><code>command</code> - the <a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/SpawnCommand.md">SpawnCommand</a> that specifies what program to launch into the new pane. If omitted, the <a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/config/default_prog.md">default_prog</a> is used</li>
<li><code>top_level</code> - if set to <code>true</code>, 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 <code>false</code>.</li>
</ul>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>keys</a-v> = <a-cr>{</a-cr>
  <a-c>-- This will create a new split and run the `top` program inside it</a-c>
  <a-cr>{</a-cr>
    <a-v>key</a-v> = <a-s>&#39;%&#39;</a-s><a-p>,</a-p>
    <a-v>mods</a-v> = <a-s>&#39;CTRL|SHIFT|ALT&#39;</a-s><a-p>,</a-p>
    <a-v>action</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-f>SplitPane</a-f> <a-cr>{</a-cr>
      <a-v>direction</a-v> = <a-s>&#39;Left&#39;</a-s><a-p>,</a-p>
      <a-v>command</a-v> = <a-cr>{</a-cr> <a-v>args</a-v> = <a-cr>{</a-cr> <a-s>&#39;top&#39;</a-s> <a-cr>}</a-cr> <a-cr>}</a-cr><a-p>,</a-p>
      <a-v>size</a-v> = <a-cr>{</a-cr> <a-v>Percent</a-v> = <a-n>50</a-n> <a-cr>}</a-cr><a-p>,</a-p>
    <a-cr>}</a-cr><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<p>See also: <a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/keyassignment/SplitHorizontal.md">SplitHorizontal</a>, <a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/keyassignment/SplitVertical.md">SplitVertical</a> and <code>wezterm cli split-pane --help</code>.</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>`SplitPane`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">{{since(&#39;20220624-141144-bd1b7c5d&#39;)}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">Splits the active pane in a particular direction, spawning a new command into the newly created pane.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">This assignment has a number of fields that control the overall action:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>* </a-p>`direction` - can be one of `&quot;Up&quot;`, `&quot;Down&quot;`, `&quot;Left&quot;`, `&quot;Right&quot;`. Specifies where the new pane will end up. This field is required.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>* </a-p>`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</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>* </a-p>`command` - the [SpawnCommand](../SpawnCommand.md) that specifies what program to launch into the new pane. If omitted, the [default_prog](../config/default_prog.md) is used</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>* </a-p>`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`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>config.</a-p><a-v>keys</a-v><a-p> = </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>  </a-p><a-c>-- This will create a new split and run the `top` program inside it</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>  </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>    </a-p><a-v>key</a-v><a-p> = </a-p><a-s>&#39;%&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>    </a-p><a-v>mods</a-v><a-p> = </a-p><a-s>&#39;CTRL|SHIFT|ALT&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>    </a-p><a-v>action</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-f>SplitPane</a-f><a-p> </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>      </a-p><a-v>direction</a-v><a-p> = </a-p><a-s>&#39;Left&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>      </a-p><a-v>command</a-v><a-p> = </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>args</a-v><a-p> = </a-p><a-cr>{</a-cr><a-p> </a-p><a-s>&#39;top&#39;</a-s><a-p> </a-p><a-cr>}</a-cr><a-p> </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>      </a-p><a-v>size</a-v><a-p> = </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>Percent</a-v><a-p> = </a-p><a-n>50</a-n><a-p> </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>    </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">See also: [SplitHorizontal](SplitHorizontal.md), [SplitVertical](SplitVertical.md) and `wezterm cli split-pane --help`.</span></span></pre></div></div>
</main>
</body>
</html>
