<!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/has_action.md - fork/wezterm @ termiz-0.23.3</title>
<meta name="description" content="docs/config/lua/wezterm/has_action.md in fork/wezterm at termiz-0.23.3.">
<meta property="og:title" content="docs/config/lua/wezterm/has_action.md - fork/wezterm @ termiz-0.23.3">
<meta property="og:description" content="docs/config/lua/wezterm/has_action.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="f535c5bdc092c82db1b939c82babf98a2436c456">docs: update for 20230408-112425-69ae8472 release</span><span class="snapshot-sha sha" data-commit="f535c5bdc092c82db1b939c82babf98a2436c456">f535c5bdc</span><time datetime="2023-04-08T15:01:26-07:00" title="2023-04-08 15:01:26 -0700">2023-04-08</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/wezterm/">wezterm</a> / <span class="cur">has_action.md</span></nav>
<span class="view-stats"><span>580 B</span><span>28 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/3494ec53c901729d93df2de7d219fb02a805c28b/docs/config/lua/wezterm/has_action.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.has_action
tags:</p>
<ul>
<li>utility</li>
<li>version</li>
</ul>
<hr />
<h1>wezterm.has_action(NAME)</h1>
<p>{{since('20230408-112425-69ae8472')}}</p>
<p>Returns true if the string <em>NAME</em> is a valid key assignment action variant
that can be used with <a href="/fork/wezterm/ref/termiz-0.23.3/blob/docs/config/lua/wezterm/action.md">wezterm.action</a>.</p>
<p>This is useful when you want to use a wezterm configuration across multiple
different versions of wezterm.</p>
<pre class="language-lua"><a-k>if</a-k> <a-v>wezterm</a-v><a-p>.</a-p><a-f>has_action</a-f> <a-s>&#39;PromptInputLine&#39;</a-s> <a-k>then</a-k>
  <a-v>table</a-v><a-p>.</a-p><a-f>insert</a-f><a-p>(</a-p><a-v>config</a-v><a-p>.</a-p><a-v>keys</a-v><a-p>,</a-p> <a-cr>{</a-cr>
    <a-v>key</a-v> = <a-s>&#39;p&#39;</a-s><a-p>,</a-p>
    <a-v>mods</a-v> = <a-s>&#39;LEADER&#39;</a-s><a-p>,</a-p>
    <a-v>action</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-f>PromptInputLine</a-f> <a-cr>{</a-cr>
      <a-c>-- other parameters here</a-c>
    <a-cr>}</a-cr><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>)</a-p>
<a-k>end</a-k></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.has_action</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>utility</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>version</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.has_action(NAME)</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;20230408-112425-69ae8472&#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">Returns true if the string *NAME* is a valid key assignment action variant</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">that can be used with [wezterm.action](action.md).</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">This is useful when you want to use a wezterm configuration across multiple</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">different versions of wezterm.</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><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>if </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-f>has_action</a-f><a-p> </a-p><a-s>&#39;PromptInputLine&#39;</a-s><a-p> </a-p><a-k>then</a-k></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>table</a-v><a-p>.</a-p><a-f>insert</a-f><a-p>(</a-p><a-v>config</a-v><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="L21" href="#L21">21</a><span class="code-text"><a-p>    </a-p><a-v>key</a-v><a-p> = </a-p><a-s>&#39;p&#39;</a-s><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-v>mods</a-v><a-p> = </a-p><a-s>&#39;LEADER&#39;</a-s><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>action</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-f>PromptInputLine</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="L24" href="#L24">24</a><span class="code-text"><a-p>      </a-p><a-c>-- other parameters here</a-c></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-cr>}</a-cr><a-p>,</a-p></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-cr>}</a-cr><a-p>)</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>end</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>```</a-p></span></span></pre></div></div>
</main>
</body>
</html>
