1
1
mirror of https://github.com/wez/wezterm.git synced 2025-01-04 11:42:53 +03:00
wezterm/docs/config/lua/window/leader_is_active.md
2023-03-20 22:54:27 -07:00

30 lines
669 B
Markdown

# wezterm:leader_is_active()
{{since('20220319-142410-0fcdea07')}}
Returns `true` if the [Leader Key](../../keys.md) is active in the window, or false otherwise.
This example shows `LEADER` in the right status area, and turns the cursor orange,
when the leader is active:
```lua
local wezterm = require 'wezterm'
wezterm.on('update-right-status', function(window, pane)
local leader = ''
if window:leader_is_active() then
leader = 'LEADER'
end
window:set_right_status(leader)
end)
return {
leader = { key = 'a', mods = 'CTRL' },
colors = {
compose_cursor = 'orange',
},
}
```
See also: [window:composition_status()](composition_status.md).