panels

Documentation

Index

• Variables
• type Item
  • func NewItem(item types.Item, viewport viewport.Model, theme styles.Theme) *Item
  • func (m *Item) Init() tea.Cmd
  • func (m *Item) ItemDefinition() types.Item
  • func (m *Item) Name() string
  • func (m *Item) SetContent(content string)
  • func (m *Item) SetError(err error)
  • func (m *Item) Theme() styles.Theme
  • func (m *Item) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m *Item) View() string
• type Logs
  • func NewLogs(keys LogsKeyMap, log *types.Logs, theme styles.Theme) *Logs
  • func (m *Logs) AddContent(content string)
  • func (m *Logs) Help() help.KeyMap
  • func (m *Logs) Init() tea.Cmd
  • func (m *Logs) LogDefinition() *types.Logs
  • func (m *Logs) Name() string
  • func (m *Logs) SetError(err error)
  • func (m *Logs) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m *Logs) View() string
• type LogsKeyMap
  • func (k LogsKeyMap) FullHelp() [][]key.Binding
  • func (k LogsKeyMap) ShortHelp() []key.Binding
• type RowInfo
• type Table
  • func NewTable(keys TableKeyMap, table *buoytypes.Table, theme styles.Theme) *Table
  • func (m *Table) AddOrUpdate(u *unstructured.Unstructured)
  • func (m *Table) Columns() []buoytypes.Column
  • func (m *Table) DeleteRow(uid types.UID)
  • func (m *Table) FetchContentForIndex(index int) (string, error)
  • func (m *Table) Help() help.KeyMap
  • func (m *Table) Init() tea.Cmd
  • func (m *Table) Name() string
  • func (m *Table) SetError(err error)
  • func (m *Table) SetLister(lister cache.GenericLister)
  • func (m *Table) SetScope(scope meta.RESTScopeName)
  • func (m *Table) TableDefinition() *buoytypes.Table
  • func (m *Table) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m *Table) View() string
• type TableKeyMap
  • func (k TableKeyMap) FullHelp() [][]key.Binding
  • func (k TableKeyMap) ShortHelp() []key.Binding

Variables

var DefaultLogsKeys = LogsKeyMap{
	Search: key.NewBinding(
		key.WithKeys("/"),
		key.WithHelp("/", "open a prompt to search logs"),
	),
	SubmitSearch: key.NewBinding(
		key.WithKeys("enter"),
		key.WithHelp("enter", "submit search prompt"),
	),
	QuitSearch: key.NewBinding(
		key.WithKeys("esc"),
		key.WithHelp("esc", "exit search mode"),
	),
	ToggleStrict: key.NewBinding(
		key.WithKeys("ctrl+s"),
		key.WithHelp("ctrl+s", "toggle strict search mode"),
	),
}

var DefaultTableKeys = TableKeyMap{
	ViewModeToggle: key.NewBinding(
		key.WithKeys("v"),
		key.WithHelp("v", "toggle viewing contents of selected resource"),
	),
}

Types

type Item

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

Item is a tea.Model implementation that represents an item panel

func NewItem

func NewItem(item types.Item, viewport viewport.Model, theme styles.Theme) *Item

func (*Item) Init

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

func (*Item) ItemDefinition

func (m *Item) ItemDefinition() types.Item

func (*Item) Name

func (m *Item) Name() string

func (*Item) SetContent

func (m *Item) SetContent(content string)

func (*Item) SetError

func (m *Item) SetError(err error)

func (*Item) Theme

func (m *Item) Theme() styles.Theme

func (*Item) Update

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

func (*Item) View

func (m *Item) View() string

type Logs

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

Logs is a tea.Model implementation that represents an item panel

func NewLogs

func NewLogs(keys LogsKeyMap, log *types.Logs, theme styles.Theme) *Logs

func (*Logs) AddContent

func (m *Logs) AddContent(content string)

func (*Logs) Help

func (m *Logs) Help() help.KeyMap

func (*Logs) Init

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

func (*Logs) LogDefinition

func (m *Logs) LogDefinition() *types.Logs

func (*Logs) Name

func (m *Logs) Name() string

func (*Logs) SetError

func (m *Logs) SetError(err error)

func (*Logs) Update

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

func (*Logs) View

func (m *Logs) View() string

type LogsKeyMap

type LogsKeyMap struct {
	Search       key.Binding
	SubmitSearch key.Binding
	QuitSearch   key.Binding
	ToggleStrict key.Binding
}

func (LogsKeyMap) FullHelp

func (k LogsKeyMap) FullHelp() [][]key.Binding

FullHelp returns keybindings for the expanded help view. It's part of the key.Map interface.

func (LogsKeyMap) ShortHelp

func (k LogsKeyMap) ShortHelp() []key.Binding

ShortHelp returns keybindings to be shown in the mini help view. It's part of the key.Map interface.

type RowInfo

type RowInfo struct {
	Row        tbl.Row
	Identifier *types.NamespacedName
	// Is this necessary? Can the index change on different iterations?
	Index int
}

type Table

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

Table is a tea.Model implementation that represents a table panel

func NewTable

func NewTable(keys TableKeyMap, table *buoytypes.Table, theme styles.Theme) *Table

func (*Table) AddOrUpdate

func (m *Table) AddOrUpdate(u *unstructured.Unstructured)

func (*Table) Columns

func (m *Table) Columns() []buoytypes.Column

func (*Table) DeleteRow

func (m *Table) DeleteRow(uid types.UID)

func (*Table) FetchContentForIndex

func (m *Table) FetchContentForIndex(index int) (string, error)

func (*Table) Help

func (m *Table) Help() help.KeyMap

func (*Table) Init

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

func (*Table) Name

func (m *Table) Name() string

func (*Table) SetError

func (m *Table) SetError(err error)

func (*Table) SetLister

func (m *Table) SetLister(lister cache.GenericLister)

func (*Table) SetScope

func (m *Table) SetScope(scope meta.RESTScopeName)

func (*Table) TableDefinition

func (m *Table) TableDefinition() *buoytypes.Table

func (*Table) Update

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

func (*Table) View

func (m *Table) View() string

type TableKeyMap

type TableKeyMap struct {
	ViewModeToggle key.Binding
}

func (TableKeyMap) FullHelp

func (k TableKeyMap) FullHelp() [][]key.Binding

FullHelp returns keybindings for the expanded help view. It's part of the key.Map interface.

func (TableKeyMap) ShortHelp

func (k TableKeyMap) ShortHelp() []key.Binding

ShortHelp returns keybindings to be shown in the mini help view. It's part of the key.Map interface.