screen

type Layer ¶

type Layer struct {
	Screen
	// contains filtered or unexported fields
}

type LayerOption ¶ added in v0.1.5

type LayerOption func(*Layer)

type Layers ¶

type Layers struct {
	deadlock.RWMutex
	*mux.UpdatePublisher
	// contains filtered or unexported fields
}

Layers allows you to stack several Screens on top of one another. The topmost layer with isInteractive set to true receives all key presses.

func NewLayers() *Layers

func (l *Layers) NewLayer(ctx context.Context, screen Screen, pos Position, options ...LayerOption) *Layer

func (l *Layers) NumLayers() int

func (l *Layers) Resize(size Size) error

func (l *Layers) Send(msg mux.Msg)

func (l *Layers) State() *tty.State

type Margins ¶

type Margins struct {
	deadlock.RWMutex
	*mux.UpdatePublisher
	// contains filtered or unexported fields
}

Margins puts empty space around a Screen and centers it. In size mode, Margins attempts to keep the Screen at a fixed size (one or both dimensions fixed). In margin mode, the Screen is surrounded by fixed-size margins that do not change with the screen size.

func NewMargins(ctx context.Context, screen Screen) *Margins

func (l *Margins) Resize(size Size) error

func (l *Margins) Send(msg mux.Msg)

func (l *Margins) SetSize(size Size) error

func (l *Margins) Size() Size

func (l *Margins) State() *tty.State

type Position ¶ added in v0.1.5

type Position int

const (
	PositionTop Position = iota
	PositionBottom
)

type RenderLayer ¶

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

type Renderable ¶

type Renderable interface {
	Render(Size) *tty.State
	mux.Resizable
}

type Screen ¶

type Screen = mux.Screen

type Size ¶

type Size = mux.Size

type Split ¶ added in v0.1.11

type Split struct {
	deadlock.RWMutex
	*mux.UpdatePublisher
	// contains filtered or unexported fields
}

Split renders two screens side by side (or one above the other) at a fixed proportion of its full width or height (respectively.)

func NewSplit(
	ctx context.Context,
	screenA, screenB Screen,
	percent float64,
	isVertical bool,
) *Split

func (s *Split) Resize(size Size) error

func (s *Split) Send(msg mux.Msg)

func (s *Split) SetPercent(percent float64) error

func (s *Split) State() *tty.State

type Stream ¶

type Stream = mux.Stream

type Terminal ¶

type Terminal struct {
	*mux.UpdatePublisher
	// contains filtered or unexported fields
}

func NewTerminal(ctx context.Context, stream Stream, size Size) *Terminal

func (t *Terminal) IsAltMode() bool

func (t *Terminal) Resize(size Size) error

func (t *Terminal) Send(msg mux.Msg)

func (t *Terminal) State() *tty.State

type Trigger ¶

type Trigger struct {
	deadlock.RWMutex
	*mux.UpdatePublisher
	// contains filtered or unexported fields
}

func NewTrigger(r Renderable) *Trigger

func (t *Trigger) Resize(size Size) error

func (t *Trigger) Size() Size

func (t *Trigger) State() *tty.State

type Updater ¶

type Updater = mux.Updater