view

type Action ¶

type Action func(name string) tea.Cmd

Action is a feature action that can be triggered by key presses. The string parameter is the resource name (e.g. secret name). Registered during init() by extension packages, read-only after startup.

func GetAction(name string) (Action, bool)

type AppErrorMsg ¶

type AppErrorMsg struct {
	Error        string
	FallbackView string
}

AppErrorMsg signals that a view (or the app layer) encountered a loading error. The app shows a modal error dialog. On dismiss it navigates to FallbackView (if non-empty) or calls goBack().

type AppInfoMsg ¶

type AppInfoMsg struct {
	Message      string
	FallbackView string
}

AppInfoMsg signals that a view (or the app layer) wants to show an informational notice — the AppErrorMsg counterpart for non-error content. The app shows the same modal styled as a neutral "Info" notice (not an error). On dismiss it navigates to FallbackView (if non-empty) or calls goBack(). Generic extension point: senders decide what warrants a notice.

type Factory ¶

type Factory func(deps docker.Deps, width, height int, payload any) (View, tea.Cmd)

Factory creates a View instance with its initial command. The deps parameter provides Docker operation interfaces for testability.

func GetFactory(name string) (Factory, bool)

type Filterable ¶

type Filterable interface {
	ApplySearchQuery(query string)
	ClearSearchQuery()
}

Filterable is an opt-in interface for views that support app-level "/" search filtering. Checked via type assertion in app/update.go.

type GoBackMsg ¶

type GoBackMsg struct{}

GoBackMsg requests the app to pop the current view and return to the previous one.

type NavigateToMsg ¶

type NavigateToMsg struct {
	ViewName string
	Payload  any // Can be service ID, stack ID, etc.
	// Replace indicates whether the target view should replace the current
	// view (i.e., not be pushed onto the navigation stack). When false,
	// the view manager should push the new view onto the history stack.
	Replace bool
}

type OpenConnectAppMsg ¶ added in v2.2.0

type OpenConnectAppMsg struct{}

OpenConnectAppMsg requests the app to open the popup that connects the SwarmCLI phone app (the "c" key and :connect).

type OpenUnlockDialogMsg ¶

type OpenUnlockDialogMsg struct{}

OpenUnlockDialogMsg requests the app to open the swarm unlock-key dialog.

type OpenUpdateDialogMsg ¶

type OpenUpdateDialogMsg struct {
	Version string
}

OpenUpdateDialogMsg requests the app to force-show the "update available" notice on demand (the dev-only :dev-update command), bypassing the per-version dismissal. Version overrides the displayed latest version when set; otherwise the app falls back to the last checked version or a stub.

type RestoreMouseMsg ¶ added in v2.2.0

type RestoreMouseMsg struct{}

RestoreMouseMsg tells the app a terminal handover has switched mouse reporting off, so it switches it back on if the current view should have it. See ExecProcess.

type RowClicker ¶ added in v2.2.0

type RowClicker interface {
	ClickRow(line int) bool
}

RowClicker is an opt-in interface for views whose content is a list of rows. The app turns a left click inside the frame into ClickRow, with line counted from the first content line below the header, and a second click on the same line in quick succession into an Enter keypress. ClickRow selects whatever row that line belongs to and reports whether there was one; a click on padding, a placeholder or anything else that is not a row returns false and changes nothing.

The app only calls it when nothing is capturing input, so a view does not have to check its own dialogs. Views without it get no mouse at all: the app switches mouse reporting off while one is current, so the text it shows selects natively. Checked via type assertion in app/mouse.go.

type ToggleMouseMsg ¶ added in v2.2.0

type ToggleMouseMsg struct{}

ToggleMouseMsg asks the app to switch mouse capture off, or back on, for the rest of the session.

type View ¶

type View interface {
	Update(msg tea.Msg) tea.Cmd
	View() string
	Init() tea.Cmd
	Name() string
	ShortHelpItems() []helpbar.HelpEntry

	OnEnter() tea.Cmd // Called when view becomes active
	OnExit() tea.Cmd  // Called when view is removed/replaced

	HasErrors() bool // Returns true if the view has any errors to display

	// Frame components — views return unframed content,
	// app wraps with ui.RenderViewFrame.
	FrameTitle() string   // text for frame title bar
	FrameHeader() string  // rendered header line(s), "" if none
	FrameFooter() string  // rendered footer line(s), "" if none
	FrameContent() string // unframed content (may include dialog overlays)
}

type Warner ¶ added in v2.2.0

type Warner interface {
	HasWarnings() bool
}

Warner is an opt-in interface for views whose rows can be converging: not failing, but not settled either. The logo turns amber when the current view has warnings and no errors. Checked via type assertion in app/view.go.