dashboard

package

v0.0.2 Latest Latest Go to latest Published: Jan 20, 2026 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/andyrewlee/amux

Links

Open Source Insights

Documentation ¶

Index ¶

type Model
- func New() *Model
type Row
type RowType

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Model ¶

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

Model is the Bubbletea model for the dashboard pane

func New ¶

func New() *Model

New creates a new dashboard model

func (*Model) Blur ¶

func (m *Model) Blur()

Blur removes focus

func (*Model) ClearActiveRoot ¶

func (m *Model) ClearActiveRoot()

ClearActiveRoot resets the active worktree selection to "Home".

func (*Model) Focus ¶

func (m *Model) Focus()

Focus sets the focus state

func (*Model) Focused ¶

func (m *Model) Focused() bool

Focused returns whether the dashboard is focused

func (*Model) Init ¶

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

Init initializes the dashboard

func (*Model) Projects ¶

func (m *Model) Projects() []data.Project

Projects returns the current projects

func (*Model) SelectedRow ¶

func (m *Model) SelectedRow() *Row

SelectedRow returns the currently selected row

func (*Model) SetCanFocusRight ¶

func (m *Model) SetCanFocusRight(can bool)

SetCanFocusRight controls whether focus-right hints should be shown.

func (*Model) SetProjects ¶

func (m *Model) SetProjects(projects []data.Project)

SetProjects sets the projects list

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 dashboard size

func (*Model) SetStyles ¶

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

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

func (*Model) SetWorktreeCreating ¶

func (m *Model) SetWorktreeCreating(wt *data.Worktree, creating bool) tea.Cmd

SetWorktreeCreating marks a worktree as creating (or clears it).

func (*Model) SetWorktreeDeleting ¶

func (m *Model) SetWorktreeDeleting(root string, deleting bool) tea.Cmd

SetWorktreeDeleting marks a worktree as deleting (or clears it).

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 dashboard

type Row ¶

type Row struct {
	Type     RowType
	Project  *data.Project
	Worktree *data.Worktree
}

Row represents a single row in the dashboard

type RowType ¶

type RowType int

RowType identifies the type of row in the dashboard

const (
	RowHome RowType = iota
	RowAddProject
	RowProject
	RowWorktree
	RowCreate
	RowSpacer
)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL