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-ts latest

Pane.chooseTree

Open the interactive session and window chooser in this pane.

Source and package
Qualified name
Pane.chooseTree
Module
pane
Declared in
Pane
Package
libtmux
Source
packages/libtmux/src/pane.ts
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua Rust Go Java C# C++ Swift Kotlin Scala OCaml F# Clojure

Description#

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.

Examples#

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

tmux command#

The tmux commands behind chooseTree.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Open the session and window chooser in a pane

Equivalents of Open the session and window chooser in a pane in other languages
Language Equivalent
Python libtmux.Pane.choose_tree
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Rust no equivalent on Pane
Go tmux.Pane.ChooseTree
Java no equivalent on Pane
C# LibTmux.Pane.ChooseTreeAsync
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