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.

method libtmux latest

Pane.display_popup

Display a popup overlay via $ tmux display-popup.

Source and package
Qualified name
libtmux.Pane.display_popup
Module
libtmux
Declared in
Pane
Package
libtmux
Source
src/libtmux/pane.py
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Ruby Lua TypeScript Rust Go Java C# C++ Swift Kotlin Scala OCaml F# Clojure
display_popup
( 19 parameters ) ( self, command: str | None = None, close_on_exit: bool | None = None, close_on_success: bool | None = None, close_existing: bool | None = None, target_client: str | None = None, width: int | str | None = None, height: int | str | None = None, x: int | str | None = None, y: int | str | None = None, start_directory: StrPath | None = None, title: str | None = None, border_lines: str | None = None, style: str | None = None, border_style: str | None = None, environment: dict[str, str] | None = None, no_border: bool | None = None, close_on_any_key: bool | None = None, no_keys: bool | None = None, )
→ None

Description#

Requires tmux 3.2+ and an attached client. Use ControlMode in tests to provide a client.

Examples#

Not directly testable — popup rendering requires a TTY-backed client. Control-mode provides an attached client for invocation but the popup itself is not visible or verifiable.

>>> with control_mode() as ctl:
... pane.display_popup(command='true', close_on_exit=True)
Parameters

tmux command#

The tmux commands behind display_popup.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Open a popup over the client showing a pane

Equivalents of Open a popup over the client showing a pane in other languages
Language Equivalent
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript pane.Pane.displayPopup
Rust no equivalent on Pane
Go tmux.Pane.DisplayPopup
Java no equivalent on Pane
C# LibTmux.Pane.DisplayPopupAsync
C++ no equivalent on Pane
Swift no equivalent on Pane
OCaml No direct public OCaml equivalent is recorded for this operation.
Perl No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

No equivalent is recorded in Ruby, Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Esc

Type to search.

Reference previewOpen reference