progress

Documentation

Index

• type IndexConfig
• type IndexProgressModel
  • func NewIndexProgressModel(path string, cfg IndexConfig, th theme.Theme) *IndexProgressModel
  • func (m *IndexProgressModel) Err() error
  • func (m *IndexProgressModel) Init() tea.Cmd
  • func (m *IndexProgressModel) Tree() *treeview.Tree[treeview.FileInfo]
  • func (m *IndexProgressModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m *IndexProgressModel) View() tea.View
• type MetadataProgressModel
  • func NewMetadataProgressModel(tree *treeview.Tree[treeview.FileInfo], cfg *config.FormatConfig, ...) *MetadataProgressModel
  • func (m *MetadataProgressModel) Err() error
  • func (m *MetadataProgressModel) Init() tea.Cmd
  • func (m *MetadataProgressModel) Metadata() map[string]*provider.Metadata
  • func (m *MetadataProgressModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m *MetadataProgressModel) View() tea.View

Types

type IndexConfig

type IndexConfig struct {
	MaxDepth    int
	IncludeDirs bool
	Filter      func(treeview.FileInfo) bool
}

IndexConfig carries the knobs required to build and annotate the tree.

type IndexProgressModel

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

IndexProgressModel is a dedicated Bubble Tea model that displays a full-screen progress UI while the filesystem is being indexed into a tree. Once complete the caller can extract the constructed tree and transition to the main UI.

func NewIndexProgressModel

func NewIndexProgressModel(path string, cfg IndexConfig, th theme.Theme) *IndexProgressModel

NewIndexProgressModel creates a model and pre computes root entry count.

func (*IndexProgressModel) Err

func (m *IndexProgressModel) Err() error

Err returns any build error.

func (*IndexProgressModel) Init

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

Init kicks off asynchronous tree building.

func (*IndexProgressModel) Tree

func (m *IndexProgressModel) Tree() *treeview.Tree[treeview.FileInfo]

Tree returns the constructed tree.

func (*IndexProgressModel) Update

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

Update processes Bubble Tea messages.

func (*IndexProgressModel) View

func (m *IndexProgressModel) View() tea.View

View renders the progress UI.

type MetadataProgressModel

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

MetadataProgressModel displays progress while fetching metadata from providers.

func NewMetadataProgressModel

func NewMetadataProgressModel(tree *treeview.Tree[treeview.FileInfo], cfg *config.FormatConfig, th theme.Theme) *MetadataProgressModel

NewMetadataProgressModel creates a new metadata progress model.

func (*MetadataProgressModel) Err

func (m *MetadataProgressModel) Err() error

Err returns any fatal error encountered during metadata fetching.

func (*MetadataProgressModel) Init

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

Init starts the metadata engine if providers are configured.

func (*MetadataProgressModel) Metadata

func (m *MetadataProgressModel) Metadata() map[string]*provider.Metadata

Metadata returns the fetched metadata.

func (*MetadataProgressModel) Update

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

Update processes Bubble Tea messages.

func (*MetadataProgressModel) View

func (m *MetadataProgressModel) View() tea.View

View renders the progress UI.