screen

Documentation

Index

• func AddMargins(ctx context.Context, screen Screen) mux.Screen
• func WithInteractive(layer *Layer)
• func WithOpaque(layer *Layer)
• type Layer
• type LayerOption
• type Layers
  • 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
  • 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
• type RenderLayer
• type Renderable
• type Screen
• type Size
• type Split
  • 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 Terminal
  • 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
  • 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

Functions

func AddMargins

func AddMargins(ctx context.Context, screen Screen) mux.Screen

func WithInteractive

func WithInteractive(layer *Layer)

func WithOpaque

func WithOpaque(layer *Layer)

Types

type Layer

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

type LayerOption

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

func NewLayers() *Layers

func (*Layers) NewLayer

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

func (*Layers) NumLayers

func (l *Layers) NumLayers() int

func (*Layers) Resize

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

func (*Layers) Send

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

func (*Layers) State

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

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

func (*Margins) Resize

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

func (*Margins) Send

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

func (*Margins) SetSize

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

func (*Margins) Size

func (l *Margins) Size() Size

func (*Margins) State

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

type Position

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

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

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

func (*Split) Resize

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

func (*Split) Send

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

func (*Split) SetPercent

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

func (*Split) State

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

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

func (*Terminal) IsAltMode

func (t *Terminal) IsAltMode() bool

func (*Terminal) Resize

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

func (*Terminal) Send

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

func (*Terminal) State

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

type Trigger

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

func NewTrigger

func NewTrigger(r Renderable) *Trigger

func (*Trigger) Resize

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

func (*Trigger) Size

func (t *Trigger) Size() Size

func (*Trigger) State

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

type Updater

type Updater = mux.Updater