header

Documentation

Index

• type Model
  • func New(title string, opts ...Option) *Model
  • func (m *Model) Height() int
  • func (*Model) Init() tea.Cmd
  • func (m *Model) Resize(width, _ int) bubbles.Model
  • func (m *Model) Update(_ tea.Msg) (tea.Model, tea.Cmd)
  • func (m *Model) View() string
  • func (m *Model) Width() int
• type Option
  • func WithBorder() Option
  • func WithDesc(desc string) Option
  • func WithVersion(ver string) Option

Types

type Model

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

Model defines a header TUI component

func New

func New(title string, opts ...Option) *Model

New creates a new model with a given title. Further customization can be achieved by providing additional options:

hdr := New("bubbles", WithDesc("a collection of TUI components"))

func (*Model) Height

func (m *Model) Height() int

Height returns the current height of the header

func (*Model) Init

func (*Model) Init() tea.Cmd

Init initialises the header

func (*Model) Resize

func (m *Model) Resize(width, _ int) bubbles.Model

Resize the dimensions of the header

func (*Model) Update

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

Update the current header

func (*Model) View

func (m *Model) View() string

View displays the header

func (*Model) Width

func (m *Model) Width() int

Width returns the current width of the header

type Option

type Option func(*Model)

Option defines options when creating a new model

func WithBorder

func WithBorder() Option

WithBorder provides an option for setting and displaying a border that underlines the header. This border will always be the width of the terminal

func WithDesc

func WithDesc(desc string) Option

WithDesc provides an option for setting and displaying a description underneath the header title. An empty string is ignored

func WithVersion

func WithVersion(ver string) Option

WithVersion provides an option for setting and displaying a version alongside the header title. An empty string is ignored