Core LibrarystableAPI Reference

Choose documentation 3

stable

Current version

stable
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Python API

method libtmux stable

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
PowerShell Julia Ruby Lua TypeScript Rust Go Java C# C++ Swift Kotlin Scala F#
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 display-popup

In other ports Open a popup over the client showing a pane
  • 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
  • Rust
    no equivalent on Pane
  • Go
  • Java
    no equivalent on Pane
  • C#
  • C++
    no equivalent on Pane
  • Swift
    no equivalent on Pane
  • 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.
Esc

Type to search.

Reference preview Open reference