<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/wezterm/action_callback.md - fork/wezterm @ termwiz-0.23.3</title>
<meta name="description" content="docs/config/lua/wezterm/action_callback.md in fork/wezterm at termwiz-0.23.3.">
<meta property="og:title" content="docs/config/lua/wezterm/action_callback.md - fork/wezterm @ termwiz-0.23.3">
<meta property="og:description" content="docs/config/lua/wezterm/action_callback.md in fork/wezterm at termwiz-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="termwiz-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="84f7fb9f3b0deb192d45ee36257e5f329584b1fc">docs: add tags to a number of pages</span><span class="snapshot-sha sha" data-commit="84f7fb9f3b0deb192d45ee36257e5f329584b1fc">84f7fb9f3</span><time datetime="2023-04-08T07:48:40-07:00" title="2023-04-08 07:48:40 -0700">2023-04-08</time></p>
<header class="topbar"><details class="switcher"><summary>termwiz-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 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 class="current" 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.3/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termwiz-0.23.3/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termwiz-0.23.3/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termwiz-0.23.3/tree/docs/config/lua/wezterm/">wezterm</a> / <span class="cur">action_callback.md</span></nav>
<span class="view-stats"><span>1.1 KiB</span><span>51 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/7b7b68e03fdf0af6e6d40852fea323d607580d1b/docs/config/lua/wezterm/action_callback.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"><hr />
<p>title: wezterm.action_callback
tags:</p>
<ul>
<li>keys</li>
<li>event</li>
</ul>
<hr />
<h1><code>wezterm.action_callback(callback)</code></h1>
<p>{{since('20211204-082213-a66c61ee9')}}</p>
<p>This function is a helper to register a custom event and return an action triggering it.</p>
<p>It is helpful to write custom key bindings directly, without having to declare
the event and use it in a different place.</p>
<p>The implementation is essentially the same as:</p>
<pre class="language-lua"><a-k>function</a-k> <a-v>wezterm</a-v><a-p>.</a-p><a-f>action_callback</a-f><a-p>(</a-p><a-v>callback</a-v><a-p>)</a-p>
  <a-k>local</a-k> <a-v>event_id</a-v> = <a-s>&#39;...&#39;</a-s> <a-c>-- the function generates a unique event id</a-c>
  <a-v>wezterm</a-v><a-p>.</a-p><a-f>on</a-f><a-p>(</a-p><a-v>event_id</a-v><a-p>,</a-p> <a-v>callback</a-v><a-p>)</a-p>
  <a-k>return</a-k> <a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-f>EmitEvent</a-f><a-p>(</a-p><a-v>event_id</a-v><a-p>)</a-p>
<a-k>end</a-k></pre>
<p>See <a href="/fork/wezterm/ref/termwiz-0.23.3/blob/docs/config/lua/wezterm/on.md">wezterm.on</a> and <a href="/fork/wezterm/ref/termwiz-0.23.3/blob/docs/config/lua/wezterm/action.md">wezterm.action</a> for more info on what you can do with these.</p>
<h2>Usage</h2>
<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>return</a-k> <a-cr>{</a-cr>
  <a-v>keys</a-v> = <a-cr>{</a-cr>
    <a-cr>{</a-cr>
      <a-v>mods</a-v> = <a-s>&#39;CTRL|SHIFT&#39;</a-s><a-p>,</a-p>
      <a-v>key</a-v> = <a-s>&#39;i&#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>win</a-v><a-p>,</a-p> <a-v>pane</a-v><a-p>)</a-p>
        <a-v>wezterm</a-v><a-p>.</a-p><a-f>log_info</a-f> <a-s>&#39;Hello from callback!&#39;</a-s>
        <a-v>wezterm</a-v><a-p>.</a-p><a-f>log_info</a-f><a-p>(</a-p>
          <a-s>&#39;WindowID:&#39;</a-s><a-p>,</a-p>
          <a-v>win</a-v><a-p>:</a-p><a-f>window_id</a-f><a-p>(),</a-p>
          <a-s>&#39;PaneID:&#39;</a-s><a-p>,</a-p>
          <a-v>pane</a-v><a-p>:</a-p><a-f>pane_id</a-f><a-p>()</a-p>
        <a-p>)</a-p>
      <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></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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"><a-pr>title</a-pr><a-p>:</a-p> <a-s>wezterm.action_callback</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-pr>tags</a-pr><a-p>:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"> <a-p>-</a-p> <a-s>keys</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"> <a-p>-</a-p> <a-s>event</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>---</a-p></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"><a-p>#</a-p> <a-tt>`wezterm.action_callback(callback)`</a-tt></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">{{since(&#39;20211204-082213-a66c61ee9&#39;)}}</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">This function is a helper to register a custom event and return an action triggering it.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">It is helpful to write custom key bindings directly, without having to declare</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 event and use it in a different place.</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">The implementation is essentially the same as:</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-tl>lua</a-tl></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>function </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-f>action_callback</a-f><a-p>(</a-p><a-v>callback</a-v><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-k>local</a-k><a-p> </a-p><a-v>event_id</a-v><a-p> = </a-p><a-s>&#39;...&#39;</a-s><a-p> </a-p><a-c>-- the function generates a unique event id</a-c></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>wezterm</a-v><a-p>.</a-p><a-f>on</a-f><a-p>(</a-p><a-v>event_id</a-v><a-p>, </a-p><a-v>callback</a-v><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-k>return</a-k><a-p> </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-f>EmitEvent</a-f><a-p>(</a-p><a-v>event_id</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>end</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>```</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>See [wezterm.on](./on.md) and [wezterm.action](./action.md) for more info on what you can do with these.</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"></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-tt>Usage</a-tt></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>```</a-p><a-tl>lua</a-tl></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>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="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>return </a-p><a-cr>{</a-cr></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-v>keys</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="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>mods</a-v><a-p> = </a-p><a-s>&#39;CTRL|SHIFT&#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>key</a-v><a-p> = </a-p><a-s>&#39;i&#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-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>win</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="L40" href="#L40">40</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;Hello from callback!&#39;</a-s></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></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-s>&#39;WindowID:&#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>win</a-v><a-p>:</a-p><a-f>window_id</a-f><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-s>&#39;PaneID:&#39;</a-s><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"><a-p>          </a-p><a-v>pane</a-v><a-p>:</a-p><a-f>pane_id</a-f><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></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></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></span></span></pre></div></div>
</main>
</body>
</html>
