<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/PaneInformation.md - fork/wezterm @ vtparse-0.7.0</title>
<meta name="description" content="docs/config/lua/PaneInformation.md in fork/wezterm at vtparse-0.7.0.">
<meta property="og:title" content="docs/config/lua/PaneInformation.md - fork/wezterm @ vtparse-0.7.0">
<meta property="og:description" content="docs/config/lua/PaneInformation.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">Wez Furlong</span><span class="commit-message" data-commit="44866cc137e336d8c00b23f5e0d7d1f03983b591">new: ConEmu progress reporting OSC sequence</span><span class="snapshot-sha sha" data-commit="44866cc137e336d8c00b23f5e0d7d1f03983b591">44866cc13</span><time datetime="2025-02-09T18:26:23-07:00" title="2025-02-09 18:26:23 -0700">2025-02-09</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> / <span class="cur">PaneInformation.md</span></nav>
<span class="view-stats"><span>4.3 KiB</span><span>133 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/785f5d3b04981e910afd9d30c67d68d4fe347510/docs/config/lua/PaneInformation.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>PaneInformation</h1>
<p>The <code>PaneInformation</code> struct describes a pane.  Unlike <a href="pane/index.md">the Pane
object</a>, <code>PaneInformation</code> is a snapshot of some of
the key characteristics of the pane, intended for use in synchronous, fast,
event callbacks that format GUI elements such as the window and tab title bars.</p>
<p>The <code>PaneInformation</code> struct contains the following fields:</p>
<ul>
<li><code>pane_id</code> - the pane identifier number</li>
<li><code>pane_index</code> - the logical position of the pane within its containing layout</li>
<li><code>is_active</code> - is true if the pane is the active pane within its containing tab</li>
<li><code>is_zoomed</code> - is true if the pane is in the zoomed state</li>
<li><code>left</code> - the cell x coordinate of the left edge of the pane</li>
<li><code>top</code> - the cell y coordinate of the top edge of the pane</li>
<li><code>width</code> - the width of the pane in cells</li>
<li><code>height</code> - the height of the pane in cells</li>
<li><code>pixel_width</code> - the width of the pane in pixels</li>
<li><code>pixel_height</code> - the height of the pane in pixels</li>
<li><code>title</code> - the title of the pane, per <a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/pane/get_title.md">pane:get_title()</a> at the time the pane information was captured</li>
<li><code>user_vars</code> - the user variables defined for the pane, per <a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/pane/get_user_vars.md">pane:get_user_vars()</a> at the time the pane information was captured.</li>
<li><code>progress</code> - the progress state, per <a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/pane/get_progress.md">pane:get_progress()</a> at the time the pane information was captured. {{since('nightly', inline=True)}}</li>
</ul>
<p>{{since('20220101-133340-7edc5b5a')}}</p>
<p>Additional fields are available; note that accessing these may not be cheap to
compute and may slow down wezterm.  Unlike the fields listed above, these are
not pre-computed snapshots of information, so if you don't use them, you won't
pay the cost of computing them.</p>
<ul>
<li><code>foreground_process_name</code> - the path to the executable image per <a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/pane/get_foreground_process_name.md">pane:get_foreground_process_name()</a>, or an empty string if unavailable.</li>
<li><code>current_working_dir</code> - the current working directory, per <a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/pane/get_current_working_dir.md">pane:get_current_working_dir()</a>.</li>
</ul>
<p>This example places the executable name in the tab titles:</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-c>-- Equivalent to POSIX basename(3)</a-c>
<a-c>-- Given &quot;/foo/bar&quot; returns &quot;bar&quot;</a-c>
<a-c>-- Given &quot;c:\\foo\\bar&quot; returns &quot;bar&quot;</a-c>
<a-k>function</a-k> <a-f>basename</a-f><a-p>(</a-p><a-v>s</a-v><a-p>)</a-p>
  <a-k>return</a-k> <a-v>string</a-v><a-p>.</a-p><a-f>gsub</a-f><a-p>(</a-p><a-v>s</a-v><a-p>,</a-p> <a-s>&#39;(.*[/\\])(.*)&#39;</a-s><a-p>,</a-p> <a-s>&#39;%2&#39;</a-s><a-p>)</a-p>
<a-k>end</a-k>

<a-v>wezterm</a-v><a-p>.</a-p><a-f>on</a-f><a-p>(</a-p>
  <a-s>&#39;format-tab-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>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-v>hover</a-v><a-p>,</a-p> <a-v>max_width</a-v><a-p>)</a-p>
    <a-k>local</a-k> <a-v>pane</a-v> = <a-v>tab</a-v><a-p>.</a-p><a-v>active_pane</a-v>
    <a-k>local</a-k> <a-v>title</a-v> = <a-f>basename</a-f><a-p>(</a-p><a-v>pane</a-v><a-p>.</a-p><a-v>foreground_process_name</a-v><a-p>)</a-p>
      <a-o>..</a-o> <a-s>&#39; &#39;</a-s>
      <a-o>..</a-o> <a-v>pane</a-v><a-p>.</a-p><a-v>pane_id</a-v>
    <a-k>local</a-k> <a-v>color</a-v> = <a-s>&#39;navy&#39;</a-s>
    <a-k>if</a-k> <a-v>tab</a-v><a-p>.</a-p><a-v>is_active</a-v> <a-k>then</a-k>
      <a-v>color</a-v> = <a-s>&#39;blue&#39;</a-s>
    <a-k>end</a-k>
    <a-k>return</a-k> <a-cr>{</a-cr>
      <a-cr>{</a-cr> <a-v>Background</a-v> = <a-cr>{</a-cr> <a-v>Color</a-v> = <a-v>color</a-v> <a-cr>}</a-cr> <a-cr>}</a-cr><a-p>,</a-p>
      <a-cr>{</a-cr> <a-v>Text</a-v> = <a-s>&#39; &#39;</a-s> <a-o>..</a-o> <a-v>title</a-v> <a-o>..</a-o> <a-s>&#39; &#39;</a-s> <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-cr>{}</a-cr></pre>
<p>{{since('20220319-142410-0fcdea07')}}</p>
<p>The <code>has_unseen_output</code> field returns true if the there has been output
in the pane since the last time it was focused.</p>
<p>This example shows how to use this event to change the color of the
tab in the tab bar when there is unseen output.</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>config</a-v> = <a-cr>{}</a-cr>

<a-v>wezterm</a-v><a-p>.</a-p><a-f>on</a-f><a-p>(</a-p>
  <a-s>&#39;format-tab-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>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-v>hover</a-v><a-p>,</a-p> <a-v>max_width</a-v><a-p>)</a-p>
    <a-k>if</a-k> <a-v>tab</a-v><a-p>.</a-p><a-v>is_active</a-v> <a-k>then</a-k>
      <a-k>return</a-k> <a-cr>{</a-cr>
        <a-cr>{</a-cr> <a-v>Background</a-v> = <a-cr>{</a-cr> <a-v>Color</a-v> = <a-s>&#39;blue&#39;</a-s> <a-cr>}</a-cr> <a-cr>}</a-cr><a-p>,</a-p>
        <a-cr>{</a-cr> <a-v>Text</a-v> = <a-s>&#39; &#39;</a-s> <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-o>..</a-o> <a-s>&#39; &#39;</a-s> <a-cr>}</a-cr><a-p>,</a-p>
      <a-cr>}</a-cr>
    <a-k>end</a-k>
    <a-k>local</a-k> <a-v>has_unseen_output</a-v> = <a-co>false</a-co>
    <a-k>for</a-k> <a-v>_</a-v><a-p>,</a-p> <a-v>pane</a-v> <a-k>in</a-k> <a-f>ipairs</a-f><a-p>(</a-p><a-v>tab</a-v><a-p>.</a-p><a-v>panes</a-v><a-p>)</a-p> <a-k>do</a-k>
      <a-k>if</a-k> <a-v>pane</a-v><a-p>.</a-p><a-v>has_unseen_output</a-v> <a-k>then</a-k>
        <a-v>has_unseen_output</a-v> = <a-co>true</a-co>
        <a-k>break</a-k>
      <a-k>end</a-k>
    <a-k>end</a-k>
    <a-k>if</a-k> <a-v>has_unseen_output</a-v> <a-k>then</a-k>
      <a-k>return</a-k> <a-cr>{</a-cr>
        <a-cr>{</a-cr> <a-v>Background</a-v> = <a-cr>{</a-cr> <a-v>Color</a-v> = <a-s>&#39;Orange&#39;</a-s> <a-cr>}</a-cr> <a-cr>}</a-cr><a-p>,</a-p>
        <a-cr>{</a-cr> <a-v>Text</a-v> = <a-s>&#39; &#39;</a-s> <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-o>..</a-o> <a-s>&#39; &#39;</a-s> <a-cr>}</a-cr><a-p>,</a-p>
      <a-cr>}</a-cr>
    <a-k>end</a-k>
    <a-k>return</a-k> <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>

<a-k>return</a-k> <a-v>config</a-v></pre>
<p>{{since('20220624-141144-bd1b7c5d')}}</p>
<p>The <code>domain_name</code> field returns the name of the domain with which the pane is associated.</p>
<p>This example shows the domain name of the active pane appended to the tab title:</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>config</a-v> = <a-cr>{}</a-cr>

<a-v>wezterm</a-v><a-p>.</a-p><a-f>on</a-f><a-p>(</a-p><a-s>&#39;format-tab-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-k>local</a-k> <a-v>pane</a-v> = <a-v>tab</a-v><a-p>.</a-p><a-v>active_pane</a-v>
  <a-k>local</a-k> <a-v>title</a-v> = <a-v>pane</a-v><a-p>.</a-p><a-v>title</a-v>
  <a-k>if</a-k> <a-v>pane</a-v><a-p>.</a-p><a-v>domain_name</a-v> <a-k>then</a-k>
    <a-v>title</a-v> = <a-v>title</a-v> <a-o>..</a-o> <a-s>&#39; - (&#39;</a-s> <a-o>..</a-o> <a-v>pane</a-v><a-p>.</a-p><a-v>domain_name</a-v> <a-o>..</a-o> <a-s>&#39;)&#39;</a-s>
  <a-k>end</a-k>
  <a-k>return</a-k> <a-v>title</a-v>
<a-k>end</a-k><a-p>)</a-p>

<a-k>return</a-k> <a-v>config</a-v></pre>
<p>{{since('20230408-112425-69ae8472')}}</p>
<p>The <code>tty_name</code> field returns the tty name with the same constraints as described
in <a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/pane/get_tty_name.md">pane:get_tty_name()</a>.</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>PaneInformation</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">The `PaneInformation` struct describes a pane.  Unlike [the Pane</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">object](pane/index.md), `PaneInformation` is a snapshot of some of</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 key characteristics of the pane, intended for use in synchronous, fast,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">event callbacks that format GUI elements such as the window and tab title bars.</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">The `PaneInformation` struct contains the following fields:</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"><a-p>* </a-p>`pane_id` - the pane identifier number</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>`pane_index` - the logical position of the pane within its containing layout</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>`is_active` - is true if the pane is the active pane within its containing tab</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>* </a-p>`is_zoomed` - is true if the pane is in the zoomed state</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>`left` - the cell x coordinate of the left edge of the pane</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>`top` - the cell y coordinate of the top edge of the pane</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>`width` - the width of the pane in cells</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>`height` - the height of the pane in cells</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>`pixel_width` - the width of the pane in pixels</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>`pixel_height` - the height of the pane in pixels</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>`title` - the title of the pane, per [pane:get_title()](pane/get_title.md) at the time the pane information was captured</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>`user_vars` - the user variables defined for the pane, per [pane:get_user_vars()](pane/get_user_vars.md) at the time the pane information was captured.</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>`progress` - the progress state, per [pane:get_progress()](pane/get_progress.md) at the time the pane information was captured. {{since(&#39;nightly&#39;, inline=True)}}</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>{{since(&#39;20220101-133340-7edc5b5a&#39;)}}</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"></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>Additional fields are available; note that accessing these may not be cheap to</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>compute and may slow down wezterm.  Unlike the fields listed above, these are</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"><a-p>not pre-computed snapshots of information, so if you don&#39;t use them, you won&#39;t</a-p></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>pay the cost of computing them.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"></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>* `foreground_process_name` - the path to the executable image per [pane:get_foreground_process_name()](pane/get_foreground_process_name.md), or an empty string if unavailable.</a-p></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>* `current_working_dir` - the current working directory, per [pane:get_current_working_dir()](pane/get_current_working_dir.md). </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>This example places the executable name in the tab titles:</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"></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-tl>lua</a-tl></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>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="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>-- Equivalent to POSIX basename(3)</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>-- Given &quot;/foo/bar&quot; returns &quot;bar&quot;</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>-- Given &quot;c:\\foo\\bar&quot; returns &quot;bar&quot;</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>function </a-p><a-f>basename</a-f><a-p>(</a-p><a-v>s</a-v><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-k>return</a-k><a-p> </a-p><a-v>string</a-v><a-p>.</a-p><a-f>gsub</a-f><a-p>(</a-p><a-v>s</a-v><a-p>, </a-p><a-s>&#39;(.*[/\\])(.*)&#39;</a-s><a-p>, </a-p><a-s>&#39;%2&#39;</a-s><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>end</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"></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>wezterm.</a-p><a-f>on</a-f><a-p>(</a-p></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-s>&#39;format-tab-title&#39;</a-s><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-k>function</a-k><a-p>(</a-p><a-v>tab</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-v>hover</a-v><a-p>, </a-p><a-v>max_width</a-v><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-k>local</a-k><a-p> </a-p><a-v>pane</a-v><a-p> = </a-p><a-v>tab</a-v><a-p>.</a-p><a-v>active_pane</a-v></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-k>local</a-k><a-p> </a-p><a-v>title</a-v><a-p> = </a-p><a-f>basename</a-f><a-p>(</a-p><a-v>pane</a-v><a-p>.</a-p><a-v>foreground_process_name</a-v><a-p>)</a-p></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>      </a-p><a-o>..</a-o><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="L52" href="#L52">52</a><span class="code-text"><a-p>      </a-p><a-o>..</a-o><a-p> </a-p><a-v>pane</a-v><a-p>.</a-p><a-v>pane_id</a-v></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>    </a-p><a-k>local</a-k><a-p> </a-p><a-v>color</a-v><a-p> = </a-p><a-s>&#39;navy&#39;</a-s></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><a-k>if</a-k><a-p> </a-p><a-v>tab</a-v><a-p>.</a-p><a-v>is_active</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="L55" href="#L55">55</a><span class="code-text"><a-p>      </a-p><a-v>color</a-v><a-p> = </a-p><a-s>&#39;blue&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</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="L57" href="#L57">57</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="L58" href="#L58">58</a><span class="code-text"><a-p>      </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>Background</a-v><a-p> = </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>Color</a-v><a-p> = </a-p><a-v>color</a-v><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="L59" href="#L59">59</a><span class="code-text"><a-p>      </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>Text</a-v><a-p> = </a-p><a-s>&#39; &#39;</a-s><a-p> </a-p><a-o>..</a-o><a-p> </a-p><a-v>title</a-v><a-p> </a-p><a-o>..</a-o><a-p> </a-p><a-s>&#39; &#39;</a-s><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="L60" href="#L60">60</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="L61" href="#L61">61</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="L62" href="#L62">62</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>return </a-p><a-cr>{}</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"><a-p>{{since(&#39;20220319-142410-0fcdea07&#39;)}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>The `has_unseen_output` field returns true if the there has been output</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>in the pane since the last time it was focused.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>This example shows how to use this event to change the color of the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>tab in the tab bar when there is unseen output.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</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="L76" href="#L76">76</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="L77" href="#L77">77</a><span class="code-text"><a-p>local </a-p><a-v>config</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="L78" href="#L78">78</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>wezterm.</a-p><a-f>on</a-f><a-p>(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"><a-p>  </a-p><a-s>&#39;format-tab-title&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"><a-p>  </a-p><a-k>function</a-k><a-p>(</a-p><a-v>tab</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-v>hover</a-v><a-p>, </a-p><a-v>max_width</a-v><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</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>is_active</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="L83" href="#L83">83</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="L84" href="#L84">84</a><span class="code-text"><a-p>        </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>Background</a-v><a-p> = </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>Color</a-v><a-p> = </a-p><a-s>&#39;blue&#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="L85" href="#L85">85</a><span class="code-text"><a-p>        </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>Text</a-v><a-p> = </a-p><a-s>&#39; &#39;</a-s><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><a-p> </a-p><a-o>..</a-o><a-p> </a-p><a-s>&#39; &#39;</a-s><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="L86" href="#L86">86</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="L87" href="#L87">87</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="L88" href="#L88">88</a><span class="code-text"><a-p>    </a-p><a-k>local</a-k><a-p> </a-p><a-v>has_unseen_output</a-v><a-p> = </a-p><a-co>false</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"><a-p>    </a-p><a-k>for</a-k><a-p> </a-p><a-v>_</a-v><a-p>, </a-p><a-v>pane</a-v><a-p> </a-p><a-k>in</a-k><a-p> </a-p><a-f>ipairs</a-f><a-p>(</a-p><a-v>tab</a-v><a-p>.</a-p><a-v>panes</a-v><a-p>) </a-p><a-k>do</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-p>      </a-p><a-k>if</a-k><a-p> </a-p><a-v>pane</a-v><a-p>.</a-p><a-v>has_unseen_output</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="L91" href="#L91">91</a><span class="code-text"><a-p>        </a-p><a-v>has_unseen_output</a-v><a-p> = </a-p><a-co>true</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>        </a-p><a-k>break</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</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="L94" href="#L94">94</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="L95" href="#L95">95</a><span class="code-text"><a-p>    </a-p><a-k>if</a-k><a-p> </a-p><a-v>has_unseen_output</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="L96" href="#L96">96</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="L97" href="#L97">97</a><span class="code-text"><a-p>        </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>Background</a-v><a-p> = </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>Color</a-v><a-p> = </a-p><a-s>&#39;Orange&#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="L98" href="#L98">98</a><span class="code-text"><a-p>        </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>Text</a-v><a-p> = </a-p><a-s>&#39; &#39;</a-s><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><a-p> </a-p><a-o>..</a-o><a-p> </a-p><a-s>&#39; &#39;</a-s><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="L99" href="#L99">99</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="L100" href="#L100">100</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="L101" href="#L101">101</a><span class="code-text"><a-p>    </a-p><a-k>return</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>title</a-v></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</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="L103" href="#L103">103</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</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="L106" href="#L106">106</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"><a-p>{{since(&#39;20220624-141144-bd1b7c5d&#39;)}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"><a-p>The `domain_name` field returns the name of the domain with which the pane is associated.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"><a-p>This example shows the domain name of the active pane appended to the tab title:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</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="L115" href="#L115">115</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="L116" href="#L116">116</a><span class="code-text"><a-p>local </a-p><a-v>config</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="L117" href="#L117">117</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"><a-p>wezterm.</a-p><a-f>on</a-f><a-p>(</a-p><a-s>&#39;format-tab-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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"><a-p>  </a-p><a-k>local</a-k><a-p> </a-p><a-v>pane</a-v><a-p> = </a-p><a-v>tab</a-v><a-p>.</a-p><a-v>active_pane</a-v></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"><a-p>  </a-p><a-k>local</a-k><a-p> </a-p><a-v>title</a-v><a-p> = </a-p><a-v>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="L121" href="#L121">121</a><span class="code-text"><a-p>  </a-p><a-k>if</a-k><a-p> </a-p><a-v>pane</a-v><a-p>.</a-p><a-v>domain_name</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="L122" href="#L122">122</a><span class="code-text"><a-p>    </a-p><a-v>title</a-v><a-p> = </a-p><a-v>title</a-v><a-p> </a-p><a-o>..</a-o><a-p> </a-p><a-s>&#39; - (&#39;</a-s><a-p> </a-p><a-o>..</a-o><a-p> </a-p><a-v>pane</a-v><a-p>.</a-p><a-v>domain_name</a-v><a-p> </a-p><a-o>..</a-o><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="L123" href="#L123">123</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="L124" href="#L124">124</a><span class="code-text"><a-p>  </a-p><a-k>return</a-k><a-p> </a-p><a-v>title</a-v></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</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="L126" href="#L126">126</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</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="L128" href="#L128">128</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text">{{since(&#39;20230408-112425-69ae8472&#39;)}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text">The `tty_name` field returns the tty name with the same constraints as described</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text">in [pane:get_tty_name()](pane/get_tty_name.md).</span></span></pre></div></div>
</main>
</body>
</html>
