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

pane.Pane.chooseTree

TypeScript

View as Markdown

Module
pane
Declared in
Pane
Package
libtmux
Source
packages/libtmux/src/pane.ts
Other languages
Python Ruby Lua Rust Go Java .NET C++ Swift
chooseTree ( options : : ChooseTreeOptions ) → Promise<void>
method [source]
method [source]
chooseTree

Open the interactive session and window chooser in this pane.

The promise resolves once the chooser is on screen, not once someone has chosen: tmux answers this command as soon as it opens the mode. Bind a tmux command to the selection to act on what was picked.

tmux needs a client attached to the session to draw this. With none, it does nothing and reports success, so a headless run is told it worked.

In other ports Open the session and window chooser in a pane

Examples

await pane.chooseTree({ sessionsOnly: true });
>>> pane.choose_tree()

0 declared, 0 inherited

Esc

Type to search.