<!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/keyboard_modifiers.md - fork/wezterm @ termiz-0.23.3</title>
<meta name="description" content="docs/config/lua/window/keyboard_modifiers.md in fork/wezterm at termiz-0.23.3.">
<meta property="og:title" content="docs/config/lua/window/keyboard_modifiers.md - fork/wezterm @ termiz-0.23.3">
<meta property="og:description" content="docs/config/lua/window/keyboard_modifiers.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="35df521f76cc64d7ed9e3957b939799756a29ca1">docs: update for release</span><span class="snapshot-sha sha" data-commit="35df521f76cc64d7ed9e3957b939799756a29ca1">35df521f7</span><time datetime="2023-07-12T07:46:13-07:00" title="2023-07-12 07:46:13 -0700">2023-07-12</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/">window</a> / <span class="cur">keyboard_modifiers.md</span></nav>
<span class="view-stats"><span>832 B</span><span>30 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/44dfc2922a05ae1fb138e1befd539a8c10d382eb/docs/config/lua/window/keyboard_modifiers.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>window:keyboard_modifiers()</h1>
<p>{{since('20230712-072601-f4abf8fd')}}</p>
<p>Returns two values; the keyboard modifiers and the key status leds.</p>
<p>Both values are exposed to lua as strings with <code>|</code>-delimited values
representing the various modifier keys and keyboard led states:</p>
<ul>
<li>Modifiers - is the same form as keyboard assignment modifiers</li>
<li>Leds - possible flags are <code>"CAPS_LOCK"</code> and <code>"NUM_LOCK"</code>. Note that macOS
doesn't have a num lock concept.</li>
</ul>
<p>This example shows the current modifier and led status in the right status
area:</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-v>wezterm</a-v><a-p>.</a-p><a-f>config_builder</a-f><a-p>()</a-p>

<a-v>config</a-v><a-p>.</a-p><a-v>debug_key_events</a-v> = <a-co>true</a-co>

<a-v>wezterm</a-v><a-p>.</a-p><a-f>on</a-f><a-p>(</a-p><a-s>&#39;update-status&#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-k>local</a-k> <a-v>mods</a-v><a-p>,</a-p> <a-v>leds</a-v> = <a-v>window</a-v><a-p>:</a-p><a-f>keyboard_modifiers</a-f><a-p>()</a-p>
  <a-v>window</a-v><a-p>:</a-p><a-f>set_right_status</a-f><a-p>(</a-p><a-s>&#39;mods=&#39;</a-s> <a-o>..</a-o> <a-v>mods</a-v> <a-o>..</a-o> <a-s>&#39; leds=&#39;</a-s> <a-o>..</a-o> <a-v>leds</a-v><a-p>)</a-p>
<a-k>end</a-k><a-p>)</a-p>

<a-k>return</a-k> <a-v>config</a-v></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> <a-tt>window:keyboard_modifiers()</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;20230712-072601-f4abf8fd&#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">Returns two values; the keyboard modifiers and the key status leds.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">Both values are exposed to lua as strings with `|`-delimited values</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">representing the various modifier keys and keyboard led states:</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>Modifiers - is the same form as keyboard assignment modifiers</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>Leds - possible flags are `&quot;CAPS_LOCK&quot;` and `&quot;NUM_LOCK&quot;`. Note that macOS</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>doesn&#39;t have a num lock concept.</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"><a-p>This example shows the current modifier and led status in the right status</a-p></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>area:</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"></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-tl>lua</a-tl></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>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="L19" href="#L19">19</a><span class="code-text"></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>local </a-p><a-v>config</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-f>config_builder</a-f><a-p>()</a-p></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>config.</a-p><a-v>debug_key_events</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="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>wezterm.</a-p><a-f>on</a-f><a-p>(</a-p><a-s>&#39;update-status&#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></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-k>local</a-k><a-p> </a-p><a-v>mods</a-v><a-p>, </a-p><a-v>leds</a-v><a-p> = </a-p><a-v>window</a-v><a-p>:</a-p><a-f>keyboard_modifiers</a-f><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-v>window</a-v><a-p>:</a-p><a-f>set_right_status</a-f><a-p>(</a-p><a-s>&#39;mods=&#39;</a-s><a-p> </a-p><a-o>..</a-o><a-p> </a-p><a-v>mods</a-v><a-p> </a-p><a-o>..</a-o><a-p> </a-p><a-s>&#39; leds=&#39;</a-s><a-p> </a-p><a-o>..</a-o><a-p> </a-p><a-v>leds</a-v><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"></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>return </a-p><a-v>config</a-v></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></span></span></pre></div></div>
</main>
</body>
</html>
