<!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/new-tab-button-click.md - fork/wezterm @ termwiz-0.23.2</title>
<meta name="description" content="docs/config/lua/window-events/new-tab-button-click.md in fork/wezterm at termwiz-0.23.2.">
<meta property="og:title" content="docs/config/lua/window-events/new-tab-button-click.md - fork/wezterm @ termwiz-0.23.2">
<meta property="og:description" content="docs/config/lua/window-events/new-tab-button-click.md in fork/wezterm at termwiz-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="termwiz-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">Wez Furlong</span><span class="commit-message" data-commit="f8c60dcddca9efcb9ac5a2e01ac479b9a2eb8010">docs: update for latest release</span><span class="snapshot-sha sha" data-commit="f8c60dcddca9efcb9ac5a2e01ac479b9a2eb8010">f8c60dcdd</span><time datetime="2023-03-26T19:45:32-07:00" title="2023-03-26 19:45:32 -0700">2023-03-26</time></p>
<header class="topbar"><details class="switcher"><summary>termwiz-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 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 class="current" 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/termwiz-0.23.2/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termwiz-0.23.2/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termwiz-0.23.2/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termwiz-0.23.2/tree/docs/config/lua/window-events/">window-events</a> / <span class="cur">new-tab-button-click.md</span></nav>
<span class="view-stats"><span>1.9 KiB</span><span>62 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/dcc05fa553de394d4d82dc49725508455f48d7ac/docs/config/lua/window-events/new-tab-button-click.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>new-tab-button-click</code></h1>
<p>{{since('20230326-111934-3666303c')}}</p>
<p>The <code>new-tab-button-click</code> event is emitted when the user clicks on the
"new tab" button in the tab bar. This is the <code>+</code> button that is drawn
to the right of the last tab.</p>
<p>The first event parameter is a <a href="../window/index.md"><code>window</code> object</a> that
represents the gui window.</p>
<p>The second event parameter is a <a href="../pane/index.md"><code>pane</code> object</a> that
represents the active pane in the window.</p>
<p>The third event parameter is an indication of which mouse button was clicked.
The following values are possible:</p>
<ul>
<li><code>"Left"</code> - the left mouse button</li>
<li><code>"Right"</code> - the right mouse button</li>
<li><code>"Middle"</code> - the middle mouse button</li>
</ul>
<p>The last event parameter is a <a href="../keyassignment/index.md">KeyAssignment</a> which
encodes the default, built-in action that wezterm will take.  It may be <code>nil</code>
in the case where wezterm would not take any action.</p>
<p>You may take any action you wish in this event handler.</p>
<p>If you return <code>false</code> then you will prevent wezterm from carrying out its
default action.</p>
<p>Otherwise, wezterm will proceed to perform that action once your event
handler returns.</p>
<p>This following two examples are equivalent in functionality:</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;new-tab-button-click&#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-v>button</a-v><a-p>,</a-p> <a-v>default_action</a-v><a-p>)</a-p>
    <a-c>-- just log the default action and allow wezterm to perform it</a-c>
    <a-v>wezterm</a-v><a-p>.</a-p><a-f>log_info</a-f><a-p>(</a-p><a-s>&#39;new-tab&#39;</a-s><a-p>,</a-p> <a-v>window</a-v><a-p>,</a-p> <a-v>pane</a-v><a-p>,</a-p> <a-v>button</a-v><a-p>,</a-p> <a-v>default_action</a-v><a-p>)</a-p>
  <a-k>end</a-k>
<a-p>)</a-p></pre>
<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;new-tab-button-click&#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-v>button</a-v><a-p>,</a-p> <a-v>default_action</a-v><a-p>)</a-p>
    <a-v>wezterm</a-v><a-p>.</a-p><a-f>log_info</a-f><a-p>(</a-p><a-s>&#39;new-tab&#39;</a-s><a-p>,</a-p> <a-v>window</a-v><a-p>,</a-p> <a-v>pane</a-v><a-p>,</a-p> <a-v>button</a-v><a-p>,</a-p> <a-v>default_action</a-v><a-p>)</a-p>
    <a-c>-- We&#39;re explicitly going to perform the default action</a-c>
    <a-k>if</a-k> <a-v>default_action</a-v> <a-k>then</a-k>
      <a-v>window</a-v><a-p>:</a-p><a-f>perform_action</a-f><a-p>(</a-p><a-v>default_action</a-v><a-p>,</a-p> <a-v>pane</a-v><a-p>)</a-p>
    <a-k>end</a-k>
    <a-c>-- and tell wezterm that we handled the event so that it doesn&#39;t</a-c>
    <a-c>-- perform it a second time.</a-c>
    <a-k>return</a-k> <a-co>false</a-co>
  <a-k>end</a-k>
<a-p>)</a-p></pre>
<p>See also <a href="/fork/wezterm/ref/termwiz-0.23.2/blob/docs/config/lua/window/perform_action.md">window:perform_action()</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>`new-tab-button-click`</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;20230326-111934-3666303c&#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 `new-tab-button-click` event is emitted when the user clicks on the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">&quot;new tab&quot; button in the tab bar. This is the `+` button that is drawn</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">to the right of the last tab.</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">The first event parameter is a [`window` object](../window/index.md) that</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">represents the gui window.</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 second event parameter is a [`pane` object](../pane/index.md) that</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">represents the active pane in the window.</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">The third event parameter is an indication of which mouse button was clicked.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">The following values are possible:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></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>`&quot;Left&quot;` - the left mouse button</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>`&quot;Right&quot;` - the right mouse button</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>`&quot;Middle&quot;` - the middle mouse button</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></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>The last event parameter is a [KeyAssignment](../keyassignment/index.md) which</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>encodes the default, built-in action that wezterm will take.  It may be `nil`</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>in the case where wezterm would not take any action.</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>You may take any action you wish in this event handler.</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>If you return `false` then you will prevent wezterm from carrying out its</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>default action.</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>Otherwise, wezterm will proceed to perform that action once your event</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>handler returns.</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 following two examples are equivalent in functionality:</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>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="L38" href="#L38">38</a><span class="code-text"><a-p>  </a-p><a-s>&#39;new-tab-button-click&#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"><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>button</a-v><a-p>, </a-p><a-v>default_action</a-v><a-p>)</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>    </a-p><a-c>-- just log the default action and allow wezterm to perform it</a-c></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>wezterm</a-v><a-p>.</a-p><a-f>log_info</a-f><a-p>(</a-p><a-s>&#39;new-tab&#39;</a-s><a-p>, </a-p><a-v>window</a-v><a-p>, </a-p><a-v>pane</a-v><a-p>, </a-p><a-v>button</a-v><a-p>, </a-p><a-v>default_action</a-v><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-k>end</a-k></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></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></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>```</a-p><a-tl>lua</a-tl></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>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="L48" href="#L48">48</a><span class="code-text"><a-p>  </a-p><a-s>&#39;new-tab-button-click&#39;</a-s><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>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>button</a-v><a-p>, </a-p><a-v>default_action</a-v><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-v>wezterm</a-v><a-p>.</a-p><a-f>log_info</a-f><a-p>(</a-p><a-s>&#39;new-tab&#39;</a-s><a-p>, </a-p><a-v>window</a-v><a-p>, </a-p><a-v>pane</a-v><a-p>, </a-p><a-v>button</a-v><a-p>, </a-p><a-v>default_action</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-c>-- We&#39;re explicitly going to perform the default action</a-c></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-k>if</a-k><a-p> </a-p><a-v>default_action</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="L53" href="#L53">53</a><span class="code-text"><a-p>      </a-p><a-v>window</a-v><a-p>:</a-p><a-f>perform_action</a-f><a-p>(</a-p><a-v>default_action</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="L54" href="#L54">54</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="L55" href="#L55">55</a><span class="code-text"><a-p>    </a-p><a-c>-- and tell wezterm that we handled the event so that it doesn&#39;t</a-c></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-c>-- perform it a second time.</a-c></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-co>false</a-co></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-k>end</a-k></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></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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text">See also [window:perform_action()](../window/perform_action.md).</span></span></pre></div></div>
</main>
</body>
</html>
