<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/keyassignment/CharSelect.md - fork/wezterm @ termiz-0.23.2</title>
<meta name="description" content="docs/config/lua/keyassignment/CharSelect.md in fork/wezterm at termiz-0.23.2.">
<meta property="og:title" content="docs/config/lua/keyassignment/CharSelect.md - fork/wezterm @ termiz-0.23.2">
<meta property="og:description" content="docs/config/lua/keyassignment/CharSelect.md in fork/wezterm at termiz-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="termiz-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">mgpinf</span><span class="commit-message" data-commit="9606fa256904c337e705d2ff67cde78dc410a66f">Add font configuration option for ActivateCommandPalette, CharSelect, PaneSelect (#6696)</span><span class="snapshot-sha sha" data-commit="9606fa256904c337e705d2ff67cde78dc410a66f">9606fa256</span><time datetime="2025-03-10T04:04:32+05:30" title="2025-03-10 04:04:32 +0530">2025-03-10</time></p>
<header class="topbar"><details class="switcher"><summary>termiz-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 class="current" 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 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.2/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termiz-0.23.2/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termiz-0.23.2/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termiz-0.23.2/tree/docs/config/lua/keyassignment/">keyassignment</a> / <span class="cur">CharSelect.md</span></nav>
<span class="view-stats"><span>2.8 KiB</span><span>79 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/3c2fe095d9774c6cc3d48198494ee4f91cae8dea/docs/config/lua/keyassignment/CharSelect.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>CharSelect</code></h1>
<p>{{since('20220903-194523-3bb1ed61')}}</p>
<p>Activates <em>Character Selection Mode</em>, which is a pop-over modal that allows you
to browse characters by category as well as fuzzy search by name or hex unicode
codepoint value.</p>
<p>Characters are categorized into the following groups:</p>
<ul>
<li><code>"RecentlyUsed"</code> - recently selected characters, ordered by <a href="https://en.wikipedia.org/wiki/Frecency">frecency</a></li>
<li><code>"SmileysAndEmotion"</code></li>
<li><code>"PeopleAndBody"</code></li>
<li><code>"AnimalsAndNature"</code></li>
<li><code>"FoodAndDrink"</code></li>
<li><code>"TravelAndPlaces"</code></li>
<li><code>"Activities"</code></li>
<li><code>"Objects"</code></li>
<li><code>"Symbols"</code></li>
<li><code>"Flags"</code></li>
<li><code>"NerdFonts"</code> - glyphs that are present in <a href="https://www.nerdfonts.com/cheat-sheet">Nerd Fonts</a></li>
<li><code>"UnicodeNames"</code> - all codepoints defined in unicode</li>
</ul>
<p>The following key assignments are available (they are not currently configurable):</p>
<table><thead><tr><th>Key</th><th>Action</th></tr></thead><tbody>
<tr><td>UpArrow</td><td>Move Up</td></tr>
<tr><td>DownArrow</td><td>Move Down</td></tr>
<tr><td>Enter</td><td>Accept the current item, copy it to the clipboard, insert it into the active pane, and cancel the modal</td></tr>
<tr><td>Esc</td><td>Cancel the modal</td></tr>
<tr><td>CTRL-g</td><td>Cancel the modal</td></tr>
<tr><td>CTRL-r</td><td>Cycle to the next group of characters</td></tr>
<tr><td>CTRL-SHIFT-r</td><td>Cycle to the previous group of characters</td></tr>
<tr><td>CTRL-u</td><td>Clear text input</td></tr>
</tbody></table>
<p>Typing a name or a hex unicode codepoint value will fuzzy search across all
possible groups (not just the current group) and filter the results.</p>
<p>This action is by default assigned to <code>CTRL-SHIFT-U</code> (<code>U</code> for <code>Unicode</code>).</p>
<p>The default assignment is equivalent to this config:</p>
<pre class="language-lua"><a-c>-- Control the size of the font.</a-c>
<a-c>-- Uses the same font as window_frame.font if char_select_font option is not set</a-c>
<a-c>-- char_select_font_size = 18.0,</a-c>

<a-v>config</a-v><a-p>.</a-p><a-v>keys</a-v> = <a-cr>{</a-cr>
  <a-cr>{</a-cr>
    <a-v>key</a-v> = <a-s>&#39;u&#39;</a-s><a-p>,</a-p>
    <a-v>mods</a-v> = <a-s>&#39;SHIFT|CTRL&#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>CharSelect</a-f> <a-cr>{</a-cr>
      <a-v>copy_on_select</a-v> = <a-co>true</a-co><a-p>,</a-p>
      <a-v>copy_to</a-v> = <a-s>&#39;ClipboardAndPrimarySelection&#39;</a-s><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>
<p>The <code>CharSelect</code> action accepts a lua table with the following fields:</p>
<ul>
<li><code>copy_on_select</code> - a boolean that controls whether hitting <code>Enter</code> to select
an item will copy to the clipboard, in addition to sending the item to the
active pane. The default is <code>true</code>, but you can set it to <code>false</code> if you
prefer.</li>
<li><code>copy_to</code> - allows you to control where the item will be copied to. Accepts
the same values as <a href="/fork/wezterm/ref/termiz-0.23.2/blob/docs/config/lua/keyassignment/CopyTo.md">CopyTo</a>. The default is
<code>'ClipboardAndPrimarySelection'</code>.</li>
<li><code>group</code> - an optional group to pre-select. You may use any of the groups
listed above (eg: <code>"SmileysAndEmotion"</code>). If omitted, wezterm will default to
<code>"RecentlyUsed"</code> if you have previously selected an item, or
<code>"SmileysAndEmotion"</code> otherwise.</li>
</ul>
<p>See also:</p>
<ul>
<li><a href="/fork/wezterm/ref/termiz-0.23.2/blob/docs/config/lua/config/char_select_font.md">char_select_font</a></li>
<li><a href="/fork/wezterm/ref/termiz-0.23.2/blob/docs/config/lua/config/char_select_font_size.md">char_select_font_size</a></li>
<li><a href="/fork/wezterm/ref/termiz-0.23.2/blob/docs/config/lua/config/char_select_fg_color.md">char_select_fg_color</a></li>
<li><a href="/fork/wezterm/ref/termiz-0.23.2/blob/docs/config/lua/config/char_select_bg_color.md">char_select_bg_color</a></li>
</ul>
</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>`CharSelect`</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;20220903-194523-3bb1ed61&#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">Activates *Character Selection Mode*, which is a pop-over modal that allows you</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">to browse characters by category as well as fuzzy search by name or hex unicode</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">codepoint value.</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">Characters are categorized into the following groups:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"></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>`&quot;RecentlyUsed&quot;` - recently selected characters, ordered by [frecency](https://en.wikipedia.org/wiki/Frecency)</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>`&quot;SmileysAndEmotion&quot;`</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>* </a-p>`&quot;PeopleAndBody&quot;`</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>* </a-p>`&quot;AnimalsAndNature&quot;`</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>* </a-p>`&quot;FoodAndDrink&quot;`</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>`&quot;TravelAndPlaces&quot;`</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>`&quot;Activities&quot;`</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;Objects&quot;`</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;Symbols&quot;`</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;Flags&quot;`</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>`&quot;NerdFonts&quot;` - glyphs that are present in [Nerd Fonts](https://www.nerdfonts.com/cheat-sheet)</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>`&quot;UnicodeNames&quot;` - all codepoints defined in unicode</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>The following key assignments are available (they are not currently configurable):</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>|Key             | Action |</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>|----------------|--------|</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>|UpArrow         |Move Up |</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>|DownArrow       |Move Down|</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"><a-p>|Enter           |Accept the current item, copy it to the clipboard, insert it into the active pane, and cancel the modal|</a-p></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>|Esc             |Cancel the modal|</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>|CTRL-g          |Cancel the modal|</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"><a-p>|CTRL-r          |Cycle to the next group of characters|</a-p></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>|CTRL-SHIFT-r    |Cycle to the previous group of characters|</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"><a-p>|CTRL-u          |Clear text input|</a-p></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"><a-p>Typing a name or a hex unicode codepoint value will fuzzy search across all</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>possible groups (not just the current group) and filter the results.</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"></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>This action is by default assigned to `CTRL-SHIFT-U` (`U` for `Unicode`).</a-p></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"><a-p>The default assignment is equivalent to this config:</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"></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-tl>lua</a-tl></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>-- Control the size of the font.</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>-- Uses the same font as window_frame.font if char_select_font option is not set</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>-- char_select_font_size = 18.0,</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"></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>config.</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="L50" href="#L50">50</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="L51" href="#L51">51</a><span class="code-text"><a-p>    </a-p><a-v>key</a-v><a-p> = </a-p><a-s>&#39;u&#39;</a-s><a-p>,</a-p></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-v>mods</a-v><a-p> = </a-p><a-s>&#39;SHIFT|CTRL&#39;</a-s><a-p>,</a-p></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>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>CharSelect</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="L54" href="#L54">54</a><span class="code-text"><a-p>      </a-p><a-v>copy_on_select</a-v><a-p> = </a-p><a-co>true</a-co><a-p>,</a-p></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-v>copy_to</a-v><a-p> = </a-p><a-s>&#39;ClipboardAndPrimarySelection&#39;</a-s><a-p>,</a-p></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-cr>}</a-cr><a-p>,</a-p></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-cr>}</a-cr><a-p>,</a-p></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></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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>The `CharSelect` action accepts a lua table with the following fields:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>* `copy_on_select` - a boolean that controls whether hitting `Enter` to select</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>  an item will copy to the clipboard, in addition to sending the item to the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>  active pane. The default is `true`, but you can set it to `false` if you</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p>  prefer.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"><a-p>* `copy_to` - allows you to control where the item will be copied to. Accepts</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>  the same values as [CopyTo](CopyTo.md). The default is</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>  `&#39;ClipboardAndPrimarySelection&#39;`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>* `group` - an optional group to pre-select. You may use any of the groups</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>  listed above (eg: `&quot;SmileysAndEmotion&quot;`). If omitted, wezterm will default to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>  `&quot;RecentlyUsed&quot;` if you have previously selected an item, or</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>  `&quot;SmileysAndEmotion&quot;` otherwise.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>See also:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>* [char_select_font](../config/char_select_font.md)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>* [char_select_font_size](../config/char_select_font_size.md)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>* [char_select_fg_color](../config/char_select_fg_color.md)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>* </a-p>[char_select_bg_color](../config/char_select_bg_color.md)</span></span></pre></div></div>
</main>
</body>
</html>
