<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/config/window_frame.md - fork/wezterm @ main</title>
<meta name="description" content="docs/config/lua/config/window_frame.md in fork/wezterm at main.">
<meta property="og:title" content="docs/config/lua/config/window_frame.md - fork/wezterm @ main">
<meta property="og:description" content="docs/config/lua/config/window_frame.md in fork/wezterm at main.">
<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="main" data-tip="9c883a71b8b60323047762d8b47ae44f101773c6">
<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">Glenn Waters</span><span class="commit-message" data-commit="888366a15d48b0f8c1d815060baf8c48dd237aa9">Add missing docs, fix typo, bring to attention error. (#5150)</span><span class="snapshot-sha sha" data-commit="888366a15d48b0f8c1d815060baf8c48dd237aa9">888366a15</span><time datetime="2024-05-05T16:47:14-04:00" title="2024-05-05 16:47:14 -0400">2024-05-05</time></p>
<header class="topbar"><details class="switcher"><summary>main</summary><div class="menu"><strong>branches</strong><a class="current" 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 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/main/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/main/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/main/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/main/tree/docs/config/lua/config/">config</a> / <span class="cur">window_frame.md</span></nav>
<span class="view-stats"><span>1.3 KiB</span><span>56 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/e14838c9a79a8f237cf987e3e9a20853c88ffea7/docs/config/lua/config/window_frame.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>tags:</p>
<ul>
<li>appearance</li>
</ul>
<hr />
<h1><code>window_frame</code></h1>
<p>{{since('20210814-124438-54e29167')}}</p>
<p>This setting is applicable primarily on Wayland systems when client side
decorations are in use.</p>
<p>It allows you to customize the colors of the window frame.</p>
<p>Some of these colors are used by the fancy tab bar.</p>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>window_frame</a-v> = <a-cr>{</a-cr>
  <a-v>inactive_titlebar_bg</a-v> = <a-s>&#39;#353535&#39;</a-s><a-p>,</a-p>
  <a-v>active_titlebar_bg</a-v> = <a-s>&#39;#2b2042&#39;</a-s><a-p>,</a-p>
  <a-v>inactive_titlebar_fg</a-v> = <a-s>&#39;#cccccc&#39;</a-s><a-p>,</a-p>
  <a-v>active_titlebar_fg</a-v> = <a-s>&#39;#ffffff&#39;</a-s><a-p>,</a-p>
  <a-v>inactive_titlebar_border_bottom</a-v> = <a-s>&#39;#2b2042&#39;</a-s><a-p>,</a-p>
  <a-v>active_titlebar_border_bottom</a-v> = <a-s>&#39;#2b2042&#39;</a-s><a-p>,</a-p>
  <a-v>button_fg</a-v> = <a-s>&#39;#cccccc&#39;</a-s><a-p>,</a-p>
  <a-v>button_bg</a-v> = <a-s>&#39;#2b2042&#39;</a-s><a-p>,</a-p>
  <a-v>button_hover_fg</a-v> = <a-s>&#39;#ffffff&#39;</a-s><a-p>,</a-p>
  <a-v>button_hover_bg</a-v> = <a-s>&#39;#3b3052&#39;</a-s><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<p>{{since('20220903-194523-3bb1ed61')}}</p>
<p>You may explicitly add a border around the window area:</p>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>window_frame</a-v> = <a-cr>{</a-cr>
  <a-v>border_left_width</a-v> = <a-s>&#39;0.5cell&#39;</a-s><a-p>,</a-p>
  <a-v>border_right_width</a-v> = <a-s>&#39;0.5cell&#39;</a-s><a-p>,</a-p>
  <a-v>border_bottom_height</a-v> = <a-s>&#39;0.25cell&#39;</a-s><a-p>,</a-p>
  <a-v>border_top_height</a-v> = <a-s>&#39;0.25cell&#39;</a-s><a-p>,</a-p>
  <a-v>border_left_color</a-v> = <a-s>&#39;purple&#39;</a-s><a-p>,</a-p>
  <a-v>border_right_color</a-v> = <a-s>&#39;purple&#39;</a-s><a-p>,</a-p>
  <a-v>border_bottom_color</a-v> = <a-s>&#39;purple&#39;</a-s><a-p>,</a-p>
  <a-v>border_top_color</a-v> = <a-s>&#39;purple&#39;</a-s><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<p>You may specify the font and font size for the tabbar:</p>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>window_frame</a-v> = <a-cr>{</a-cr>
  <a-v>font</a-v> = <a-f>require</a-f><a-p>(</a-p><a-s>&#39;wezterm&#39;</a-s><a-p>).</a-p><a-f>font</a-f> <a-s>&#39;Roboto&#39;</a-s><a-p>,</a-p>
  <a-v>font_size</a-v> = <a-n>12</a-n><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<p>The default font is <code>Roboto</code>. The default font_size is <code>10pt</code> on Windows and <code>12pt</code> on other systems.</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></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>tags</a-pr><a-p>:</a-p></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-p>-</a-p> <a-s>appearance</a-s></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></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-tt>`window_frame`</a-tt></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">{{since(&#39;20210814-124438-54e29167&#39;)}}</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">This setting is applicable primarily on Wayland systems when client side</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">decorations are in use.</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">It allows you to customize the colors of the window frame.</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">Some of these colors are used by the fancy tab bar.</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>```</a-p><a-tl>lua</a-tl></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>config.</a-p><a-v>window_frame</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="L18" href="#L18">18</a><span class="code-text"><a-p>  </a-p><a-v>inactive_titlebar_bg</a-v><a-p> = </a-p><a-s>&#39;#353535&#39;</a-s><a-p>,</a-p></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-v>active_titlebar_bg</a-v><a-p> = </a-p><a-s>&#39;#2b2042&#39;</a-s><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-v>inactive_titlebar_fg</a-v><a-p> = </a-p><a-s>&#39;#cccccc&#39;</a-s><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"><a-p>  </a-p><a-v>active_titlebar_fg</a-v><a-p> = </a-p><a-s>&#39;#ffffff&#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>inactive_titlebar_border_bottom</a-v><a-p> = </a-p><a-s>&#39;#2b2042&#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>active_titlebar_border_bottom</a-v><a-p> = </a-p><a-s>&#39;#2b2042&#39;</a-s><a-p>,</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><a-v>button_fg</a-v><a-p> = </a-p><a-s>&#39;#cccccc&#39;</a-s><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-v>button_bg</a-v><a-p> = </a-p><a-s>&#39;#2b2042&#39;</a-s><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>button_hover_fg</a-v><a-p> = </a-p><a-s>&#39;#ffffff&#39;</a-s><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-v>button_hover_bg</a-v><a-p> = </a-p><a-s>&#39;#3b3052&#39;</a-s><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>}</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>```</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>{{since(&#39;20220903-194523-3bb1ed61&#39;)}}</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"></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>You may explicitly add a border around the window area:</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"></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-tl>lua</a-tl></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>config.</a-p><a-v>window_frame</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="L37" href="#L37">37</a><span class="code-text"><a-p>  </a-p><a-v>border_left_width</a-v><a-p> = </a-p><a-s>&#39;0.5cell&#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>border_right_width</a-v><a-p> = </a-p><a-s>&#39;0.5cell&#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>border_bottom_height</a-v><a-p> = </a-p><a-s>&#39;0.25cell&#39;</a-s><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>border_top_height</a-v><a-p> = </a-p><a-s>&#39;0.25cell&#39;</a-s><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><a-v>border_left_color</a-v><a-p> = </a-p><a-s>&#39;purple&#39;</a-s><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-v>border_right_color</a-v><a-p> = </a-p><a-s>&#39;purple&#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>border_bottom_color</a-v><a-p> = </a-p><a-s>&#39;purple&#39;</a-s><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-v>border_top_color</a-v><a-p> = </a-p><a-s>&#39;purple&#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></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"></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>You may specify the font and font size for the tabbar:</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-tl>lua</a-tl></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>config.</a-p><a-v>window_frame</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="L51" href="#L51">51</a><span class="code-text"><a-p>  </a-p><a-v>font</a-v><a-p> = </a-p><a-f>require</a-f><a-p>(</a-p><a-s>&#39;wezterm&#39;</a-s><a-p>).</a-p><a-f>font</a-f><a-p> </a-p><a-s>&#39;Roboto&#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>font_size</a-v><a-p> = </a-p><a-n>12</a-n><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></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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text">The default font is `Roboto`. The default font_size is `10pt` on Windows and `12pt` on other systems.</span></span></pre></div></div>
</main>
</body>
</html>
