Skip to content

Commit 50434ee

Browse files
committed
docs(CHANGES): add HooksMixin to new features
why: HooksMixin feature was built but not documented in CHANGES. what: - Add HooksMixin section under "New features" - Document hook methods: set_hook, show_hook, unset_hook - Document bulk operations: get_hook_indices, get_hook_values, set_hooks_bulk, clear_hook, append_hook - Note HooksMixin availability on Server, Session, Window, Pane
1 parent 5f47ed6 commit 50434ee

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

CHANGES

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,24 @@ Added tmux 3.6 to test grid and `TMUX_MAX_VERSION` 3.4 -> 3.6.
9595
- `suppress_warnings`: `-q`
9696
- `append`: `-a`
9797

98+
#### Hooks
99+
100+
Added {class}`hooks.HooksMixin` for managing tmux hooks programmatically:
101+
102+
- {meth}`~hooks.HooksMixin.set_hook` - Set a hook with optional index
103+
- {meth}`~hooks.HooksMixin.show_hook` - Show current value of a hook
104+
- {meth}`~hooks.HooksMixin.unset_hook` - Remove a hook
105+
106+
Bulk operations API for managing indexed hooks:
107+
108+
- {meth}`~hooks.HooksMixin.get_hook_indices` - Get list of indices that exist for a hook
109+
- {meth}`~hooks.HooksMixin.get_hook_values` - Get all indexed values as SparseArray
110+
- {meth}`~hooks.HooksMixin.set_hooks_bulk` - Set multiple indexed hooks at once
111+
- {meth}`~hooks.HooksMixin.clear_hook` - Unset all indexed values for a hook
112+
- {meth}`~hooks.HooksMixin.append_hook` - Append at next available index
113+
114+
HooksMixin is available on {class}`Server`, {class}`Session`, {class}`Window`, and {class}`Pane`.
115+
98116
## libtmux 0.47.0 (2025-11-01)
99117

100118
### Breaking changes

0 commit comments

Comments
 (0)