terminal

Documentation

Index

• Variables
• type Params
• type Screen
• type ScreenCapture
• type UI
  • func NewUI(ctx context.Context, params Params) (*UI, error)
  • func (ui *UI) Close()
  • func (ui *UI) Run(ctx context.Context) error
  • func (ui *UI) Wait()

Variables

var ErrUserClosed = errors.New("user closed UI")

Types

type Params

type Params struct {
	EventBus           *event.Bus
	Dispatcher         func(event.Command)
	Logger             *slog.Logger
	ClipboardAvailable bool
	BuildInfo          domain.BuildInfo
	Screen             *Screen // Screen may be nil.
}

Params contains the parameters for starting a new terminal user interface.

type Screen

type Screen struct {
	Screen        tcell.Screen
	Width, Height int
	CaptureC      chan<- ScreenCapture
}

Screen represents a terminal screen. This includes its desired dimensions, which is required to initialize the tcell.SimulationScreen.

type ScreenCapture

type ScreenCapture struct {
	Cells         []tcell.SimCell
	Width, Height int
}

ScreenCapture represents a screen capture, which is used for integration testing with the tcell.SimulationScreen.

type UI

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

UI is responsible for managing the terminal user interface.

func NewUI

func NewUI(ctx context.Context, params Params) (*UI, error)

NewUI creates the user interface. Call [Run] on the *UI instance to block until it is completed.

func (*UI) Close

func (ui *UI) Close()

Close closes the terminal user interface.

func (*UI) Run

func (ui *UI) Run(ctx context.Context) error

Run runs the user interface. It always returns a non-nil error, which will be ErrUserClosed if the user voluntarily closed the UI.

func (*UI) Wait

func (ui *UI) Wait()

Wait waits for the terminal user interface to finish.