<!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/format-window-title.md - fork/wezterm @ termiz-0.23.3</title>
<meta name="description" content="docs/config/lua/window-events/format-window-title.md in fork/wezterm at termiz-0.23.3.">
<meta property="og:title" content="docs/config/lua/window-events/format-window-title.md - fork/wezterm @ termiz-0.23.3">
<meta property="og:description" content="docs/config/lua/window-events/format-window-title.md in fork/wezterm at termiz-0.23.3.">
<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.3" data-tip="4bf28e253c0167102f07bfc7e7199c13eed98012">
<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">Wez Furlong</span><span class="commit-message" data-commit="40081cb5737da32058a3c87e14b84d8f2bfefdc4">docs: update a bunch of since lines to new macro</span><span class="snapshot-sha sha" data-commit="40081cb5737da32058a3c87e14b84d8f2bfefdc4">40081cb57</span><time datetime="2023-03-20T22:01:24-07:00" title="2023-03-20 22:01:24 -0700">2023-03-20</time></p>
<header class="topbar"><details class="switcher"><summary>termiz-0.23.3</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 class="current" 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.3/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termiz-0.23.3/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termiz-0.23.3/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termiz-0.23.3/tree/docs/config/lua/window-events/">window-events</a> / <span class="cur">format-window-title.md</span></nav>
<span class="view-stats"><span>2.0 KiB</span><span>54 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/f13e1ac5d4ec3f346724c038728ccdfbe4217069/docs/config/lua/window-events/format-window-title.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>format-window-title</code></h1>
<p>{{since('20210502-154244-3f7122cb')}}</p>
<p>The <code>format-window-title</code> event is emitted when the text for the window title
needs to be recomputed.</p>
<p>This event is a bit special in that it is <em>synchronous</em> and must return as
quickly as possible in order to avoid blocking the GUI thread.</p>
<p>The most notable consequence of this is that some functions that are
asynchronous (such as
<a href="/fork/wezterm/ref/termiz-0.23.3/blob/docs/config/lua/wezterm/run_child_process.md">wezterm.run_child_process</a>) are not possible
to call from inside the event handler and will generate a <code>format-window-title: runtime error: attempt to yield from outside a coroutine</code> error.</p>
<p>This example overrides the default window title with code that is equivalent
to the default processing--not very useful except as a starting point for
making your own title text:</p>
<pre class="language-lua"><a-v>wezterm</a-v><a-p>.</a-p><a-f>on</a-f><a-p>(</a-p><a-s>&#39;format-window-title&#39;</a-s><a-p>,</a-p> <a-k>function</a-k><a-p>(</a-p><a-v>tab</a-v><a-p>,</a-p> <a-v>pane</a-v><a-p>,</a-p> <a-v>tabs</a-v><a-p>,</a-p> <a-v>panes</a-v><a-p>,</a-p> <a-v>config</a-v><a-p>)</a-p>
  <a-k>local</a-k> <a-v>zoomed</a-v> = <a-s>&#39;&#39;</a-s>
  <a-k>if</a-k> <a-v>tab</a-v><a-p>.</a-p><a-v>active_pane</a-v><a-p>.</a-p><a-v>is_zoomed</a-v> <a-k>then</a-k>
    <a-v>zoomed</a-v> = <a-s>&#39;[Z] &#39;</a-s>
  <a-k>end</a-k>

  <a-k>local</a-k> <a-v>index</a-v> = <a-s>&#39;&#39;</a-s>
  <a-k>if</a-k> <a-o>#</a-o><a-v>tabs</a-v> <a-o>&gt;</a-o> <a-n>1</a-n> <a-k>then</a-k>
    <a-v>index</a-v> = <a-v>string</a-v><a-p>.</a-p><a-f>format</a-f><a-p>(</a-p><a-s>&#39;[%d/%d] &#39;</a-s><a-p>,</a-p> <a-v>tab</a-v><a-p>.</a-p><a-v>tab_index</a-v> <a-o>+</a-o> <a-n>1</a-n><a-p>,</a-p> <a-o>#</a-o><a-v>tabs</a-v><a-p>)</a-p>
  <a-k>end</a-k>

  <a-k>return</a-k> <a-v>zoomed</a-v> <a-o>..</a-o> <a-v>index</a-v> <a-o>..</a-o> <a-v>tab</a-v><a-p>.</a-p><a-v>active_pane</a-v><a-p>.</a-p><a-v>title</a-v>
<a-k>end</a-k><a-p>)</a-p></pre>
<p>The parameters to the event are:</p>
<ul>
<li><code>tab</code> - the <a href="/fork/wezterm/ref/termiz-0.23.3/blob/docs/config/lua/TabInformation.md">TabInformation</a> for the active tab</li>
<li><code>pane</code> - the <a href="/fork/wezterm/ref/termiz-0.23.3/blob/docs/config/lua/PaneInformation.md">PaneInformation</a> for the active pane</li>
<li><code>tabs</code> - an array containing <a href="/fork/wezterm/ref/termiz-0.23.3/blob/docs/config/lua/TabInformation.md">TabInformation</a> for each of the tabs in the window</li>
<li><code>panes</code> - an array containing <a href="/fork/wezterm/ref/termiz-0.23.3/blob/docs/config/lua/PaneInformation.md">PaneInformation</a> for each of the panes in the active tab</li>
<li><code>config</code> - the effective configuration for the window</li>
</ul>
<p>The return value of the event should be a string, and if it is then it will be
used as the title text in the window title bar.</p>
<p>If the event encounters an error, or returns something that is not a string,
then the default window title text will be computed and used instead.</p>
<p>Only the first <code>format-window-title</code> event will be executed; it doesn't make
sense to define multiple instances of the event with multiple
<code>wezterm.on("format-window-title", ...)</code> calls.</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>`format-window-title`</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;20210502-154244-3f7122cb&#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">The `format-window-title` event is emitted when the text for the window title</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">needs to be recomputed.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">This event is a bit special in that it is *synchronous* and must return as</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">quickly as possible in order to avoid blocking the GUI thread.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">The most notable consequence of this is that some functions that are</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">asynchronous (such as</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">[wezterm.run_child_process](../wezterm/run_child_process.md)) are not possible</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">to call from inside the event handler and will generate a `format-window-title:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">runtime error: attempt to yield from outside a coroutine` error.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">This example overrides the default window title with code that is equivalent</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">to the default processing--not very useful except as a starting point for</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">making your own title text:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></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-tl>lua</a-tl></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>wezterm.</a-p><a-f>on</a-f><a-p>(</a-p><a-s>&#39;format-window-title&#39;</a-s><a-p>, </a-p><a-k>function</a-k><a-p>(</a-p><a-v>tab</a-v><a-p>, </a-p><a-v>pane</a-v><a-p>, </a-p><a-v>tabs</a-v><a-p>, </a-p><a-v>panes</a-v><a-p>, </a-p><a-v>config</a-v><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-k>local</a-k><a-p> </a-p><a-v>zoomed</a-v><a-p> = </a-p><a-s>&#39;&#39;</a-s></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-k>if</a-k><a-p> </a-p><a-v>tab</a-v><a-p>.</a-p><a-v>active_pane</a-v><a-p>.</a-p><a-v>is_zoomed</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="L25" href="#L25">25</a><span class="code-text"><a-p>    </a-p><a-v>zoomed</a-v><a-p> = </a-p><a-s>&#39;[Z] &#39;</a-s></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><a-k>end</a-k></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-k>local</a-k><a-p> </a-p><a-v>index</a-v><a-p> = </a-p><a-s>&#39;&#39;</a-s></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>  </a-p><a-k>if</a-k><a-p> </a-p><a-o>#</a-o><a-v>tabs</a-v><a-p> </a-p><a-o>&gt;</a-o><a-p> </a-p><a-n>1</a-n><a-p> </a-p><a-k>then</a-k></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>    </a-p><a-v>index</a-v><a-p> = </a-p><a-v>string</a-v><a-p>.</a-p><a-f>format</a-f><a-p>(</a-p><a-s>&#39;[%d/%d] &#39;</a-s><a-p>, </a-p><a-v>tab</a-v><a-p>.</a-p><a-v>tab_index</a-v><a-p> </a-p><a-o>+</a-o><a-p> </a-p><a-n>1</a-n><a-p>, </a-p><a-o>#</a-o><a-v>tabs</a-v><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</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="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>  </a-p><a-k>return</a-k><a-p> </a-p><a-v>zoomed</a-v><a-p> </a-p><a-o>..</a-o><a-p> </a-p><a-v>index</a-v><a-p> </a-p><a-o>..</a-o><a-p> </a-p><a-v>tab</a-v><a-p>.</a-p><a-v>active_pane</a-v><a-p>.</a-p><a-v>title</a-v></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>end)</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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"></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>The parameters to the event are:</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>* `tab` - the [TabInformation](../TabInformation.md) for the active tab</a-p></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>* `pane` - the [PaneInformation](../PaneInformation.md) for the active pane</a-p></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>* `tabs` - an array containing [TabInformation](../TabInformation.md) for each of the tabs in the window</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>* `panes` - an array containing [PaneInformation](../PaneInformation.md) for each of the panes in the active tab</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>* `config` - the effective configuration for the window</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text">The return value of the event should be a string, and if it is then it will be</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text">used as the title text in the window title bar.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text">If the event encounters an error, or returns something that is not a string,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text">then the default window title text will be computed and used instead.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text">Only the first `format-window-title` event will be executed; it doesn&#39;t make</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text">sense to define multiple instances of the event with multiple</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text">`wezterm.on(&quot;format-window-title&quot;, ...)` calls.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
