common

Documentation

Index

• Constants
• func GetRandomLoadingMessage() string
• func GetRandomPlaceholder() string
• func Title(s string) string
• type EmbedableModel
  • func (m EmbedableModel) Back() bool
  • func (m EmbedableModel) Quit() bool
• type Spinner
  • func NewSpinner() Spinner
  • func (s Spinner) View() string
• type SubModel
• type SubModelBase
• type TabModel

Constants

const (
	Available   = "✅"
	Unavailable = "❌"

	Selected   = "☑"
	Unselected = "☐"
)

const Ellipsis = "…"

Functions

func GetRandomLoadingMessage

func GetRandomLoadingMessage() string

GetRandomLoadingMessage returns a random loading message.

func GetRandomPlaceholder

func GetRandomPlaceholder() string

func Title

func Title(s string) string

Types

type EmbedableModel

type EmbedableModel struct {
	Width  int
	Height int

	IsQuit bool
	IsBack bool
}

EmbedableModel is a model that can be embedded in other models. It provides some basic functionality that is common to all models.

func (EmbedableModel) Back

func (m EmbedableModel) Back() bool

func (EmbedableModel) Quit

func (m EmbedableModel) Quit() bool

type Spinner

type Spinner struct {
	spinner.Model
	Message string
}

func NewSpinner

func NewSpinner() Spinner

func (Spinner) View

func (s Spinner) View() string

type SubModel

type SubModel interface {
	SubModelBase

	Update(msg tea.Msg) (SubModel, tea.Cmd)
}

type SubModelBase

type SubModelBase interface {
	// some bubbleteaish Model methods
	Init() tea.Cmd
	View() string

	// some custom methods
	// SetSize sets the width and height of the model
	SetSize(width, height int)

	// Quit returns true if the model should quit
	Quit() bool

	// Back returns true if the model should go back
	Back() bool
}

type TabModel

type TabModel interface {
	SubModelBase

	Title() string
	Update(msg tea.Msg) (TabModel, tea.Cmd)
}