wez/wezterm
1
1
Fork 0
mirror of https://github.com/wez/wezterm.git synced 2024-12-28 07:55:03 +03:00
Code Issues Projects Releases Wiki Activity
173862634e
wezterm/docs/config/lua/window-events/update-right-status.md
Wez Furlong ecd7bc9842 docs: update for latest release
2022-09-03 20:54:27 -07:00

1.2 KiB
Raw Blame History

update-right-status

Since: 20210314-114017-04b7cedd

The update-right-status event is emitted periodically (based on the interval specified by the status_update_interval configuration value).

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 window:set_right_status.

The first event parameter is a window object that represents the gui window.

The second event parameter is a pane object that represents the active pane in that window.

wezterm will ensure that only a single instance of this event is outstanding; if the hook takes longer than the status_update_interval to complete, wezterm won't schedule another call until status_update_interval milliseconds have elapsed since the last call completed.

Since: 20220903-194523-3bb1ed61

This event is considered to be deprecated and you should migrate to using update-status, which behaves the same way, but doesn't overly focus on the right status area.