sidebar

package
v0.0.20 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 17, 2026 License: MIT Imports: 27 Imported by: 0

Documentation

Overview

Package sidebar implements the sidebar pane: the workspace file tree plus an embedded tmux-backed terminal with its own PTY I/O and text selection.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AheadBehindLoaded added in v0.0.20 

type AheadBehindLoaded struct {
	Root   string
	LoadID int
	Ahead  int
	Behind int
	Err    error
}

AheadBehindLoaded carries the result of an async AheadBehind fetch, triggered on workspace switch, manual refresh ("g"), and after a commit.

type BranchChangesLoaded added in v0.0.20 

type BranchChangesLoaded struct {
	Root    string
	LoadID  int
	Changes []git.Change
	Err     error
}

BranchChangesLoaded carries the result of an async BranchChangesVsBase fetch triggered by toggling branch mode on. It is routed back into the sidebar explicitly by internal/app (see app_input.go), since Bubbletea has no generic message broadcast.

type DetachedTerminalTabInfo added in v0.0.20 

type DetachedTerminalTabInfo struct {
	WorkspaceID string
	TabID       TerminalTabID
}

DetachedTerminalTabInfo identifies a terminal tab detached by automatic limit enforcement.

type Model 

type Model struct {
	// contains filtered or unexported fields
}

Model is the Bubbletea model for the sidebar pane (rendering lives in model_view.go, input in model_input.go; branch-mode fetch/render helpers live in branch.go).

func New 

func New() *Model

New creates a new sidebar model.

func (*Model) Blur 

func (m *Model) Blur()

Blur removes focus.

func (*Model) FilterActive added in v0.0.20 

func (m *Model) FilterActive() bool

FilterActive reports whether the Changes view is currently in filter-input mode (used so the tab bar doesn't steal digit keys meant for the filter).

func (*Model) Focus 

func (m *Model) Focus()

Focus sets the focus state.

func (*Model) Focused 

func (m *Model) Focused() bool

Focused returns whether the sidebar is focused.

func (*Model) Init 

func (m *Model) Init() tea.Cmd

Init initializes the sidebar.

func (*Model) SetGitStatus 

func (m *Model) SetGitStatus(status *git.StatusResult)

SetGitStatus sets the git status.

func (*Model) SetShowKeymapHints 

func (m *Model) SetShowKeymapHints(show bool)

SetShowKeymapHints controls whether helper text is rendered.

func (*Model) SetSize 

func (m *Model) SetSize(width, height int)

SetSize sets the sidebar size.

func (*Model) SetStyles 

func (m *Model) SetStyles(styles common.Styles)

SetStyles updates the component's styles (for theme changes).

func (*Model) SetWorkspace added in v0.0.5 

func (m *Model) SetWorkspace(ws *data.Workspace) tea.Cmd

SetWorkspace sets the active workspace. It returns a command that fetches the ahead/behind badge for the new workspace (nil when ws is nil or this is just a pointer rebind of the same workspace).

func (*Model) Update 

func (m *Model) Update(msg tea.Msg) (*Model, tea.Cmd)

Update handles messages.

func (*Model) View 

func (m *Model) View() string

View renders the sidebar

type OpenFileInEditor added in v0.0.4 

type OpenFileInEditor struct {
	Path      string
	Workspace *data.Workspace
}

OpenFileInEditor is a message to open a file in the editor

type ProjectTree added in v0.0.4 

type ProjectTree struct {
	// contains filtered or unexported fields
}

ProjectTree is a nerdtree-like file browser

func NewProjectTree added in v0.0.4 

func NewProjectTree() *ProjectTree

NewProjectTree creates a new project tree model

func (*ProjectTree) Blur added in v0.0.4 

func (m *ProjectTree) Blur()

Blur removes focus

func (*ProjectTree) Focus added in v0.0.4 

func (m *ProjectTree) Focus()

Focus sets the focus state

func (*ProjectTree) Focused added in v0.0.4 

func (m *ProjectTree) Focused() bool

Focused returns whether the tree is focused

func (*ProjectTree) Init added in v0.0.4 

func (m *ProjectTree) Init() tea.Cmd

Init initializes the project tree

func (*ProjectTree) SetShowKeymapHints added in v0.0.4 

func (m *ProjectTree) SetShowKeymapHints(show bool)

SetShowKeymapHints controls whether helper text is rendered.

func (*ProjectTree) SetSize added in v0.0.4 

func (m *ProjectTree) SetSize(width, height int)

SetSize sets the project tree size

func (*ProjectTree) SetStyles added in v0.0.4 

func (m *ProjectTree) SetStyles(styles common.Styles)

SetStyles updates the component's styles (for theme changes).

func (*ProjectTree) SetWorkspace added in v0.0.5 

func (m *ProjectTree) SetWorkspace(ws *data.Workspace)

SetWorkspace sets the active workspace

func (*ProjectTree) Update added in v0.0.4 

func (m *ProjectTree) Update(msg tea.Msg) (*ProjectTree, tea.Cmd)

Update handles messages

func (*ProjectTree) View added in v0.0.4 

func (m *ProjectTree) View() string

View renders the project tree

type ProjectTreeNode added in v0.0.4 

type ProjectTreeNode struct {
	Name     string
	Path     string
	IsDir    bool
	Expanded bool
	Depth    int
	Children []*ProjectTreeNode
	Parent   *ProjectTreeNode
}

ProjectTreeNode represents a file or directory in the tree

type SessionAttachInfo added in v0.0.9 

type SessionAttachInfo struct {
	Name           string
	Attach         bool
	DetachExisting bool
}

type SidebarSelectionScrollTick added in v0.0.10 

type SidebarSelectionScrollTick struct {
	WorkspaceID string
	TabID       TerminalTabID
	Gen         uint64
	Seq         uint64
}

SidebarSelectionScrollTick is sent by the tick loop to continue auto-scrolling during mouse-drag selection past viewport edges.

type SidebarTab added in v0.0.4 

type SidebarTab int

SidebarTab represents a tab type in the sidebar 

const (
	TabChanges SidebarTab = iota
	TabProject
)

type SidebarTerminalCreateFailed added in v0.0.5 

type SidebarTerminalCreateFailed struct {
	WorkspaceID string
	Err         error
}

SidebarTerminalCreateFailed is a message for terminal creation failure

type SidebarTerminalCreated 

type SidebarTerminalCreated struct {
	WorkspaceID string
	TabID       TerminalTabID
	Terminal    *pty.Terminal
	SessionName string
	CaptureCols int
	CaptureRows int
	ptyio.SessionRestoreCapture
}

SidebarTerminalCreated is a message for terminal creation

type SidebarTerminalReattachFailed added in v0.0.9 

type SidebarTerminalReattachFailed struct {
	WorkspaceID string
	TabID       TerminalTabID
	Err         error
	Stopped     bool
	Action      string
}

type SidebarTerminalReattachResult added in v0.0.9 

type SidebarTerminalReattachResult struct {
	WorkspaceID string
	TabID       TerminalTabID
	Terminal    *pty.Terminal
	SessionName string
	CaptureCols int
	CaptureRows int
	ptyio.SessionRestoreCapture
}

type TabbedSidebar added in v0.0.4 

type TabbedSidebar struct {
	// contains filtered or unexported fields
}

TabbedSidebar wraps the Changes and Project views with tabs

func NewTabbedSidebar added in v0.0.4 

func NewTabbedSidebar() *TabbedSidebar

NewTabbedSidebar creates a new tabbed sidebar

func (*TabbedSidebar) ActiveTab added in v0.0.4 

func (m *TabbedSidebar) ActiveTab() SidebarTab

ActiveTab returns the currently active tab

func (*TabbedSidebar) Blur added in v0.0.4 

func (m *TabbedSidebar) Blur()

Blur removes focus

func (*TabbedSidebar) CanConsumeWheel added in v0.0.18 

func (m *TabbedSidebar) CanConsumeWheel() bool

CanConsumeWheel reports whether the active sidebar tab has meaningful wheel scroll content. This avoids hover-wheel focus steals from empty panes.

func (*TabbedSidebar) Changes added in v0.0.4 

func (m *TabbedSidebar) Changes() *Model

Changes returns the changes model (for direct access if needed)

func (*TabbedSidebar) ContentView added in v0.0.4 

func (m *TabbedSidebar) ContentView() string

ContentView returns only the content view without tab bar (for compositor)

func (*TabbedSidebar) Focus added in v0.0.4 

func (m *TabbedSidebar) Focus()

Focus sets the focus state

func (*TabbedSidebar) Focused added in v0.0.4 

func (m *TabbedSidebar) Focused() bool

Focused returns whether the sidebar is focused

func (*TabbedSidebar) Init added in v0.0.4 

func (m *TabbedSidebar) Init() tea.Cmd

Init initializes the tabbed sidebar

func (*TabbedSidebar) NextTab added in v0.0.4 

func (m *TabbedSidebar) NextTab()

NextTab switches to the next tab (circular)

func (*TabbedSidebar) PrevTab added in v0.0.4 

func (m *TabbedSidebar) PrevTab()

PrevTab switches to the previous tab (circular)

func (*TabbedSidebar) ProjectTree added in v0.0.4 

func (m *TabbedSidebar) ProjectTree() *ProjectTree

ProjectTree returns the project tree model (for direct access if needed)

func (*TabbedSidebar) RefreshAheadBehind added in v0.0.20 

func (m *TabbedSidebar) RefreshAheadBehind() tea.Cmd

RefreshAheadBehind re-fetches the ahead/behind badge for the active workspace (e.g. after a commit changes HEAD's distance from base).

func (*TabbedSidebar) SetActiveTab added in v0.0.4 

func (m *TabbedSidebar) SetActiveTab(tab SidebarTab)

SetActiveTab sets the active tab

func (*TabbedSidebar) SetGitStatus added in v0.0.4 

func (m *TabbedSidebar) SetGitStatus(status *git.StatusResult)

SetGitStatus sets the git status (forwards to changes view)

func (*TabbedSidebar) SetShowKeymapHints added in v0.0.4 

func (m *TabbedSidebar) SetShowKeymapHints(show bool)

SetShowKeymapHints controls whether helper text is rendered.

func (*TabbedSidebar) SetSize added in v0.0.4 

func (m *TabbedSidebar) SetSize(width, height int)

SetSize sets the sidebar size

func (*TabbedSidebar) SetStyles added in v0.0.4 

func (m *TabbedSidebar) SetStyles(styles common.Styles)

SetStyles updates the component's styles (for theme changes).

func (*TabbedSidebar) SetWorkspace added in v0.0.5 

func (m *TabbedSidebar) SetWorkspace(ws *data.Workspace) tea.Cmd

SetWorkspace sets the active workspace. It returns the Changes view's ahead/behind refresh command (nil for a no-op rebind); see Model.SetWorkspace.

func (*TabbedSidebar) TabBarBuildCount added in v0.0.20 

func (m *TabbedSidebar) TabBarBuildCount() uint64

TabBarBuildCount reports how many times TabBarView has been invoked. Test instrumentation for the compose-time skip gate; not for production use.

func (*TabbedSidebar) TabBarVersion added in v0.0.20 

func (m *TabbedSidebar) TabBarVersion() uint64

TabBarVersion returns the monotonic version of the inputs to TabBarView. The compose layer in internal/app skips rebuilding the tab bar string while this version and the compose geometry are unchanged.

func (*TabbedSidebar) TabBarView added in v0.0.4 

func (m *TabbedSidebar) TabBarView() string

TabBarView returns only the tab bar view (for compositor)

func (*TabbedSidebar) Update added in v0.0.4 

func (m *TabbedSidebar) Update(msg tea.Msg) (*TabbedSidebar, tea.Cmd)

Update handles messages

func (*TabbedSidebar) View added in v0.0.4 

func (m *TabbedSidebar) View() string

View renders the tabbed sidebar

type TerminalModel 

type TerminalModel struct {
	// contains filtered or unexported fields
}

TerminalModel is the Bubbletea model for the sidebar terminal section

func NewTerminalModel 

func NewTerminalModel() *TerminalModel

NewTerminalModel creates a new sidebar terminal model

func (*TerminalModel) AddTabsFromSessionInfos added in v0.0.9 

func (m *TerminalModel) AddTabsFromSessionInfos(ws *data.Workspace, sessions []SessionAttachInfo) []tea.Cmd

AddTabsFromSessionInfos ensures tabs exist for the provided tmux sessions, optionally attaching.

func (*TerminalModel) AddTabsFromSessions added in v0.0.9 

func (m *TerminalModel) AddTabsFromSessions(ws *data.Workspace, sessions []string) []tea.Cmd

AddTabsFromSessions ensures tabs exist for the provided tmux session names.

func (*TerminalModel) AddTerminalForHarness 

func (m *TerminalModel) AddTerminalForHarness(ws *data.Workspace)

AddTerminalForHarness creates a terminal state without a PTY for benchmarks/tests.

func (*TerminalModel) Blur 

func (m *TerminalModel) Blur()

Blur removes focus

func (*TerminalModel) CanConsumeWheel added in v0.0.18 

func (m *TerminalModel) CanConsumeWheel() bool

CanConsumeWheel reports whether the active terminal has scrollback to view.

func (*TerminalModel) CloseActiveTab added in v0.0.4 

func (m *TerminalModel) CloseActiveTab() tea.Cmd

CloseActiveTab closes the active terminal tab

func (*TerminalModel) CloseAll 

func (m *TerminalModel) CloseAll()

CloseAll closes all terminals

func (*TerminalModel) CloseTerminal 

func (m *TerminalModel) CloseTerminal(wsID string)

CloseTerminal closes all terminal tabs for the given workspace

func (*TerminalModel) CreateNewTab added in v0.0.4 

func (m *TerminalModel) CreateNewTab() tea.Cmd

CreateNewTab creates a new terminal tab for the current workspace and returns a command

func (*TerminalModel) DetachActiveTab added in v0.0.9 

func (m *TerminalModel) DetachActiveTab() tea.Cmd

DetachActiveTab closes the PTY client but keeps the tmux session alive.

func (*TerminalModel) EnforceAttachedTerminalTabLimit added in v0.0.20 

func (m *TerminalModel) EnforceAttachedTerminalTabLimit(maxAttached int) []DetachedTerminalTabInfo

EnforceAttachedTerminalTabLimit detaches least-recently-used sidebar terminal PTYs when the number of attached terminals exceeds maxAttached.

Tabs of the currently selected workspace are never auto-detached: sidebar session discovery re-attaches the active workspace's terminals on its periodic scan, so detaching them would thrash. Auto-detached sessions stay alive in tmux (UserDetached remains false) and are re-attached transparently by discovery when their workspace is selected again.

A tab's recency is the later of its workspace's last selection and its own last PTY output, so a background terminal still streaming (e.g. a build) outranks one sitting at an idle prompt.

func (*TerminalModel) EnsureTerminalTab added in v0.0.5 

func (m *TerminalModel) EnsureTerminalTab() tea.Cmd

EnsureTerminalTab creates a terminal tab if none exists for the current workspace. Used for lazy initialization when the terminal pane is focused.

func (*TerminalModel) Focus 

func (m *TerminalModel) Focus()

Focus sets focus state

func (*TerminalModel) Focused 

func (m *TerminalModel) Focused() bool

Focused returns whether the terminal is focused

func (*TerminalModel) HandleTerminalCreated 

func (m *TerminalModel) HandleTerminalCreated(wsID string, tabID TerminalTabID, term *pty.Terminal, sessionName string) tea.Cmd

HandleTerminalCreated handles the terminal tab creation message

func (*TerminalModel) HasMultipleTabs added in v0.0.4 

func (m *TerminalModel) HasMultipleTabs() bool

HasMultipleTabs returns true if there are multiple tabs for the current workspace

func (*TerminalModel) HelpLines 

func (m *TerminalModel) HelpLines(width int) []string

HelpLines returns the help lines for the given width, respecting visibility and height.

func (*TerminalModel) Init 

func (m *TerminalModel) Init() tea.Cmd

Init initializes the terminal model

func (*TerminalModel) NextTab added in v0.0.4 

func (m *TerminalModel) NextTab()

NextTab switches to the next terminal tab (circular)

func (*TerminalModel) PrevTab added in v0.0.4 

func (m *TerminalModel) PrevTab()

PrevTab switches to the previous terminal tab (circular)

func (*TerminalModel) ReattachActiveTab added in v0.0.9 

func (m *TerminalModel) ReattachActiveTab() tea.Cmd

ReattachActiveTab reattaches to a detached tmux session for the active terminal tab.

func (*TerminalModel) RebindWorkspaceID added in v0.0.14 

func (m *TerminalModel) RebindWorkspaceID(previous, current *data.Workspace) tea.Cmd

RebindWorkspaceID migrates terminal tabs from a previous workspace ID to a new one. This preserves running/session-backed terminal tabs across workspace ID rewrites.

func (*TerminalModel) RestartActiveTab added in v0.0.9 

func (m *TerminalModel) RestartActiveTab() tea.Cmd

RestartActiveTab starts a fresh tmux session for the active terminal tab.

func (*TerminalModel) SelectTab added in v0.0.4 

func (m *TerminalModel) SelectTab(idx int)

SelectTab selects a tab by index

func (*TerminalModel) SendToTerminal 

func (m *TerminalModel) SendToTerminal(s string)

SendToTerminal sends a string directly to the current terminal

func (*TerminalModel) SetInstanceID added in v0.0.9 

func (m *TerminalModel) SetInstanceID(id string)

SetInstanceID sets the tmux instance tag for sessions created by this model.

func (*TerminalModel) SetMsgSink added in v0.0.4 

func (m *TerminalModel) SetMsgSink(sink func(tea.Msg))

SetMsgSink sets a callback for PTY messages.

func (*TerminalModel) SetOffset 

func (m *TerminalModel) SetOffset(x, y int)

SetOffset sets the absolute screen coordinates where the terminal starts

func (*TerminalModel) SetShowKeymapHints 

func (m *TerminalModel) SetShowKeymapHints(show bool)

SetShowKeymapHints controls whether helper text is rendered.

func (*TerminalModel) SetSize 

func (m *TerminalModel) SetSize(width, height int)

SetSize sets the terminal section size

func (*TerminalModel) SetStyles 

func (m *TerminalModel) SetStyles(styles common.Styles)

SetStyles updates the component's styles (for theme changes).

func (*TerminalModel) SetTmuxOptions added in v0.0.20 

func (m *TerminalModel) SetTmuxOptions(opts tmux.Options)

SetTmuxOptions stores the resolved tmux options for this model.

func (*TerminalModel) SetWorkspace added in v0.0.5 

func (m *TerminalModel) SetWorkspace(ws *data.Workspace) tea.Cmd

SetWorkspace sets the active workspace and creates terminal tab if needed

func (*TerminalModel) SetWorkspacePreview added in v0.0.5 

func (m *TerminalModel) SetWorkspacePreview(ws *data.Workspace)

SetWorkspacePreview sets the active workspace without creating tabs.

func (*TerminalModel) StartPTYReaders added in v0.0.5 

func (m *TerminalModel) StartPTYReaders() tea.Cmd

StartPTYReaders ensures PTY readers are running for all tabs.

func (*TerminalModel) StatusLine 

func (m *TerminalModel) StatusLine() string

StatusLine returns the status line for the active terminal.

func (*TerminalModel) TabBarView added in v0.0.4 

func (m *TerminalModel) TabBarView() string

TabBarView returns the rendered tab bar string.

func (*TerminalModel) TerminalLayer 

func (m *TerminalModel) TerminalLayer() *compositor.VTermLayer

TerminalLayer returns a VTermLayer for the active workspace terminal.

func (*TerminalModel) TerminalLayerWithCursorOwner added in v0.0.16 

func (m *TerminalModel) TerminalLayerWithCursorOwner(cursorOwner bool) *compositor.VTermLayer

TerminalLayerWithCursorOwner returns a VTermLayer for the active workspace terminal while enforcing whether this pane currently owns cursor rendering.

func (*TerminalModel) TerminalOrigin 

func (m *TerminalModel) TerminalOrigin() (int, int)

TerminalOrigin returns the absolute origin for terminal rendering.

func (*TerminalModel) TerminalSize 

func (m *TerminalModel) TerminalSize() (int, int)

TerminalSize returns the terminal render size.

func (*TerminalModel) Update 

func (m *TerminalModel) Update(msg tea.Msg) (*TerminalModel, tea.Cmd)

func (*TerminalModel) View 

func (m *TerminalModel) View() string

View renders the terminal section

func (*TerminalModel) WriteToTerminal 

func (m *TerminalModel) WriteToTerminal(data []byte)

WriteToTerminal writes bytes to the active terminal while holding the lock.

type TerminalState 

type TerminalState struct {
	Terminal     *pty.Terminal
	VTerm        *vterm.VTerm
	Running      bool
	Detached     bool
	UserDetached bool

	SessionName string

	// ptyio.State holds the shared PTY buffering/reader/restart/snapshot
	// bookkeeping (locking owned by mu, as documented on the type).
	ptyio.State

	// Selection state
	Selection common.SelectionState
	// contains filtered or unexported fields
}

TerminalState holds the terminal state for a workspace

type TerminalTab added in v0.0.4 

type TerminalTab struct {
	ID    TerminalTabID
	Name  string // "Terminal 1", "Terminal 2", etc.
	State *TerminalState
}

TerminalTab represents a single terminal tab

type TerminalTabID added in v0.0.4 

type TerminalTabID string

TerminalTabID is a unique identifier for a terminal tab

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.