Help us shape the future of Go! Take the 2026 Go Developer Survey

Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

core

package

Go to main page

Versions in this module

v0

v0.1.38

Oct 15, 2026

v0.1.37

Oct 1, 2026

v0.1.36

Sep 29, 2026

Changes in this version

+ type Disposer interface

+ Dispose func()

+ type PageMsg struct

+ Ctx string

+ Gen uint64

+ Msg tea.Msg

+ PageID string

v0.1.35

Aug 9, 2026

Changes in this version

+ const DoubleClickWindow

+ func IsHover(msg tea.MouseMsg) bool

+ func IsLeftRelease(msg tea.MouseMsg) bool

+ func ScopeOf(page any) keys.Scope

+ type ActionProvider interface

+ ContextActions func() []menu.Entry

+ type ClickTracker struct

+ func (c *ClickTracker) Click(msg tea.MouseMsg) (double bool)

+ type InputModeReporter interface

+ IsInputMode func() bool

+ type KeyScoper interface

+ KeyScope func() keys.Scope

+ type PaletteProvider interface

+ PaletteEntries func() []menu.Entry

+ type Unwinder interface

+ Unwind func() (tea.Cmd, bool)

v0.1.34

Aug 3, 2026

Changes in this version

+ func BatchCommands(cmds ...tea.Cmd) tea.Cmd

+ func CalculateTableDimensions(totalWidth int, columnWeights []float64) []int

+ func CenterString(s string, width int) string

+ func CreateTimer(id string, duration time.Duration) tea.Cmd

+ func DebugMessage(format string, args ...interface{}) tea.Cmd

+ func FormatBytes(bytes int64) string

+ func FormatCount(count int) string

+ func FormatDuration(d time.Duration) string

+ func FormatStatusMessage(message string, statusType StatusType) string

+ func FormatTime(t time.Time) string

+ func HighlightMatches(text, query string) string

+ func IsKeyMatch(msg tea.KeyMsg, bindings ...key.Binding) bool

+ func MaxLength(maxLen int) func(string) error

+ func MinLength(minLen int) func(string) error

+ func NewConsumerGroupsLoadErrorMsg(err error) tea.Cmd

+ func NewConsumerGroupsLoadedMsg(groups []api.ConsumerGroup) tea.Cmd

+ func NewContextsLoadErrorMsg(err error) tea.Cmd

+ func NewContextsLoadedMsg(contexts []string) tea.Cmd

+ func NewDataErrorMsg(dataType string, err error) tea.Cmd

+ func NewDataLoadedMsg(dataType string, data interface{}) tea.Cmd

+ func NewErrorMsg(message string) tea.Cmd

+ func NewInfoMsg(message string) tea.Cmd

+ func NewMessageConsumeErrorMsg(err error) tea.Cmd

+ func NewMessagesConsumedMsg(messages []api.Message) tea.Cmd

+ func NewNotification(sev StatusType, title, message string) tea.Cmd

+ func NewPageChangeMsg(pageID string, data interface{}) tea.Cmd

+ func NewPermanentErrorMsg(message string) tea.Cmd

+ func NewResourceSelectedMsg(resourceID, resourceType string, item interface{}) tea.Cmd

+ func NewSchemasLoadErrorMsg(err error) tea.Cmd

+ func NewSchemasLoadedMsg(schemas []api.SchemaInfo) tea.Cmd

+ func NewStatusMsg(message string, statusType StatusType) tea.Cmd

+ func NewSuccessMsg(message string) tea.Cmd

+ func NewTopicsLoadErrorMsg(err error) tea.Cmd

+ func NewTopicsLoadedMsg(topics map[string]api.Topic) tea.Cmd

+ func NewWarningMsg(message string) tea.Cmd

+ func NotEmpty(input string) error

+ func NotifyError(title string, err error) tea.Cmd

+ func PadString(s string, width int) string

+ func RetryWithBackoff(cmd tea.Cmd, config RetryConfig) tea.Cmd

+ func TruncateString(s string, maxLen int) string

+ func ValidateStringInput(input string, rules ...func(string) error) error

+ func WrapText(text string, width int) []string

+ type BackMsg struct

+ type BaseComponent struct

+ func NewBaseComponent(width, height int) BaseComponent

+ func (b *BaseComponent) ApplyConfig(config ComponentConfig)

+ func (b *BaseComponent) GetHeight() int

+ func (b *BaseComponent) GetID() string

+ func (b *BaseComponent) GetWidth() int

+ func (b *BaseComponent) Init() tea.Cmd

+ func (b *BaseComponent) SetDimensions(width, height int)

+ func (b *BaseComponent) SetID(id string)

+ func (b *BaseComponent) Update(msg tea.Msg) (tea.Model, tea.Cmd)

+ func (b *BaseComponent) View() string

+ type BreadcrumbUpdateMsg struct

+ Items []string

+ type ClearSearchMsg struct

+ type Common struct

+ AppConfig *appconfig.Config

+ Collector *cluster.Collector

+ Config *UIConfig

+ DataSource api.KafkaDataSource

+ Gate *authz.Gate

+ Identity string

+ InitialResource string

+ Layout *layout.Layout

+ LayoutConfig *layout.LayoutConfig

+ MetricsCollector *metrics.Collector

+ Redactor *appconfig.Redactor

+ Styles *stylesPkg.Styles

+ func NewCommon(dataSource api.KafkaDataSource) *Common

+ func NewCommonWithConfig(dataSource api.KafkaDataSource, config *UIConfig) *Common

+ func (c *Common) ActiveCapabilities() []api.Capability

+ func (c *Common) ActiveProfileName() string

+ func (c *Common) ApplyAppConfig(cfg appconfig.Config)

+ func (c *Common) AuthzEnabled() bool

+ func (c *Common) Can(action authz.Action, rt authz.ResourceType, name string) bool

+ func (c *Common) GetLayout(width, height int) *layout.Layout

+ func (c *Common) HasCapability(cap api.Capability) bool

+ func (c *Common) IsReadOnly() bool

+ func (c *Common) UpdateLayout(width, height int)

+ type Component interface

+ Init func() tea.Cmd

+ SetDimensions func(width, height int)

+ Update func(msg tea.Msg) (tea.Model, tea.Cmd)

+ View func() string

+ type ComponentConfig struct

+ Common *Common

+ Height int

+ ID string

+ Width int

+ type ComponentWithLayout interface

+ GetLayout func() layout.Rectangle

+ SetLayout func(rect layout.Rectangle)

+ type ConfigReloadedMsg struct

+ Config interface{}

+ type ConfirmResolvedMsg struct

+ Confirmed bool

+ type ConnectionState uint8

+ const ConnectionConnected

+ const ConnectionDisconnected

+ const ConnectionReconnecting

+ const ConnectionUnknown

+ func (c ConnectionState) String() string

+ type ConsumerGroupsLoadErrorMsg struct

+ Error error

+ type ConsumerGroupsLoadedMsg struct

+ Groups []api.ConsumerGroup

+ type ConsumptionErrorMsg struct

+ Error error

+ TopicName string

+ type ConsumptionStartedMsg struct

+ TopicName string

+ type ConsumptionStoppedMsg struct

+ TopicName string

+ type ContextsLoadErrorMsg struct

+ Error error

+ type ContextsLoadedMsg struct

+ Contexts []string

+ type DataErrorMsg struct

+ Error error

+ Type string

+ type DataLoadedMsg struct

+ Data interface{}

+ Type string

+ type DataLoader interface

+ LoadData func() tea.Cmd

+ RefreshData func() tea.Cmd

+ type DetailPageCloseMsg struct

+ type DetailPageOpenMsg struct

+ Data interface{}

+ ResourceID string

+ ResourceType string

+ type Dimensions struct

+ Height int

+ Width int

+ type DimensionsUpdateMsg struct

+ Height int

+ Width int

+ type EventHandler interface

+ HandleDataEvent func(msg DataLoadedMsg) tea.Cmd

+ HandleErrorEvent func(msg DataErrorMsg) tea.Cmd

+ HandleKeyEvent func(msg tea.KeyMsg) tea.Cmd

+ HandleTimerEvent func(msg TimerTickMsg) tea.Cmd

+ type FilterAppliedMsg struct

+ Count int

+ Query string

+ type FocusManager struct

+ func NewFocusManager() *FocusManager

+ func (fm *FocusManager) AddComponent(component Focusable)

+ func (fm *FocusManager) Clear()

+ func (fm *FocusManager) FocusComponent(id string) tea.Cmd

+ func (fm *FocusManager) FocusNext() tea.Cmd

+ func (fm *FocusManager) FocusPrevious() tea.Cmd

+ func (fm *FocusManager) GetComponentCount() int

+ func (fm *FocusManager) GetFocusableComponents() []Focusable

+ func (fm *FocusManager) GetFocusedComponent() Focusable

+ func (fm *FocusManager) GetFocusedComponentID() string

+ func (fm *FocusManager) HandleKeyMsg(msg tea.KeyMsg) tea.Cmd

+ func (fm *FocusManager) IsEnabled() bool

+ func (fm *FocusManager) RemoveComponent(id string)

+ func (fm *FocusManager) SetEnabled(enabled bool)

+ type FocusState uint8

+ const FocusFooter

+ const FocusMain

+ const FocusNone

+ const FocusSearch

+ const FocusSidebar

+ func (f FocusState) String() string

+ type Focusable interface

+ Blur func() tea.Cmd

+ CanFocus func() bool

+ Focus func() tea.Cmd

+ GetID func() string

+ IsFocused func() bool

+ type FocusableComponent struct

+ func NewFocusableComponent(id string) *FocusableComponent

+ func (f *FocusableComponent) Blur() tea.Cmd

+ func (f *FocusableComponent) CanFocus() bool

+ func (f *FocusableComponent) Focus() tea.Cmd

+ func (f *FocusableComponent) GetID() string

+ func (f *FocusableComponent) IsFocused() bool

+ func (f *FocusableComponent) SetCanFocus(canFocus bool)

+ type HelpBinding struct

+ Description string

+ Important bool

+ Key string

+ type HelpSection struct

+ Bindings []HelpBinding

+ Title string

+ type HelpStyles struct

+ Container lipgloss.Style

+ Description lipgloss.Style

+ Footer lipgloss.Style

+ KeyBinding lipgloss.Style

+ SectionTitle lipgloss.Style

+ Separator lipgloss.Style

+ Title lipgloss.Style

+ type HelpSystem struct

+ func NewHelpSystem() *HelpSystem

+ func (h *HelpSystem) GetKeyBindingHelp(keyBinding key.Binding) string

+ func (h *HelpSystem) GetQuickHelp() string

+ func (h *HelpSystem) Hide()

+ func (h *HelpSystem) IsVisible() bool

+ func (h *HelpSystem) Render() string

+ func (h *HelpSystem) SetCurrentPage(page Page)

+ func (h *HelpSystem) SetDimensions(width, height int)

+ func (h *HelpSystem) Show()

+ func (h *HelpSystem) Toggle()

+ type KeyBinding struct

+ Help string

+ Key key.Binding

+ type KeyHandler interface

+ GetKeyBindings func() []key.Binding

+ HandleKey func(key tea.KeyMsg) tea.Cmd

+ type LoadingMsg struct

+ Active bool

+ Label string

+ type LoadingState uint8

+ const LoadingIdle

+ const LoadingInitial

+ const LoadingMore

+ const LoadingRefresh

+ type MessageConsumeErrorMsg struct

+ Error error

+ type MessageConsumedMsg struct

+ Message interface{}

+ type MessagesConsumedMsg struct

+ Messages []api.Message

+ type NotificationMsg struct

+ Message string

+ Severity StatusType

+ Sticky bool

+ Title string

+ type Page interface

+ GetHelp func() []key.Binding

+ GetID func() string

+ GetTitle func() string

+ HandleNavigation func(msg tea.Msg) (Page, tea.Cmd)

+ Init func() tea.Cmd

+ OnBlur func() tea.Cmd

+ OnFocus func() tea.Cmd

+ SetDimensions func(width, height int)

+ Update func(msg tea.Msg) (tea.Model, tea.Cmd)

+ View func() string

+ type PageChangeMsg struct

+ Data interface{}

+ PageID string

+ type QuitMsg struct

+ type RefreshDataMsg struct

+ Type string

+ type ResourceChangeMsg struct

+ Data interface{}

+ ResourceType string

+ type ResourceLoadMsg struct

+ ResourceType string

+ type ResourceManager interface

+ GetCurrentResourceType func() string

+ LoadResources func() tea.Cmd

+ SwitchResource func(resourceType string) tea.Cmd

+ type ResourceSelectedMsg struct

+ Item interface{}

+ ResourceID string

+ ResourceType string

+ type RetryCommand struct

+ Cmd tea.Cmd

+ Config RetryConfig

+ OnError func(err error, attempt int) tea.Cmd

+ OnSuccess func(result tea.Msg) tea.Cmd

+ State *RetryState

+ func NewRetryCommand(cmd tea.Cmd, config RetryConfig) *RetryCommand

+ func (rc *RetryCommand) Execute() tea.Cmd

+ type RetryConfig struct

+ InitialDelay time.Duration

+ Jitter float64

+ MaxDelay time.Duration

+ MaxRetries int

+ Multiplier float64

+ func DefaultRetryConfig() RetryConfig

+ type RetryError struct

+ Attempt int

+ Err error

+ MaxRetries int

+ func (re *RetryError) Error() string

+ func (re *RetryError) Unwrap() error

+ type RetryState struct

+ Attempt int

+ Config RetryConfig

+ LastError error

+ NextRetry time.Time

+ func NewRetryState(config RetryConfig) *RetryState

+ func (rs *RetryState) CanRetry() bool

+ func (rs *RetryState) GetDelay() time.Duration

+ func (rs *RetryState) RecordAttempt(err error) time.Duration

+ func (rs *RetryState) Reset()

+ type RetryableOperation struct

+ Config RetryConfig

+ Operation func() (T, error)

+ func NewRetryableOperation[T any](operation func() (T, error), config RetryConfig) *RetryableOperation[T]

+ func (ro *RetryableOperation[T]) Execute() (T, error)

+ type SchemasLoadErrorMsg struct

+ Error error

+ type SchemasLoadedMsg struct

+ Schemas []api.SchemaInfo

+ type SearchMode int

+ const SearchModeAdvanced

+ const SearchModeFuzzy

+ const SearchModeRegex

+ const SearchModeSimple

+ type SearchModeChangeMsg struct

+ Mode SearchMode

+ type SearchMsg struct

+ Mode SearchMode

+ Query string

+ type ShowConfirmMsg struct

+ ConfirmLabel string

+ Danger bool

+ Message string

+ OnConfirm tea.Cmd

+ Title string

+ type SidebarToggledMsg struct

+ Visible bool

+ type StatefulPage interface

+ GetFocusState func() FocusState

+ GetState func() UIState

+ SetFocusState func(FocusState)

+ SetState func(UIState)

+ type StatusBarConfig struct

+ DefaultTTL time.Duration

+ MaxMessageLength int

+ ShowByDefault bool

+ func DefaultStatusBarConfig() StatusBarConfig

+ type StatusMessage struct

+ Message string

+ TTL time.Duration

+ Timestamp time.Time

+ Type StatusType

+ func NewStatusMessage(statusType StatusType, message string, ttl time.Duration) StatusMessage

+ func (sm StatusMessage) IsExpired() bool

+ type StatusMsg struct

+ Message string

+ Type StatusType

+ type StatusType int

+ const StatusError

+ const StatusInfo

+ const StatusSuccess

+ const StatusWarning

+ type Theme struct

+ Accent string

+ Error string

+ Info string

+ Primary string

+ Secondary string

+ Success string

+ Warning string

+ type TimerTickMsg struct

+ ID string

+ Time time.Time

+ type TopicSelectedMsg struct

+ Topic interface{}

+ TopicName string

+ type TopicsLoadErrorMsg struct

+ Error error

+ type TopicsLoadedMsg struct

+ Topics map[string]api.Topic

+ type UIConfig struct

+ CompactMode bool

+ ConsumerGroupRefreshInterval time.Duration

+ ScreenshotDir string

+ ShowSidebar bool

+ Theme string

+ func DefaultUIConfig() *UIConfig

+ type UIState uint8

+ const StateHelp

+ const StateModal

+ const StateNormal

+ const StateSearch

+ func (s UIState) String() string

+ type ViewRenderer interface

+ Render func(model interface{}) string

+ SetDimensions func(width, height int)

+ SetTheme func(theme Theme)

+ type WindowSizeMsg struct

+ Height int

+ Width int