Documentation
¶
Overview ¶
Package tui provides the top-level TUI model with tab and session management.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type FocusedPanel ¶
type FocusedPanel string
FocusedPanel represents which panel is currently focused
const ( PanelContent FocusedPanel = "content" PanelEditor FocusedPanel = "editor" )
type Option ¶ added in v1.41.0
type Option func(*appModel)
Option configures the TUI.
func WithAppName ¶ added in v1.44.0
WithAppName sets the application name.
If not provided, defaults to "docker agent".
func WithCommandBuilder ¶ added in v1.44.0
WithCommandBuilder builds the command categories shown in the command palette from the given function. It overrides the default command category builder. To include the default commands, the given function should call commands.BuildCommandCategories and merge the result with its own.
The tea.Model passed to the builder function must not be accessed during the build call itself - it should only be captured for use within command Execute functions. There is no guarantee that the tea.Model holds all dependencies during the build phase, which may cause core.Resolve to panic.
func WithLeanMode ¶ added in v1.41.0
func WithLeanMode() Option
WithLeanMode enables a simplified TUI with minimal chrome: no sidebar, no tab bar, no overlays, no resize handle.
func WithVersion ¶ added in v1.44.0
WithVersion sets the application version.
If not provided, defaults to version.Version.
type SessionSpawner ¶
type SessionSpawner = supervisor.SessionSpawner
SessionSpawner creates new sessions with their own runtime. This is an alias to the supervisor package's SessionSpawner type.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package animation provides centralized animation tick management for the TUI.
|
Package animation provides centralized animation tick management for the TUI. |
|
Package cmdbatch provides a fluent builder for batching tea.Cmd values.
|
Package cmdbatch provides a fluent builder for batching tea.Cmd values. |
|
components
|
|
|
markdown
Package markdown provides a high-performance markdown renderer for terminal output.
|
Package markdown provides a high-performance markdown renderer for terminal output. |
|
scrollview
Package scrollview provides a composable scrollable view that pairs content with a fixed-position scrollbar.
|
Package scrollview provides a composable scrollable view that pairs content with a fixed-position scrollbar. |
|
tabbar
Package tabbar provides a horizontal tab bar for the TUI.
|
Package tabbar provides a horizontal tab bar for the TUI. |
|
Package messages defines all TUI message types organized by domain.
|
Package messages defines all TUI message types organized by domain. |
|
page
|
|
|
supervisor
Package supervisor manages agent sessions.
|
Package supervisor manages agent sessions. |
|
tuistate
Package tuistate provides persistent TUI state storage (tabs, recent/favorite directories).
|
Package tuistate provides persistent TUI state storage (tabs, recent/favorite directories). |
|
Package subscription provides patterns for external event sources in the TUI.
|
Package subscription provides patterns for external event sources in the TUI. |