common

Documentation

Index

• func CancelModalCmd() tea.Cmd
• func EmitBlockSelectedMsg(blockNum uint64) tea.Cmd
• func EmitModuleSelectedCmd(moduleName, target string) tea.Cmd
• func ErrorCmd(err error) tea.Cmd
• func SetModalComponentCmd(comp Component) tea.Cmd
• func SetRequestValueCmd(field, value string) tea.Cmd
• func ShortToFullHelp(comp Component) [][]key.Binding
• func TruncateString(s string, max int) string
• type BlockSelectedMsg
• type CancelModalMsg
• type Common
  • func (c *Common) GetHeight() int
  • func (c *Common) GetWidth() int
  • func (c *Common) SetSize(width, height int)
• type Component
• type ErrorMsg
• type GoToOutputMsg
• type IsFullWidthModal
• type IsInlineModal
• type ModuleSelectedMsg
• type SetModalComponentMsg
• type SetRequestValue
• type SimpleHelp
  • func NewSimpleHelp(bindings ...key.Binding) SimpleHelp
  • func (h SimpleHelp) FullHelp() [][]key.Binding
  • func (h SimpleHelp) ShortHelp() []key.Binding
• type UpdateSeenModulesMsg

Functions

func CancelModalCmd

func CancelModalCmd() tea.Cmd

func EmitBlockSelectedMsg

func EmitBlockSelectedMsg(blockNum uint64) tea.Cmd

func EmitModuleSelectedCmd

func EmitModuleSelectedCmd(moduleName, target string) tea.Cmd

func ErrorCmd

func ErrorCmd(err error) tea.Cmd

ErrorCmd returns an ErrorMsg from error.

func SetModalComponentCmd

func SetModalComponentCmd(comp Component) tea.Cmd

func SetRequestValueCmd

func SetRequestValueCmd(field, value string) tea.Cmd

func ShortToFullHelp

func ShortToFullHelp(comp Component) [][]key.Binding

func TruncateString

func TruncateString(s string, max int) string

TruncateString is a convenient wrapper around truncate.TruncateString.

Types

type BlockSelectedMsg

type BlockSelectedMsg uint64 // Emitted to inform all components that a new block has been selected.

type CancelModalMsg

type CancelModalMsg struct{} // Emitted by components to close itselt

type Common

type Common struct {
	Width  int
	Height int
}

Common is a struct all components should embed.

func (*Common) GetHeight

func (c *Common) GetHeight() int

func (*Common) GetWidth

func (c *Common) GetWidth() int

func (*Common) SetSize

func (c *Common) SetSize(width, height int)

SetSize sets the width and height of the common struct.

type Component

type Component interface {
	tea.Model
	help.KeyMap
	SetSize(width, height int)
	GetWidth() int
	GetHeight() int
}

Component represents a Bubble Tea model that implements a SetSize function.

type ErrorMsg

type ErrorMsg error

ErrorMsg is a Bubble Tea message that represents an error.

type GoToOutputMsg

type GoToOutputMsg struct{}

type IsFullWidthModal

type IsFullWidthModal interface {
	IsFullWidthModal()
}

type IsInlineModal

type IsInlineModal interface {
	IsInlineModal()
}

type ModuleSelectedMsg

type ModuleSelectedMsg struct {
	Target     string
	ModuleName string
}

type SetModalComponentMsg

type SetModalComponentMsg Component

type SetRequestValue

type SetRequestValue struct {
	Field string
	Value string
}

type SimpleHelp

type SimpleHelp struct {
	Bindings []key.Binding
}

func NewSimpleHelp

func NewSimpleHelp(bindings ...key.Binding) SimpleHelp

func (SimpleHelp) FullHelp

func (h SimpleHelp) FullHelp() [][]key.Binding

func (SimpleHelp) ShortHelp

func (h SimpleHelp) ShortHelp() []key.Binding

type UpdateSeenModulesMsg

type UpdateSeenModulesMsg []string