Documentation
¶
Index ¶
- Constants
- Variables
- func GetConfigsHelpContent() []helpview.HelpCategory
- type Model
- func (m *Model) ApplySearchQuery(query string)
- func (m *Model) CapturesInput() bool
- func (m *Model) ClearSearchQuery()
- func (m *Model) FrameContent() string
- func (m *Model) FrameFooter() string
- func (m *Model) FrameHeader() string
- func (m *Model) FrameTitle() 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) IsInUsedByView() bool
- func (m *Model) IsSearching() bool
- func (m *Model) Name() string
- func (m *Model) OnEnter() tea.Cmd
- func (m *Model) OnExit() tea.Cmd
- func (m *Model) ShortHelpItems() []helpbar.HelpEntry
- func (m *Model) Update(msg tea.Msg) tea.Cmd
- func (m *Model) View() string
- type PollRetryMsg
- type SortField
- type SpinnerTickMsg
- type TickMsg
Constants ¶
const ViewName = "configs"
Variables ¶
var PollInterval = 5 * time.Second
PollInterval is how often the view re-reads its resource. 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 GetConfigsHelpContent ¶
func GetConfigsHelpContent() []helpview.HelpCategory
GetConfigsHelpContent returns categorized help for the configs view
Types ¶
type Model ¶
type Model struct {
// contains filtered or unexported fields
}
func (*Model) ApplySearchQuery ¶
ApplySearchQuery sets the filter query on the primary configs list.
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 on the primary configs list.
func (*Model) FrameContent ¶
func (*Model) FrameFooter ¶
func (*Model) FrameHeader ¶
func (*Model) FrameTitle ¶
func (*Model) HasActiveFilter ¶
HasActiveFilter reports whether a filter query is active.
func (*Model) HelpContent ¶ added in v1.14.0
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) IsInUsedByView ¶
IsInUsedByView returns true if currently viewing the used-by list
func (*Model) IsSearching ¶
IsSearching reports whether the configs view is in a sub-view that should capture keys (e.g. usedBy sub-list).
func (*Model) ShortHelpItems ¶
type PollRetryMsg ¶
type PollRetryMsg struct{}
PollRetryMsg signals that polling found no changes; the Update handler should schedule the next tick.