tui

Documentation

Overview

Package tui provides filter and debounce utilities for the TUI model.

Package tui defines message types for the TUI model.

Package tui implements the core TUI model and logic for the toolkit application. It provides the Model struct and related helpers for managing state, events, and rendering using Bubble Tea and Charmbracelet components.

Package tui contains reducer and event logic for the Model. This file contains methods for state transitions, event handling, and UI updates.

Package tui contains the Model struct and constructor for the toolkit TUI. This file defines the main state container and its initialization logic.

Package tui implements the update/reduce logic for the Model.

Package tui implements the view and rendering logic for the Model.

Index

• func DebounceFilter(m *Model) tea.Cmd
• func FilterTable(m *Model, filter string)
• type DataMsg
• type ErrMsg
• type FilterMsg
• type Model
  • func NewModel(opts ...ModelOption) (*Model, error)
  • func (m *Model) Init() tea.Cmd
  • func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m *Model) View() string
• type ModelOption
  • func WithCategory(category domain.Category) ModelOption
  • func WithContext(ctx context.Context) ModelOption
  • func WithEnvironment(env models.Environment) ModelOption
  • func WithFilter(filter string) ModelOption
  • func WithKubeConfig(kubeConfig string) ModelOption
  • func WithLoader(l loader.Loader) ModelOption
  • func WithLogger(logger logging.Logger) ModelOption
  • func WithRepoPath(repoPath string) ModelOption
  • func WithTable(tbl *table.Model) ModelOption
  • func WithVersion(v string) ModelOption
• type SetFilterMsg

Functions

func DebounceFilter

func DebounceFilter(m *Model) tea.Cmd

DebounceFilter triggers a debounced filter update for the model's text input.

func FilterTable

func FilterTable(m *Model, filter string)

FilterTable updates the model's filter and rows if the filter has changed.

Types

type DataMsg

type DataMsg struct{ Data any }

DataMsg is a message containing generic data.

type ErrMsg

type ErrMsg error

ErrMsg is a message containing an error.

type FilterMsg

type FilterMsg string

FilterMsg is a message containing filter text.

type Model

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

Model represents the main TUI model for the toolkit application. It manages state, events, and rendering for the Bubble Tea UI.

func NewModel

func NewModel(opts ...ModelOption) (*Model, error)

NewModel creates a new Model for the toolkit TUI, applying the given options.

func (*Model) Init

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

Init implements the tea.Model interface and initializes the model.

func (*Model) Update

func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)

Update implements the tea.Model interface and updates the Model state in response to a message.

func (*Model) View

func (m *Model) View() string

View renders the current state of the model as a string.

type ModelOption

type ModelOption func(*Model)

ModelOption defines a functional option for configuring Model.

func WithCategory

func WithCategory(category domain.Category) ModelOption

WithCategory sets the category field for the Model.

func WithContext

func WithContext(ctx context.Context) ModelOption

WithContext sets the context.Context for the Model.

func WithEnvironment

func WithEnvironment(env models.Environment) ModelOption

WithEnvironment sets the environment field.

func WithFilter

func WithFilter(filter string) ModelOption

WithFilter sets a starting filter before Init().

func WithKubeConfig

func WithKubeConfig(kubeConfig string) ModelOption

WithKubeConfig sets the kubeConfig field.

func WithLoader

func WithLoader(l loader.Loader) ModelOption

WithLoader sets the Loader implementation for the Model. The Loader interface must implement all loader interfaces (DatasetLoader, BaseModelLoader, GpuPoolLoader, GpuNodeLoader, DedicatedAIClusterLoader).

func WithLogger

func WithLogger(logger logging.Logger) ModelOption

WithLogger sets the logger for the Model.

func WithRepoPath

func WithRepoPath(repoPath string) ModelOption

WithRepoPath sets the repoPath field.

func WithTable

func WithTable(tbl *table.Model) ModelOption

WithTable sets the table.Model.

func WithVersion

func WithVersion(v string) ModelOption

WithVersion sets the version of the Model.

type SetFilterMsg

type SetFilterMsg string

SetFilterMsg is a message to set the filter text in the model.