Documentation
¶
Index ¶
- Constants
- Variables
- func GetContextsHelpContent() []helpview.HelpCategory
- func LoadCertFilesCmd(dirPath string) tea.Cmd
- func LoadFilesCmd(dirPath string) tea.Cmd
- type ContextChangedNotification
- type ContextCreatedMsg
- type ContextDeletedMsg
- type ContextExportedMsg
- type ContextImportedMsg
- type ContextSwitchedMsg
- type ContextUpdatedMsg
- type ContextsLoadedMsg
- type FilesLoadedMsg
- type Model
- func (m *Model) ApplySearchQuery(query string)
- func (m *Model) CapturesInput() bool
- func (m *Model) ClearSearchQuery()
- func (m *Model) ClickRow(line int) bool
- func (m *Model) FrameContent() string
- func (m *Model) FrameFooter() string
- func (m *Model) FrameHeader() string
- func (m *Model) FrameTitle() string
- func (m *Model) GetContexts() []docker.ContextInfo
- func (m *Model) GetCursor() int
- func (m *Model) GetError() string
- func (m *Model) GetSelectedContext() (docker.ContextInfo, bool)
- func (m *Model) GetSuccess() string
- func (m *Model) HasActiveFilter() bool
- func (m *Model) HasErrors() bool
- func (m *Model) HelpContent() []helpview.HelpCategory
- func (m *Model) Init() tea.Cmd
- func (m *Model) IsLoading() bool
- func (m *Model) IsSearching() bool
- func (m *Model) IsSwitchPending() bool
- func (m *Model) MoveCursor(delta int)
- func (m *Model) Name() string
- func (m *Model) OnEnter() tea.Cmd
- func (m *Model) OnExit() tea.Cmd
- func (m *Model) SetContexts(contexts []docker.ContextInfo)
- func (m *Model) SetError(err string)
- func (m *Model) SetLoading(loading bool)
- func (m *Model) SetSize(width, height int)
- func (m *Model) SetSuccess(msg string)
- func (m *Model) SetSwitchPending(pending bool)
- func (m *Model) ShortHelpItems() []helpbar.HelpEntry
- func (m *Model) Update(msg tea.Msg) tea.Cmd
- func (m *Model) View() string
- type RefreshTickMsg
- type SortField
Constants ¶
const ViewName = "contexts"
Variables ¶
var PollInterval = 5 * time.Second
PollInterval is how often the view re-reads the context list. It is a var, not a const, so tests can shrink it: a tea.Tick cmd invoked synchronously blocks for the full interval, so a test that runs one to see what it scheduled would otherwise sit here for five seconds.
Functions ¶
func GetContextsHelpContent ¶
func GetContextsHelpContent() []helpview.HelpCategory
GetContextsHelpContent returns categorized help for the contexts view
func LoadCertFilesCmd ¶
LoadCertFilesCmd loads all files from a directory for cert file selection
func LoadFilesCmd ¶
LoadFilesCmd loads context archive files and directories from a path for browsing
Types ¶
type ContextChangedNotification ¶
type ContextChangedNotification struct {
PreviousContext string
}
ContextChangedNotification is sent to notify the app that the Docker context has changed and should navigate to stacks view
type ContextCreatedMsg ¶
type ContextDeletedMsg ¶
type ContextExportedMsg ¶
type ContextImportedMsg ¶
type ContextSwitchedMsg ¶
type ContextUpdatedMsg ¶
type ContextsLoadedMsg ¶
type ContextsLoadedMsg struct {
Contexts []docker.ContextInfo
Error error
}
type FilesLoadedMsg ¶
FilesLoadedMsg contains the list of context archive files in a directory
type Model ¶
type Model struct {
Visible bool
List filterlist.FilterableList[docker.ContextInfo]
// contains filtered or unexported fields
}
func (*Model) ApplySearchQuery ¶
ApplySearchQuery sets the filter query and applies it.
func (*Model) CapturesInput ¶
CapturesInput reports whether the view is currently capturing all keyboard input.
func (*Model) ClearSearchQuery ¶
func (m *Model) ClearSearchQuery()
ClearSearchQuery clears the filter query and resets the view.
func (*Model) ClickRow ¶ added in v2.2.0
ClickRow selects the context under a mouse click. Like the cursor keys it does nothing while a switch is pending, and nothing while the list is still loading, when the content is a placeholder rather than rows.
func (*Model) FrameContent ¶
func (*Model) FrameFooter ¶
func (*Model) FrameHeader ¶
func (*Model) FrameTitle ¶
func (*Model) GetContexts ¶
func (m *Model) GetContexts() []docker.ContextInfo
func (*Model) GetSelectedContext ¶
func (m *Model) GetSelectedContext() (docker.ContextInfo, bool)
func (*Model) GetSuccess ¶
func (*Model) HasActiveFilter ¶
HasActiveFilter reports whether a filter query is active.
func (*Model) HelpContent ¶
func (m *Model) HelpContent() []helpview.HelpCategory
HelpContent implements the app's optional help-screen contract: "?" is handled centrally, and a view carrying its own screen supplies it here.
func (*Model) IsSearching ¶
IsSearching reports whether the list is currently in search mode.
func (*Model) IsSwitchPending ¶
func (*Model) MoveCursor ¶
func (*Model) SetContexts ¶
func (m *Model) SetContexts(contexts []docker.ContextInfo)
func (*Model) SetLoading ¶
func (*Model) SetSuccess ¶
func (*Model) SetSwitchPending ¶
func (*Model) ShortHelpItems ¶
ShortHelpItems returns the help items for the view
type RefreshTickMsg ¶
type RefreshTickMsg struct{ Gen uint64 }
RefreshTickMsg drives the periodic re-read. Gen names the poll chain it belongs to; see Model.OnEnter.
Source Files