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#
-
Description#
Requires tmux 3.2+ and an attached client. Use
ControlModein 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
-
-
close_on_exit(bool | None) # – Close popup when command exits (-Eflag). -
close_on_success(bool | None) # – Close popup only on success exit code (-EEflag, passing-Etwice). -
close_existing(bool | None) # – Close any existing popup on the client (-Cflag). -
target_client(str | None) # – Display the popup on this specific client (-cflag). When omitted, tmux selects the client attached to this pane's session. With multiple clients attached, pass target_client to direct the popup at one of them. -
start_directory(StrPath | None) # – Working directory (-dflag). -
title(str | None) # – Popup title (-Tflag). Requires tmux 3.3+. -
border_lines(str | None) # – Border line style (-bflag). Requires tmux 3.3+. -
style(str | None) # – Popup style (-sflag). Requires tmux 3.3+. -
border_style(str | None) # – Border style (-Sflag). Requires tmux 3.3+. -
environment(dict[str, str] | None) # – Environment variables (-eflag). Requires tmux 3.3+. -
no_border(bool | None) # – Open the popup without a border (-Bflag). If border_lines is also set, tmux ignores it. Requires tmux 3.3+. -
close_on_any_key(bool | None) # – Dismiss the popup on any key press once the inner command has exited (-kflag). Requires tmux 3.6+. -
no_keys(bool | None) # – Do not auto-close the popup on any close-trigger keys (-Nflag). Requires tmux 3.6+.
tmux command
display-popupIn 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.