<!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-events/update-right-status.md - fork/wezterm @ termwiz-0.23.1</title>
<meta name="description" content="docs/config/lua/window-events/update-right-status.md in fork/wezterm at termwiz-0.23.1.">
<meta property="og:title" content="docs/config/lua/window-events/update-right-status.md - fork/wezterm @ termwiz-0.23.1">
<meta property="og:description" content="docs/config/lua/window-events/update-right-status.md in fork/wezterm at termwiz-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="termwiz-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="40081cb5737da32058a3c87e14b84d8f2bfefdc4">docs: update a bunch of since lines to new macro</span><span class="snapshot-sha sha" data-commit="40081cb5737da32058a3c87e14b84d8f2bfefdc4">40081cb57</span><time datetime="2023-03-20T22:01:24-07:00" title="2023-03-20 22:01:24 -0700">2023-03-20</time></p>
<header class="topbar"><details class="switcher"><summary>termwiz-0.23.1</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 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 class="current" 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/termwiz-0.23.1/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termwiz-0.23.1/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termwiz-0.23.1/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termwiz-0.23.1/tree/docs/config/lua/window-events/">window-events</a> / <span class="cur">update-right-status.md</span></nav>
<span class="view-stats"><span>1.2 KiB</span><span>30 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/52ed4991b96f356e43a32216c4582e7d53ad4184/docs/config/lua/window-events/update-right-status.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>update-right-status</code></h1>
<p>{{since('20210314-114017-04b7cedd')}}</p>
<p>The <code>update-right-status</code> event is emitted periodically (based on the
interval specified by the <a href="/fork/wezterm/ref/termwiz-0.23.1/blob/docs/config/lua/config/status_update_interval.md">status_update_interval</a>
configuration value).</p>
<p>There is no defined return value for the event, but its purpose is to allow
you the chance to carry out some activity and then ultimately call
<a href="/fork/wezterm/ref/termwiz-0.23.1/blob/docs/config/lua/window/set_right_status.md">window:set_right_status</a>.</p>
<p>The first event parameter is a <a href="../window/index.md"><code>window</code> object</a> that
represents the gui window.</p>
<p>The second event parameter is a <a href="../pane/index.md"><code>pane</code> object</a> that
represents the active pane in that window.</p>
<p><code>wezterm</code> will ensure that only a single instance of this event is outstanding;
if the hook takes longer than the
<a href="/fork/wezterm/ref/termwiz-0.23.1/blob/docs/config/lua/config/status_update_interval.md">status_update_interval</a> to complete,
<code>wezterm</code> won't schedule another call until <code>status_update_interval</code>
milliseconds have elapsed since the last call completed.</p>
<p>{{since('20220903-194523-3bb1ed61')}}</p>
<p>This event is considered to be deprecated and you should migrate
to using <a href="/fork/wezterm/ref/termwiz-0.23.1/blob/docs/config/lua/window-events/update-status.md">update-status</a>, which behaves the
same way, but doesn't overly focus on the right status area.</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>`update-right-status`</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;20210314-114017-04b7cedd&#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">The `update-right-status` event is emitted periodically (based on the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">interval specified by the [status_update_interval](../config/status_update_interval.md)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">configuration 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">There is no defined return value for the event, but its purpose is to allow</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">you the chance to carry out some activity and then ultimately call</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">[window:set_right_status](../window/set_right_status.md).</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">The first event parameter is a [`window` object](../window/index.md) that</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">represents the gui window.</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">The second event parameter is a [`pane` object](../pane/index.md) that</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">represents the active pane in that window.</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">`wezterm` will ensure that only a single instance of this event is outstanding;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">if the hook takes longer than the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text">[status_update_interval](../config/status_update_interval.md) to complete,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">`wezterm` won&#39;t schedule another call until `status_update_interval`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">milliseconds have elapsed since the last call completed.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</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="L26" href="#L26">26</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text">This event is considered to be deprecated and you should migrate</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text">to using [update-status](update-status.md), which behaves the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">same way, but doesn&#39;t overly focus on the right status area.</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></pre></div></div>
</main>
</body>
</html>
