<!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/open-uri.md - fork/wezterm @ termiz-0.23.3</title>
<meta name="description" content="docs/config/lua/window-events/open-uri.md in fork/wezterm at termiz-0.23.3.">
<meta property="og:title" content="docs/config/lua/window-events/open-uri.md - fork/wezterm @ termiz-0.23.3">
<meta property="og:description" content="docs/config/lua/window-events/open-uri.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="e0ea0f46a81ff5e2dd5297e32ecee52550b56c06">docs: apply stylua formatting</span><span class="snapshot-sha sha" data-commit="e0ea0f46a81ff5e2dd5297e32ecee52550b56c06">e0ea0f46a</span><time datetime="2022-07-19T07:54:31-07:00" title="2022-07-19 07:54:31 -0700">2022-07-19</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">open-uri.md</span></nav>
<span class="view-stats"><span>1.2 KiB</span><span>42 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/2cf5cb85852643a151708b2d9fe9c227eeef5f68/docs/config/lua/window-events/open-uri.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>open-uri</code></h1>
<p>The <code>open-uri</code> event is emitted when the <code>CompleteSelectionOrOpenLinkAtMouseCursor</code>
key/mouse assignment is triggered.</p>
<p>The default action is to open the active URI in your browser, but if you
register for this event you can co-opt the default behavior.</p>
<p>For example, if you prefer to launch your preferred MUA in a new window
in response to clicking on <code>mailto:</code> URLs, you could do something like:</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-v>wezterm</a-v><a-p>.</a-p><a-f>on</a-f><a-p>(</a-p><a-s>&#39;open-uri&#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>uri</a-v><a-p>)</a-p>
  <a-k>local</a-k> <a-v>start</a-v><a-p>,</a-p> <a-v>match_end</a-v> = <a-v>uri</a-v><a-p>:</a-p><a-f>find</a-f> <a-s>&#39;mailto:&#39;</a-s>
  <a-k>if</a-k> <a-v>start</a-v> <a-o>==</a-o> <a-n>1</a-n> <a-k>then</a-k>
    <a-k>local</a-k> <a-v>recipient</a-v> = <a-v>uri</a-v><a-p>:</a-p><a-f>sub</a-f><a-p>(</a-p><a-v>match_end</a-v> <a-o>+</a-o> <a-n>1</a-n><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>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-f>SpawnCommandInNewWindow</a-f> <a-cr>{</a-cr>
        <a-v>args</a-v> = <a-cr>{</a-cr> <a-s>&#39;mutt&#39;</a-s><a-p>,</a-p> <a-v>recipient</a-v> <a-cr>}</a-cr><a-p>,</a-p>
      <a-cr>}</a-cr><a-p>,</a-p>
      <a-v>pane</a-v>
    <a-p>)</a-p>
    <a-c>-- prevent the default action from opening in a browser</a-c>
    <a-k>return</a-k> <a-co>false</a-co>
  <a-k>end</a-k>
  <a-c>-- otherwise, by not specifying a return value, we allow later</a-c>
  <a-c>-- handlers and ultimately the default action to caused the</a-c>
  <a-c>-- URI to be opened in the browser</a-c>
<a-k>end</a-k><a-p>)</a-p></pre>
<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 pane.</p>
<p>The third event parameter is the URI string.</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>`open-uri`</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 `open-uri` event is emitted when the `CompleteSelectionOrOpenLinkAtMouseCursor`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">key/mouse assignment is triggered.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">The default action is to open the active URI in your browser, but if you</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">register for this event you can co-opt the default behavior.</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">For example, if you prefer to launch your preferred MUA in a new window</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">in response to clicking on `mailto:` URLs, you could do something like:</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"><a-p>```</a-p><a-tl>lua</a-tl></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>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="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>wezterm.</a-p><a-f>on</a-f><a-p>(</a-p><a-s>&#39;open-uri&#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>uri</a-v><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>  </a-p><a-k>local</a-k><a-p> </a-p><a-v>start</a-v><a-p>, </a-p><a-v>match_end</a-v><a-p> = </a-p><a-v>uri</a-v><a-p>:</a-p><a-f>find</a-f><a-p> </a-p><a-s>&#39;mailto:&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>  </a-p><a-k>if</a-k><a-p> </a-p><a-v>start</a-v><a-p> </a-p><a-o>==</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="L18" href="#L18">18</a><span class="code-text"><a-p>    </a-p><a-k>local</a-k><a-p> </a-p><a-v>recipient</a-v><a-p> = </a-p><a-v>uri</a-v><a-p>:</a-p><a-f>sub</a-f><a-p>(</a-p><a-v>match_end</a-v><a-p> </a-p><a-o>+</a-o><a-p> </a-p><a-n>1</a-n><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>    </a-p><a-v>window</a-v><a-p>:</a-p><a-f>perform_action</a-f><a-p>(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>      </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-f>SpawnCommandInNewWindow</a-f><a-p> </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>        </a-p><a-v>args</a-v><a-p> = </a-p><a-cr>{</a-cr><a-p> </a-p><a-s>&#39;mutt&#39;</a-s><a-p>, </a-p><a-v>recipient</a-v><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="L22" href="#L22">22</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="L23" href="#L23">23</a><span class="code-text"><a-p>      </a-p><a-v>pane</a-v></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></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-c>-- prevent the default action from opening in a browser</a-c></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>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="L27" href="#L27">27</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="L28" href="#L28">28</a><span class="code-text"><a-p>  </a-p><a-c>-- otherwise, by not specifying a return value, we allow later</a-c></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-c>-- handlers and ultimately the default action to caused the</a-c></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-c>-- URI to be opened in the browser</a-c></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>end)</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>```</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">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="L35" href="#L35">35</a><span class="code-text">represents the gui window.</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">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="L38" href="#L38">38</a><span class="code-text">represents the pane.</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">The third event parameter is the URI string.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
