libtmux Reference MCP Search
On this page

server.interactive.Server.display_menu

View as Markdown

Module
server.interactive
Declared in
Server
Package
libtmux
Source
crates/libtmux/src/server/interactive.rs
display_menu ( self , client : Option<&Client> , title : &str , items : impl IntoIterator<Item = (String, String, String)> ) Result<(), Error>
method [source]
method [source]
display_menu

Show a menu over a client.

Items are (label, key, command) triples in the order tmux should show them. This needs a client with a terminal.

Like Self::command_prompt, this waits for the person: tmux holds the invocation until an item is chosen or the menu is dismissed, and the dispatch timeout is what ends the wait when nobody does.

Errors

Returns Error::ServerMismatch when the client belongs to another server, or an error when no suitable client exists, when tmux refuses an item, and when the dispatch timeout expires before anyone chooses.

0 declared, 0 inherited

Esc

Type to search.