<!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.gui/get_appearance.md - fork/wezterm @ termiz-0.23.1</title>
<meta name="description" content="docs/config/lua/wezterm.gui/get_appearance.md in fork/wezterm at termiz-0.23.1.">
<meta property="og:title" content="docs/config/lua/wezterm.gui/get_appearance.md - fork/wezterm @ termiz-0.23.1">
<meta property="og:description" content="docs/config/lua/wezterm.gui/get_appearance.md in fork/wezterm at termiz-0.23.1.">
<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.1" data-tip="7053748e4d899e7fc5e202d6f903b052fc78e759">
<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="889390a448133d2ab70c1c541180df3eb4d39f63">docs: update gui.get_appearance example for mux</span><span class="snapshot-sha sha" data-commit="889390a448133d2ab70c1c541180df3eb4d39f63">889390a44</span><time datetime="2023-04-06T15:55:20-07:00" title="2023-04-06 15:55:20 -0700">2023-04-06</time></p>
<header class="topbar"><details class="switcher"><summary>termiz-0.23.1</summary><div class="menu"><strong>branches</strong><a href="/fork/wezterm/ref/main/">main</a><strong>tags</strong><a class="current" 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 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.1/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termiz-0.23.1/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termiz-0.23.1/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termiz-0.23.1/tree/docs/config/lua/wezterm.gui/">wezterm.gui</a> / <span class="cur">get_appearance.md</span></nav>
<span class="view-stats"><span>1.5 KiB</span><span>49 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/2aed20177eb4636d850d2b5764b386348dc66a4e/docs/config/lua/wezterm.gui/get_appearance.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>wezterm.gui.get_appearance()</code></h1>
<p>{{since('20220807-113146-c2fee766')}}</p>
<p>This function returns the appearance of the window environment.  The appearance
can be one of the following 4 values:</p>
<ul>
<li><code>"Light"</code> - the normal appearance, with dark text on a light background</li>
<li><code>"Dark"</code> - "dark mode", with predominantly dark colors and probably a lighter, lower contrasting, text color on a dark background</li>
<li><code>"LightHighContrast"</code> - light mode but with high contrast colors (not reported on all systems)</li>
<li><code>"DarkHighContrast"</code> - dark mode but with high contrast colors (not reported on all systems)</li>
</ul>
<p>wezterm is able to detect when the appearance has changed and will reload the
configuration when that happens.</p>
<p>This example configuration shows how you can have your color scheme
automatically adjust to the current appearance:</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-c>-- wezterm.gui is not available to the mux server, so take care to</a-c>
<a-c>-- do something reasonable when this config is evaluated by the mux</a-c>
<a-k>function</a-k> <a-f>get_appearance</a-f><a-p>()</a-p>
  <a-k>if</a-k> <a-v>wezterm</a-v><a-p>.</a-p><a-v>gui</a-v> <a-k>then</a-k>
    <a-k>return</a-k> <a-v>wezterm</a-v><a-p>.</a-p><a-v>gui</a-v><a-p>.</a-p><a-f>get_appearance</a-f><a-p>()</a-p>
  <a-k>end</a-k>
  <a-k>return</a-k> <a-s>&#39;Dark&#39;</a-s>
<a-k>end</a-k>

<a-k>function</a-k> <a-f>scheme_for_appearance</a-f><a-p>(</a-p><a-v>appearance</a-v><a-p>)</a-p>
  <a-k>if</a-k> <a-v>appearance</a-v><a-p>:</a-p><a-f>find</a-f> <a-s>&#39;Dark&#39;</a-s> <a-k>then</a-k>
    <a-k>return</a-k> <a-s>&#39;Builtin Solarized Dark&#39;</a-s>
  <a-k>else</a-k>
    <a-k>return</a-k> <a-s>&#39;Builtin Solarized Light&#39;</a-s>
  <a-k>end</a-k>
<a-k>end</a-k>

<a-k>return</a-k> <a-cr>{</a-cr>
  <a-v>color_scheme</a-v> = <a-f>scheme_for_appearance</a-f><a-p>(</a-p><a-f>get_appearance</a-f><a-p>()),</a-p>
<a-cr>}</a-cr></pre>
<h3>Wayland GNOME Appearance</h3>
<p>wezterm uses <a href="https://flatpak.github.io/xdg-desktop-portal/">XDG Desktop
Portal</a> to determine the
appearance in a desktop-environment independent way.</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>`wezterm.gui.get_appearance()`</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;20220807-113146-c2fee766&#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">This function returns the appearance of the window environment.  The appearance</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">can be one of the following 4 values:</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>`&quot;Light&quot;` - the normal appearance, with dark text on a light background</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>* </a-p>`&quot;Dark&quot;` - &quot;dark mode&quot;, with predominantly dark colors and probably a lighter, lower contrasting, text color on a dark background</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>`&quot;LightHighContrast&quot;` - light mode but with high contrast colors (not reported on all systems)</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;DarkHighContrast&quot;` - dark mode but with high contrast colors (not reported on all systems)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></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>wezterm is able to detect when the appearance has changed and will reload the</a-p></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>configuration when that happens.</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"></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>This example configuration shows how you can have your color scheme</a-p></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>automatically adjust to the current appearance:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></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-tl>lua</a-tl></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>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="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>-- wezterm.gui is not available to the mux server, so take care to</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>-- do something reasonable when this config is evaluated by the mux</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>function </a-p><a-f>get_appearance</a-f><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>if</a-k><a-p> </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>gui</a-v><a-p> </a-p><a-k>then</a-k></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-v>wezterm</a-v><a-p>.</a-p><a-v>gui</a-v><a-p>.</a-p><a-f>get_appearance</a-f><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>  </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-k>return</a-k><a-p> </a-p><a-s>&#39;Dark&#39;</a-s></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>end</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"></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>function </a-p><a-f>scheme_for_appearance</a-f><a-p>(</a-p><a-v>appearance</a-v><a-p>)</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><a-k>if</a-k><a-p> </a-p><a-v>appearance</a-v><a-p>:</a-p><a-f>find</a-f><a-p> </a-p><a-s>&#39;Dark&#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="L33" href="#L33">33</a><span class="code-text"><a-p>    </a-p><a-k>return</a-k><a-p> </a-p><a-s>&#39;Builtin Solarized Dark&#39;</a-s></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>  </a-p><a-k>else</a-k></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-k>return</a-k><a-p> </a-p><a-s>&#39;Builtin Solarized Light&#39;</a-s></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-k>end</a-k></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>end</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"></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>return </a-p><a-cr>{</a-cr></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>color_scheme</a-v><a-p> = </a-p><a-f>scheme_for_appearance</a-f><a-p>(</a-p><a-f>get_appearance</a-f><a-p>()),</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"><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></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-tt>Wayland GNOME Appearance</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text">wezterm uses [XDG Desktop</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text">Portal](https://flatpak.github.io/xdg-desktop-portal/) to determine the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text">appearance in a desktop-environment independent way.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
