Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

struct libtmux-go latest

DisplayMenuRequest

DisplayMenuRequest configures one tmux popup menu. Position and style strings retain tmux's format and symbolic-position languages verbatim. Its zero value is invalid because Items is required. All pointer fields omit their flags when nil and retain explicit empty strings; DisplayMenu copies Items before calling tmux. TargetPane and TargetClient are independent but must be stable identities when present.

Source and package
Qualified name
tmux.DisplayMenuRequest
Package
tmux
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/server_interactive.go
struct tmux.DisplayMenuRequest

Fields13#

DisplayMenuRequest fields
NameTypeDescription
BorderLines *string BorderLines selects border glyphs and requires tmux 3.4; see UnsupportedPolicy.
BorderStyle *string BorderStyle selects border style and requires tmux 3.4; see UnsupportedPolicy.
Items []MenuItem Items are menu rows; a zero MenuItem is a separator.
Mouse bool Mouse enables mouse selection and requires tmux 3.5; see UnsupportedPolicy.
SelectedStyle *string SelectedStyle selects highlighted-item style and requires tmux 3.4; see UnsupportedPolicy.
StartingChoice *string StartingChoice selects the initial item and requires tmux 3.4; see UnsupportedPolicy.
StayOpen bool StayOpen keeps the menu visible after selecting an item.
Style *string Style selects menu style and requires tmux 3.4; see UnsupportedPolicy.
TargetClient ClientName TargetClient selects the client that renders the menu.
TargetPane PaneID TargetPane supplies pane context for format expansion.
Title *string Title is the optional menu title.
X *string X is tmux's horizontal position expression.
Y *string Y is tmux's vertical position expression.
Esc

Type to search.

Reference previewOpen reference