Python API

method libtmux stable

Server.display_menu

Display a popup menu via $ tmux display-menu.

Source and package

Qualified name: libtmux.Server.display_menu
Module: libtmux
Declared in: Server
Package: libtmux
Source: src/libtmux/server.py
Other languages: PowerShell Julia Ruby Lua TypeScript RustGo Java C# C++ Swift Kotlin Scala F#

Description#

Requires a TTY-backed attached client. Control-mode clients have tty.sy=0, which causes menu_prepare() to return NULL. This method cannot be tested with ControlMode .

Examples#

Cannot run end-to-end (requires a TTY-backed client; see the tty.sy=0 note above). For broader coverage, see tests/test_server.py::test_display_menu_flags.

>>> captured = []
>>> def fake_cmd(name, *args, **_kw):
...     captured.append((name, args))
...     return type('R', (), {'stderr': [], 'stdout': []})()
>>> monkeypatch.setattr(server, 'cmd', fake_cmd)
>>> server.display_menu('First', '1', 'select-pane', title='menu')
>>> captured[0][0]
'display-menu'

Parameters

items (str) #
title (str | None) # – Menu title (-T flag).
target_pane (str | None) # – Target pane for format expansion (-t flag).
target_client (str | None) # – Target client (-c flag).
x (int | str | None) # – Menu x position (-x flag).
y (int | str | None) # – Menu y position (-y flag).
starting_choice (int | str | None) # – Pre-selected item index (-C flag). Use - for none. Requires tmux 3.4+.
border_lines (str | None) # – Border line style (-b flag). Requires tmux 3.4+.
style (str | None) # – Menu style (-s flag). Requires tmux 3.4+.
border_style (str | None) # – Border style (-S flag). Requires tmux 3.4+.
selected_style (str | None) # – Style for the currently selected menu item (-H flag). Requires tmux 3.4+.
mouse (bool | None) # – Always enable mouse handling in the menu (-M flag). Requires tmux 3.5+.
stay_open (bool | None) # – Keep the menu open when the mouse is released (-O flag). Requires tmux 3.2+.

tmux command display-menu

In other ports Show a menu over a client

PowerShell
No source-verified PowerShell equivalent is recorded for this operation.
Julia
No source-verified Julia equivalent is recorded for this operation.
Ruby
No source-verified Ruby equivalent is recorded for this operation.
Lua
No source-verified Lua equivalent is recorded for this operation.
TypeScript
no equivalent on Server
Rust
server.Server.display_menu
Go
tmux.Server.DisplayMenu
Java
no equivalent on Server
C#
no equivalent on Server
C++
no equivalent on Server
Swift
no equivalent on Server
Kotlin
No source-verified Kotlin equivalent is recorded for this operation.
Scala
No source-verified Scala equivalent is recorded for this operation.
F#
No source-verified F# equivalent is recorded for this operation.

Scripting & web

Compiled & native

JVM

.NET

tmux

Server.display_menu

Description#

Examples#

Description#

Examples#

Related types#