bubbletea

Documentation

Index

• func Window(width int, height int, fonts crt.Fonts, model tea.Model, defaultBg color.Color, ...) (*crt.Window, *tea.Program, error)
• type Adapter
  • func NewAdapter(prog *tea.Program, options ...Options) *Adapter
  • func (b *Adapter) HandleKeyPress()
  • func (b *Adapter) HandleMouseButton(button crt.MouseButton)
  • func (b *Adapter) HandleMouseMotion(motion crt.MouseMotion)
  • func (b *Adapter) HandleMouseWheel(wheel crt.MouseWheel)
  • func (b *Adapter) HandleWindowSize(size crt.WindowSize)
• type Options
  • func WithFilterMousePressed(filter bool) Options

Functions

func Window

func Window(width int, height int, fonts crt.Fonts, model tea.Model, defaultBg color.Color, options ...tea.ProgramOption) (*crt.Window, *tea.Program, error)

Window creates a new crt based bubbletea window with the given width, height, fonts, model and default background color. Additional options can be passed to the bubbletea program.

Types

type Adapter

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

Adapter represents a bubbletea adapter for the crt package.

func NewAdapter

func NewAdapter(prog *tea.Program, options ...Options) *Adapter

NewAdapter creates a new bubbletea adapter.

func (*Adapter) HandleKeyPress

func (b *Adapter) HandleKeyPress()

func (*Adapter) HandleMouseButton

func (b *Adapter) HandleMouseButton(button crt.MouseButton)

func (*Adapter) HandleMouseMotion

func (b *Adapter) HandleMouseMotion(motion crt.MouseMotion)

func (*Adapter) HandleMouseWheel

func (b *Adapter) HandleMouseWheel(wheel crt.MouseWheel)

func (*Adapter) HandleWindowSize

func (b *Adapter) HandleWindowSize(size crt.WindowSize)

type Options

type Options func(*Adapter)

Options are used to configure the adapter.

func WithFilterMousePressed

func WithFilterMousePressed(filter bool) Options

WithFilterMousePressed filters the MousePressed event and only emits MouseReleased events.