Skip to content

Commit 3412dd5

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 e09ef20 commit 3412dd5

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
@@ -84,6 +84,24 @@ Added experimental `waiter.py` module for polling for terminal content in tmux p
8484
- Enhanced error handling with detailed timeouts and match information
8585
- Robust shell prompt detection
8686

87+
#### Hooks
88+
89+
Added {class}`hooks.HooksMixin` for managing tmux hooks programmatically:
90+
91+
- {meth}`~hooks.HooksMixin.set_hook` - Set a hook with optional index
92+
- {meth}`~hooks.HooksMixin.show_hook` - Show current value of a hook
93+
- {meth}`~hooks.HooksMixin.unset_hook` - Remove a hook
94+
95+
Bulk operations API for managing indexed hooks:
96+
97+
- {meth}`~hooks.HooksMixin.get_hook_indices` - Get list of indices that exist for a hook
98+
- {meth}`~hooks.HooksMixin.get_hook_values` - Get all indexed values as SparseArray
99+
- {meth}`~hooks.HooksMixin.set_hooks_bulk` - Set multiple indexed hooks at once
100+
- {meth}`~hooks.HooksMixin.clear_hook` - Unset all indexed values for a hook
101+
- {meth}`~hooks.HooksMixin.append_hook` - Append at next available index
102+
103+
HooksMixin is available on {class}`Server`, {class}`Session`, {class}`Window`, and {class}`Pane`.
104+
87105
## libtmux 0.47.0 (2025-11-01)
88106

89107
### Breaking changes

0 commit comments

Comments
 (0)