<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/window-events/augment-command-palette.md - fork/wezterm @ termiz-0.23.2</title>
<meta name="description" content="docs/config/lua/window-events/augment-command-palette.md in fork/wezterm at termiz-0.23.2.">
<meta property="og:title" content="docs/config/lua/window-events/augment-command-palette.md - fork/wezterm @ termiz-0.23.2">
<meta property="og:description" content="docs/config/lua/window-events/augment-command-palette.md in fork/wezterm at termiz-0.23.2.">
<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="termiz-0.23.2" data-tip="8b7ca454b5e0a65b69b1b736db54eae3c195384b">
<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">Eduard Korchmar</span><span class="commit-message" data-commit="b59cc5b008f2bb9be5eaaacd31dd50581f07422b">feat: add a way to spawn populated LineEditor</span><span class="snapshot-sha sha" data-commit="b59cc5b008f2bb9be5eaaacd31dd50581f07422b">b59cc5b00</span><time datetime="2024-08-21T20:35:33+02:00" title="2024-08-21 20:35:33 +0200">2024-08-21</time></p>
<header class="topbar"><details class="switcher"><summary>termiz-0.23.2</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 class="current" 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 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/termiz-0.23.2/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termiz-0.23.2/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termiz-0.23.2/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termiz-0.23.2/tree/docs/config/lua/window-events/">window-events</a> / <span class="cur">augment-command-palette.md</span></nav>
<span class="view-stats"><span>1.6 KiB</span><span>54 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/0c63ed8db541fa9d1847dc3fe74902c138207399/docs/config/lua/window-events/augment-command-palette.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>augment-command-palette</code></h1>
<p>{{since('20230712-072601-f4abf8fd')}}</p>
<p>This event is emitted when the <a href="/fork/wezterm/ref/termiz-0.23.2/blob/docs/config/lua/keyassignment/ActivateCommandPalette.md">Command Palette</a> is shown.</p>
<p>It's purpose is to enable you to add additional entries to the list of commands
shown in the palette.</p>
<p>This hook is synchronous; calling asynchronous functions will not succeed.</p>
<p>The return value is a table listing the additional entries.  Each element of the
returned table may have the following fields:</p>
<ul>
<li><code>brief</code> - required: the brief description for the entry</li>
<li><code>doc</code> - optional: a long description that may be shown after the entry, or that
may be used in future versions of wezterm to provide more information about the
command.</li>
<li><code>action</code> - the action to take when the item is activated. Can be any key assignment
action.</li>
<li><code>icon</code> - optional Nerd Fonts glyph name to use for the icon for the entry. See
<a href="/fork/wezterm/ref/termiz-0.23.2/blob/docs/config/lua/wezterm/nerdfonts.md">wezterm.nerdfonts</a> for a list of icon names.</li>
</ul>
<h2>Adding a Rename Tab entry to the palette</h2>
<p>In this example, an entry is added for renaming tabs:</p>
<pre class="language-lua"><a-k>local</a-k> <a-v>wezterm</a-v> = <a-f>require</a-f> <a-s>&#39;wezterm&#39;</a-s>
<a-k>local</a-k> <a-v>act</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v>

<a-k>local</a-k> <a-v>config</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-f>config_builder</a-f><a-p>()</a-p>

<a-v>wezterm</a-v><a-p>.</a-p><a-f>on</a-f><a-p>(</a-p><a-s>&#39;augment-command-palette&#39;</a-s><a-p>,</a-p> <a-k>function</a-k><a-p>(</a-p><a-v>window</a-v><a-p>,</a-p> <a-v>pane</a-v><a-p>)</a-p>
  <a-k>return</a-k> <a-cr>{</a-cr>
    <a-cr>{</a-cr>
      <a-v>brief</a-v> = <a-s>&#39;Rename tab&#39;</a-s><a-p>,</a-p>
      <a-v>icon</a-v> = <a-s>&#39;md_rename_box&#39;</a-s><a-p>,</a-p>

      <a-v>action</a-v> = <a-v>act</a-v><a-p>.</a-p><a-f>PromptInputLine</a-f> <a-cr>{</a-cr>
        <a-v>description</a-v> = <a-s>&#39;Enter new name for tab&#39;</a-s><a-p>,</a-p>
        <a-v>initial_value</a-v> = <a-s>&#39;My Tab Name&#39;</a-s><a-p>,</a-p>
        <a-v>action</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-f>action_callback</a-f><a-p>(</a-p><a-k>function</a-k><a-p>(</a-p><a-v>window</a-v><a-p>,</a-p> <a-v>pane</a-v><a-p>,</a-p> <a-v>line</a-v><a-p>)</a-p>
          <a-k>if</a-k> <a-v>line</a-v> <a-k>then</a-k>
            <a-v>window</a-v><a-p>:</a-p><a-f>active_tab</a-f><a-p>():</a-p><a-f>set_title</a-f><a-p>(</a-p><a-v>line</a-v><a-p>)</a-p>
          <a-k>end</a-k>
        <a-k>end</a-k><a-p>),</a-p>
      <a-cr>}</a-cr><a-p>,</a-p>
    <a-cr>}</a-cr><a-p>,</a-p>
  <a-cr>}</a-cr>
<a-k>end</a-k><a-p>)</a-p>

<a-k>return</a-k> <a-v>config</a-v></pre>
</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>`augment-command-palette`</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;20230712-072601-f4abf8fd&#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">This event is emitted when the [Command Palette](../keyassignment/ActivateCommandPalette.md) is shown.</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">It&#39;s purpose is to enable you to add additional entries to the list of commands</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">shown in the palette.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">This hook is synchronous; calling asynchronous functions will not succeed.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">The return value is a table listing the additional entries.  Each element of the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">returned table may have the following fields:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></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>* </a-p>`brief` - required: the brief description for the entry</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>`doc` - optional: a long description that may be shown after the entry, or that</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>may be used in future versions of wezterm to provide more information about the</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>command.</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>`action` - the action to take when the item is activated. Can be any key assignment</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>action.</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>`icon` - optional Nerd Fonts glyph name to use for the icon for the entry. See</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>[wezterm.nerdfonts](../wezterm/nerdfonts.md) for a list of icon names.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"></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-tt>Adding a Rename Tab entry to the palette</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"></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>In this example, an entry is added for renaming tabs:</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</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="L29" href="#L29">29</a><span class="code-text"><a-p>local </a-p><a-v>wezterm</a-v><a-p> = </a-p><a-f>require</a-f><a-p> </a-p><a-s>&#39;wezterm&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>local </a-p><a-v>act</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>local </a-p><a-v>config</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-f>config_builder</a-f><a-p>()</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>wezterm.</a-p><a-f>on</a-f><a-p>(</a-p><a-s>&#39;augment-command-palette&#39;</a-s><a-p>, </a-p><a-k>function</a-k><a-p>(</a-p><a-v>window</a-v><a-p>, </a-p><a-v>pane</a-v><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>  </a-p><a-k>return</a-k><a-p> </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</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="L37" href="#L37">37</a><span class="code-text"><a-p>      </a-p><a-v>brief</a-v><a-p> = </a-p><a-s>&#39;Rename tab&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>      </a-p><a-v>icon</a-v><a-p> = </a-p><a-s>&#39;md_rename_box&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>      </a-p><a-v>action</a-v><a-p> = </a-p><a-v>act</a-v><a-p>.</a-p><a-f>PromptInputLine</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="L41" href="#L41">41</a><span class="code-text"><a-p>        </a-p><a-v>description</a-v><a-p> = </a-p><a-s>&#39;Enter new name for tab&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>        </a-p><a-v>initial_value</a-v><a-p> = </a-p><a-s>&#39;My Tab Name&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</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-f>action_callback</a-f><a-p>(</a-p><a-k>function</a-k><a-p>(</a-p><a-v>window</a-v><a-p>, </a-p><a-v>pane</a-v><a-p>, </a-p><a-v>line</a-v><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>          </a-p><a-k>if</a-k><a-p> </a-p><a-v>line</a-v><a-p> </a-p><a-k>then</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>            </a-p><a-v>window</a-v><a-p>:</a-p><a-f>active_tab</a-f><a-p>():</a-p><a-f>set_title</a-f><a-p>(</a-p><a-v>line</a-v><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>          </a-p><a-k>end</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>        </a-p><a-k>end</a-k><a-p>),</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</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="L49" href="#L49">49</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="L50" href="#L50">50</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="L51" href="#L51">51</a><span class="code-text"><a-p>end)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>return </a-p><a-v>config</a-v></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>```</a-p></span></span></pre></div></div>
</main>
</body>
</html>
