ui

Documentation

Overview

Package ui provides terminal user interface components.

This package implements the terminal-based dashboard using tview, including table components, keyboard navigation, and real-time data updates for migration monitoring.

Index

• type Dashboard
  • func NewDashboard() *Dashboard
  • func (d *Dashboard) Cleanup()
  • func (d *Dashboard) HideRefreshing()
  • func (d *Dashboard) SetRefreshFunc(f func())
  • func (d *Dashboard) SetupGrid() *tview.Grid
  • func (d *Dashboard) SetupKeyboardNavigation(app *tview.Application, grid *tview.Grid)
  • func (d *Dashboard) ShowProgress(message string)
  • func (d *Dashboard) ShowRefreshing()
  • func (d *Dashboard) UpdateData(summary *models.MigrationSummary, organization string)
• type FilterOption
• type MigrationTable
  • func NewMigrationTable(title string) *MigrationTable
  • func (mt *MigrationTable) GetTitle() string
  • func (mt *MigrationTable) SetTitleWithOrganizationAndFilter(organization, filter string)
  • func (mt *MigrationTable) UpdateData(migrations []models.Migration)
  • func (mt *MigrationTable) UpdateDataWithStatus(migrations []models.Migration)

Types

type Dashboard

type Dashboard struct {
	AllMigrations *MigrationTable
	CommandBar    *tview.TextView
	StatusBar     *tview.TextView
	SearchInput   *tview.InputField
	MainGrid      *tview.Grid
	// contains filtered or unexported fields
}

Dashboard represents the main UI dashboard

func NewDashboard

func NewDashboard() *Dashboard

NewDashboard creates a new UI dashboard

func (*Dashboard) Cleanup

func (d *Dashboard) Cleanup()

Cleanup cancels any running goroutines and cleans up resources

func (*Dashboard) HideRefreshing

func (d *Dashboard) HideRefreshing()

HideRefreshing hides the loading indicator and shows last update time

func (*Dashboard) SetRefreshFunc

func (d *Dashboard) SetRefreshFunc(f func())

SetRefreshFunc sets the function to call when refresh is triggered

func (*Dashboard) SetupGrid

func (d *Dashboard) SetupGrid() *tview.Grid

SetupGrid creates and configures the grid layout

func (*Dashboard) SetupKeyboardNavigation

func (d *Dashboard) SetupKeyboardNavigation(app *tview.Application, grid *tview.Grid)

SetupKeyboardNavigation configures keyboard event handling

func (*Dashboard) ShowProgress

func (d *Dashboard) ShowProgress(message string)

ShowProgress shows progress with animated dots

func (*Dashboard) ShowRefreshing

func (d *Dashboard) ShowRefreshing()

ShowRefreshing displays a loading indicator with animation

func (*Dashboard) UpdateData

func (d *Dashboard) UpdateData(summary *models.MigrationSummary, organization string)

UpdateData updates the table with new migration data

type FilterOption

type FilterOption string

FilterOption represents different filter options

const (
	FilterAll        FilterOption = "All"
	FilterQueued     FilterOption = "Queued"
	FilterInProgress FilterOption = "In Progress"
	FilterSucceeded  FilterOption = "Succeeded"
	FilterFailed     FilterOption = "Failed"
)

type MigrationTable

type MigrationTable struct {
	*tview.Table
	// contains filtered or unexported fields
}

MigrationTable represents a table for displaying migrations

func NewMigrationTable

func NewMigrationTable(title string) *MigrationTable

NewMigrationTable creates a new migration table

func (*MigrationTable) GetTitle

func (mt *MigrationTable) GetTitle() string

GetTitle returns the table title

func (*MigrationTable) SetTitleWithOrganizationAndFilter

func (mt *MigrationTable) SetTitleWithOrganizationAndFilter(organization, filter string)

SetTitleWithOrganizationAndFilter updates the table title to include organization and filter

func (*MigrationTable) UpdateData

func (mt *MigrationTable) UpdateData(migrations []models.Migration)

UpdateData updates the table with new migration data

func (*MigrationTable) UpdateDataWithStatus

func (mt *MigrationTable) UpdateDataWithStatus(migrations []models.Migration)

UpdateDataWithStatus updates the table with migration data including status information