bento

package module
v0.0.0-...-45b0304 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 28, 2025 License: MIT Imports: 27 Imported by: 0

README

🍱 Bento

Work in progress. Mascot is too =)

image

Bento is a Go framework for cooking up terminal user interfaces (TUIs). It provides a simple and flexible way to create text-based user interfaces in the terminal, which can be used for command-line applications, dashboards, and other interactive console programs.

It's a mix of Rust's ratatui library and Go's bubbletea

Bento provides efficient and complex layout functionality from ratatui (widgets, buffers, cassowary constraint solving algorithm) and functional design paradigms of The Elm Architecture as seen in bubbletea.

This library is mostly full Go rewrite of ratatui-core crate with some parts copied from bubbletea runtime.

Demo is WIP, but you can take a look at examples for now

It's named bento after how similar some bento boxes look like compared to the typical TUIs (multiple blocks of different sizes side by side)

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrInterrupted = errors.New("interrupted")
	ErrKilled      = errors.New("killed")
)

Functions

This section is empty.

Types

type Alignment 

type Alignment int
const (
	AlignmentNone Alignment = iota
	AlignmentLeft
	AlignmentCenter
	AlignmentRight
)

type App 

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

func NewApp 

func NewApp(model Model) App

func (App) Run 

func (a App) Run() (Model, error)

func (App) WithContext 

func (a App) WithContext(ctx context.Context) App

type BatchMsg 

type BatchMsg []Cmd

type BlurMsg 

type BlurMsg struct{}

BlurMsg represents a terminal blur message. This occurs when the terminal loses focus.

type Buffer 

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

func NewBufferEmpty 

func NewBufferEmpty(area Rect) Buffer

func NewBufferFilled 

func NewBufferFilled(area Rect, cell Cell) Buffer

func (*Buffer) Area 

func (b *Buffer) Area() Rect

Area of the buffer

func (*Buffer) CellAt 

func (b *Buffer) CellAt(position Position) *Cell

func (*Buffer) Diff 

func (b *Buffer) Diff(other *Buffer) []PositionedCell

Diff builds a minimal sequence of coordinates and Cells necessary to update the UI from self to other.

We're assuming that buffers are well-formed, that is no double-width cell is followed by a non-blank cell.

func (*Buffer) PosOf 

func (b *Buffer) PosOf(index int) Position

func (*Buffer) Reset 

func (b *Buffer) Reset()

func (*Buffer) Resize 

func (b *Buffer) Resize(area Rect)

func (*Buffer) SetString 

func (b *Buffer) SetString(x, y int, value string, style Style)

SetString prints a string, starting at the position (x, y)

func (*Buffer) SetStringN 

func (b *Buffer) SetStringN(x, y int, value string, maxWidth int, style Style) (int, int)

SetStringN prints at most the first n characters of a string if enough space is available until the end of the line. Skips zero-width graphemes and control characters.

Use Buffer.SetString when the maximum amount of characters can be printed.

func (*Buffer) SetStyle 

func (b *Buffer) SetStyle(area Rect, style Style)

type Cell 

type Cell struct {
	Symbol   string
	Fg, Bg   Color
	Modifier Modifier
	Skip     bool
}

func NewCell 

func NewCell(symbol string) Cell

func NewEmptyCell 

func NewEmptyCell() Cell

func (*Cell) AppendSymbol 

func (c *Cell) AppendSymbol(symbol string) *Cell

func (*Cell) Reset 

func (c *Cell) Reset()

func (*Cell) SetBg 

func (c *Cell) SetBg(color termenv.Color) *Cell

func (*Cell) SetFg 

func (c *Cell) SetFg(color termenv.Color) *Cell

func (*Cell) SetStyle 

func (c *Cell) SetStyle(style Style) *Cell

func (*Cell) SetSymbol 

func (c *Cell) SetSymbol(symbol string) *Cell

type Cmd 

type Cmd func() Msg

func Batch 

func Batch(cmds ...Cmd) Cmd

Batch performs a bunch of commands concurrently with no ordering guarantees about the results. Use a Batch to return several commands.

func Sequence 

func Sequence(cmds ...Cmd) Cmd

Sequence runs the given commands one at a time, in order. Contrast this with Batch, which runs commands concurrently.

func Tick 

func Tick(d time.Duration, fn func(time.Time) Msg) Cmd

type Color 

type Color = termenv.Color

type CompletedFrame 

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

type Constraint 

type Constraint interface {
	fmt.Stringer
	// contains filtered or unexported methods
}

type ConstraintFill 

type ConstraintFill int

func (ConstraintFill) String 

func (f ConstraintFill) String() string

type ConstraintLen 

type ConstraintLen int

func (ConstraintLen) String 

func (l ConstraintLen) String() string

type ConstraintMax 

type ConstraintMax int

func (ConstraintMax) String 

func (m ConstraintMax) String() string

type ConstraintMin 

type ConstraintMin int

func (ConstraintMin) String 

func (m ConstraintMin) String() string

type ConstraintPercentage 

type ConstraintPercentage int

func (ConstraintPercentage) String 

func (p ConstraintPercentage) String() string

type ConstraintRatio 

type ConstraintRatio struct{ Num, Den int }

func (ConstraintRatio) String 

func (r ConstraintRatio) String() string

type DefaultBackend 

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

func NewDefaultBackend 

func NewDefaultBackend(input io.Reader, output io.Writer) DefaultBackend

func (*DefaultBackend) ClearAfterCursor 

func (d *DefaultBackend) ClearAfterCursor() error

ClearAfterCursor implements TerminalBackend.

func (*DefaultBackend) ClearAll 

func (d *DefaultBackend) ClearAll() error

ClearAll implements TerminalBackend.

func (*DefaultBackend) ClearBeforeCursor 

func (d *DefaultBackend) ClearBeforeCursor() error

ClearBeforeCursor implements TerminalBackend.

func (*DefaultBackend) ClearCurrentLine 

func (d *DefaultBackend) ClearCurrentLine() error

ClearCurrentLine implements TerminalBackend.

func (*DefaultBackend) ClearUntilNewLine 

func (d *DefaultBackend) ClearUntilNewLine() error

ClearUntilNewLine implements TerminalBackend.

func (*DefaultBackend) DisableBracketedPaste 

func (d *DefaultBackend) DisableBracketedPaste() error

func (*DefaultBackend) DisableRawMode 

func (d *DefaultBackend) DisableRawMode() error

func (*DefaultBackend) Draw 

func (d *DefaultBackend) Draw(cells []PositionedCell) error

Draw implements TerminalBackend.

func (*DefaultBackend) EnableAlternateScreen 

func (d *DefaultBackend) EnableAlternateScreen() error

func (*DefaultBackend) EnableBracketedPaste 

func (d *DefaultBackend) EnableBracketedPaste() error

func (*DefaultBackend) EnableRawMode 

func (d *DefaultBackend) EnableRawMode() error

func (*DefaultBackend) Flush 

func (d *DefaultBackend) Flush() error

Flush implements TerminalBackend.

func (*DefaultBackend) GetCursorPosition 

func (d *DefaultBackend) GetCursorPosition() (Position, error)

GetCursorPosition implements TerminalBackend.

func (*DefaultBackend) GetSize 

func (d *DefaultBackend) GetSize() (Size, bool, error)

GetSize implements TerminalBackend.

func (*DefaultBackend) HideCursor 

func (d *DefaultBackend) HideCursor() error

HideCursor implements TerminalBackend.

func (*DefaultBackend) Input 

func (d *DefaultBackend) Input() io.Reader

func (*DefaultBackend) LeaveAlternateScreen 

func (d *DefaultBackend) LeaveAlternateScreen() error

func (*DefaultBackend) Output 

func (d *DefaultBackend) Output() io.Writer

func (*DefaultBackend) Read 

func (d *DefaultBackend) Read(p []byte) (n int, err error)

Read implements TerminalBackend.

func (*DefaultBackend) SetCursorPosition 

func (d *DefaultBackend) SetCursorPosition(position Position) error

SetCursorPosition implements TerminalBackend.

func (*DefaultBackend) ShowCursor 

func (d *DefaultBackend) ShowCursor() error

ShowCursor implements TerminalBackend.

type Direction 

type Direction int
const (
	DirectionVertical Direction = iota
	DirectionHorizontal
)

type Flex 

type Flex int
const (
	FlexLegacy Flex = iota
	FlexStart
	FlexEnd
	FlexCenter
	FlexSpaceBetween
	FlexSpaceAround
)

type FocusMsg 

type FocusMsg struct{}

FocusMsg represents a terminal focus message. This occurs when the terminal gains focus.

type Frame 

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

func (*Frame) Area 

func (f *Frame) Area() Rect

func (*Frame) RenderWidget 

func (f *Frame) RenderWidget(widget Widget, area Rect)

type Key 

type Key struct {
	Type  KeyType
	Runes []rune
	Alt   bool
	Paste bool
}

Key contains information about a keypress.

func (Key) String 

func (k Key) String() (str string)

String returns a friendly string representation for a key. It's safe (and encouraged) for use in key comparison. 

k := Key{Type: KeyEnter}
fmt.Println(k)
// Output: enter

type KeyMsg 

type KeyMsg Key

KeyMsg contains information about a keypress. KeyMsgs are always sent to the program's update function. There are a couple general patterns you could use to check for keypresses: 

// Switch on the string representation of the key (shorter)
switch msg := msg.(type) {
case KeyMsg:
    switch msg.String() {
    case "enter":
        fmt.Println("you pressed enter!")
    case "a":
        fmt.Println("you pressed a!")
    }
}

// Switch on the key type (more foolproof)
switch msg := msg.(type) {
case KeyMsg:
    switch msg.Type {
    case KeyEnter:
        fmt.Println("you pressed enter!")
    case KeyRunes:
        switch string(msg.Runes) {
        case "a":
            fmt.Println("you pressed a!")
        }
    }
}

Note that Key.Runes will always contain at least one character, so you can always safely call Key.Runes[0]. In most cases Key.Runes will only contain one character, though certain input method editors (most notably Chinese IMEs) can input multiple runes at once.

func (KeyMsg) String 

func (k KeyMsg) String() (str string)

String returns a string representation for a key message. It's safe (and encouraged) for use in key comparison.

type KeyType 

type KeyType int

KeyType indicates the key pressed, such as KeyEnter or KeyBreak or KeyCtrlC. All other keys will be type KeyRunes. To get the rune value, check the Rune method on a Key struct, or use the Key.String() method: 

k := Key{Type: KeyRunes, Runes: []rune{'a'}, Alt: true}
if k.Type == KeyRunes {

    fmt.Println(k.Runes)
    // Output: a

    fmt.Println(k.String())
    // Output: alt+a

}

const (
	KeyNull      KeyType = keyNUL
	KeyBreak     KeyType = keyETX
	KeyEnter     KeyType = keyCR
	KeyBackspace KeyType = keyDEL
	KeyTab       KeyType = keyHT
	KeyEsc       KeyType = keyESC
	KeyEscape    KeyType = keyESC

	KeyCtrlAt           KeyType = keyNUL // ctrl+@
	KeyCtrlA            KeyType = keySOH
	KeyCtrlB            KeyType = keySTX
	KeyCtrlC            KeyType = keyETX
	KeyCtrlD            KeyType = keyEOT
	KeyCtrlE            KeyType = keyENQ
	KeyCtrlF            KeyType = keyACK
	KeyCtrlG            KeyType = keyBEL
	KeyCtrlH            KeyType = keyBS
	KeyCtrlI            KeyType = keyHT
	KeyCtrlJ            KeyType = keyLF
	KeyCtrlK            KeyType = keyVT
	KeyCtrlL            KeyType = keyFF
	KeyCtrlM            KeyType = keyCR
	KeyCtrlN            KeyType = keySO
	KeyCtrlO            KeyType = keySI
	KeyCtrlP            KeyType = keyDLE
	KeyCtrlQ            KeyType = keyDC1
	KeyCtrlR            KeyType = keyDC2
	KeyCtrlS            KeyType = keyDC3
	KeyCtrlT            KeyType = keyDC4
	KeyCtrlU            KeyType = keyNAK
	KeyCtrlV            KeyType = keySYN
	KeyCtrlW            KeyType = keyETB
	KeyCtrlX            KeyType = keyCAN
	KeyCtrlY            KeyType = keyEM
	KeyCtrlZ            KeyType = keySUB
	KeyCtrlOpenBracket  KeyType = keyESC // ctrl+[
	KeyCtrlBackslash    KeyType = keyFS  // ctrl+\
	KeyCtrlCloseBracket KeyType = keyGS  // ctrl+]
	KeyCtrlCaret        KeyType = keyRS  // ctrl+^
	KeyCtrlUnderscore   KeyType = keyUS  // ctrl+_
	KeyCtrlQuestionMark KeyType = keyDEL // ctrl+?
)

Control key aliases. 

const (
	KeyRunes KeyType = -(iota + 1)
	KeyUp
	KeyDown
	KeyRight
	KeyLeft
	KeyShiftTab
	KeyHome
	KeyEnd
	KeyPgUp
	KeyPgDown
	KeyCtrlPgUp
	KeyCtrlPgDown
	KeyDelete
	KeyInsert
	KeySpace
	KeyCtrlUp
	KeyCtrlDown
	KeyCtrlRight
	KeyCtrlLeft
	KeyCtrlHome
	KeyCtrlEnd
	KeyShiftUp
	KeyShiftDown
	KeyShiftRight
	KeyShiftLeft
	KeyShiftHome
	KeyShiftEnd
	KeyCtrlShiftUp
	KeyCtrlShiftDown
	KeyCtrlShiftLeft
	KeyCtrlShiftRight
	KeyCtrlShiftHome
	KeyCtrlShiftEnd
	KeyF1
	KeyF2
	KeyF3
	KeyF4
	KeyF5
	KeyF6
	KeyF7
	KeyF8
	KeyF9
	KeyF10
	KeyF11
	KeyF12
	KeyF13
	KeyF14
	KeyF15
	KeyF16
	KeyF17
	KeyF18
	KeyF19
	KeyF20
)

Other keys.

func (KeyType) String 

func (k KeyType) String() (str string)

type Layout 

type Layout struct {
	Direction   Direction
	Constraints []Constraint
	Padding     Padding
	Flex        Flex
	Spacing     Spacing
}

func NewLayout 

func NewLayout(constraints ...Constraint) Layout

func (Layout) Horizontal 

func (l Layout) Horizontal() Layout

func (Layout) Split 

func (l Layout) Split(area Rect) Splitted

func (Layout) SplitWithSpacers 

func (l Layout) SplitWithSpacers(area Rect) (segments, spacers Splitted)

func (Layout) Vertical 

func (l Layout) Vertical() Layout

func (Layout) WithConstraints 

func (l Layout) WithConstraints(constraints ...Constraint) Layout

func (Layout) WithDirection 

func (l Layout) WithDirection(direction Direction) Layout

func (Layout) WithFlex 

func (l Layout) WithFlex(flex Flex) Layout

func (Layout) WithPadding 

func (l Layout) WithPadding(padding Padding) Layout

func (Layout) WithSpacing 

func (l Layout) WithSpacing(spacing Spacing) Layout

type Model 

type Model interface {
	Widget

	Init() Cmd
	Update(msg Msg) (Model, Cmd)
}

type Modifier 

type Modifier uint16
const (
	ModifierNone       Modifier = 0b0000_0000_0000
	ModifierBold       Modifier = 0b0000_0000_0001
	ModifierDim        Modifier = 0b0000_0000_0010
	ModifierItalic     Modifier = 0b0000_0000_0100
	ModifierUnderlined Modifier = 0b0000_0000_1000
	ModifierSlowBlink  Modifier = 0b0000_0001_0000
	ModifierRapidBlink Modifier = 0b0000_0010_0000
	ModifierReversed   Modifier = 0b0000_0100_0000
	ModifierHidden     Modifier = 0b0000_1000_0000
	ModifierCrossedOut Modifier = 0b0001_0000_0000
	ModifierAll        Modifier = ModifierBold |
		ModifierDim |
		ModifierItalic |
		ModifierUnderlined |
		ModifierSlowBlink |
		ModifierRapidBlink |
		ModifierReversed |
		ModifierHidden |
		ModifierCrossedOut
)

func (Modifier) Contains 

func (m Modifier) Contains(other Modifier) bool

type MouseAction 

type MouseAction int

MouseAction represents the action that occurred during a mouse event. 

const (
	MouseActionPress MouseAction = iota
	MouseActionRelease
	MouseActionMotion
)

Mouse event actions.

type MouseButton 

type MouseButton int

MouseButton represents the button that was pressed during a mouse event. 

const (
	MouseButtonNone MouseButton = iota
	MouseButtonLeft
	MouseButtonMiddle
	MouseButtonRight
	MouseButtonWheelUp
	MouseButtonWheelDown
	MouseButtonWheelLeft
	MouseButtonWheelRight
	MouseButtonBackward
	MouseButtonForward
	MouseButton10
	MouseButton11
)

Mouse event buttons

This is based on X11 mouse button codes. 

1 = left button
2 = middle button (pressing the scroll wheel)
3 = right button
4 = turn scroll wheel up
5 = turn scroll wheel down
6 = push scroll wheel left
7 = push scroll wheel right
8 = 4th button (aka browser backward button)
9 = 5th button (aka browser forward button)
10
11

Other buttons are not supported.

type MouseEvent 

type MouseEvent struct {
	X      int
	Y      int
	Shift  bool
	Alt    bool
	Ctrl   bool
	Action MouseAction
	Button MouseButton
}

MouseEvent represents a mouse event, which could be a click, a scroll wheel movement, a cursor movement, or a combination.

func (MouseEvent) IsWheel 

func (m MouseEvent) IsWheel() bool

IsWheel returns true if the mouse event is a wheel event.

func (MouseEvent) String 

func (m MouseEvent) String() (s string)

String returns a string representation of a mouse event.

type MouseMsg 

type MouseMsg MouseEvent

MouseMsg contains information about a mouse event and are sent to a programs update function when mouse activity occurs. Note that the mouse must first be enabled in order for the mouse events to be received.

func (MouseMsg) String 

func (m MouseMsg) String() string

String returns a string representation of a mouse event.

type Msg 

type Msg any

func Quit 

func Quit() Msg

Quit is a special command that tells the Bento app to exit.

type Padding 

type Padding struct {
	Top, Right, Bottom, Left int
}

func NewPadding 

func NewPadding(sides ...int) Padding

func (Padding) WithBottom 

func (p Padding) WithBottom(s int) Padding

func (Padding) WithLeft 

func (p Padding) WithLeft(s int) Padding

func (Padding) WithRight 

func (p Padding) WithRight(s int) Padding

func (Padding) WithTop 

func (p Padding) WithTop(s int) Padding

type Position 

type Position struct {
	X, Y int
}

func NewPosition 

func NewPosition(x, y int) Position

type PositionedCell 

type PositionedCell struct {
	Cell

	Position Position
}

type QuitMsg 

type QuitMsg struct{}

type Rect 

type Rect struct {
	X, Y int

	Width, Height int
}

func NewRect 

func NewRect(width, height int) Rect

func (Rect) Area 

func (r Rect) Area() int

func (Rect) Bottom 

func (r Rect) Bottom() int

func (Rect) Columns 

func (r Rect) Columns() []Rect

func (Rect) Contains 

func (r Rect) Contains(position Position) bool

func (Rect) IndentX 

func (r Rect) IndentX(offset int) Rect

func (Rect) Inner 

func (r Rect) Inner(padding Padding) Rect

func (Rect) Intersection 

func (r Rect) Intersection(other Rect) Rect

func (Rect) IsEmpty 

func (r Rect) IsEmpty() bool

func (Rect) Left 

func (r Rect) Left() int

func (Rect) Position 

func (r Rect) Position() Position

func (Rect) Positioned 

func (r Rect) Positioned(x, y int) Rect

func (Rect) Right 

func (r Rect) Right() int

func (Rect) Rows 

func (r Rect) Rows() []Rect

func (Rect) Top 

func (r Rect) Top() int

type ResetColor 

type ResetColor struct{}

func (ResetColor) Sequence 

func (ResetColor) Sequence(bg bool) string

Sequence implements termenv.Color.

type Size 

type Size struct {
	Width, Height int
}

type Spacing 

type Spacing interface{}

type SpacingOverlap 

type SpacingOverlap int

type SpacingSpace 

type SpacingSpace int

type Splitted 

type Splitted []Rect

func (Splitted) Assign 

func (s Splitted) Assign(areas ...*Rect)

func (Splitted) Unwrap 

func (s Splitted) Unwrap() Rect

func (Splitted) Unwrap2 

func (s Splitted) Unwrap2() (a, b Rect)

func (Splitted) Unwrap3 

func (s Splitted) Unwrap3() (a, b, c Rect)

func (Splitted) Unwrap4 

func (s Splitted) Unwrap4() (a, b, c, d Rect)

type StatefulWidget 

type StatefulWidget[S any] interface {
	RenderStateful(area Rect, buffer *Buffer, state S)
}

type Style 

type Style struct {
	Foreground, Background StyleColor
	// contains filtered or unexported fields
}

func NewStyle 

func NewStyle() Style

func (Style) Black 

func (s Style) Black() Style

func (Style) Blue 

func (s Style) Blue() Style

func (Style) Bold 

func (s Style) Bold() Style

func (Style) BrightBlack 

func (s Style) BrightBlack() Style

func (Style) BrightBlue 

func (s Style) BrightBlue() Style

func (Style) BrightCyan 

func (s Style) BrightCyan() Style

func (Style) BrightGreen 

func (s Style) BrightGreen() Style

func (Style) BrightMagenta 

func (s Style) BrightMagenta() Style

func (Style) BrightRed 

func (s Style) BrightRed() Style

func (Style) BrightWhite 

func (s Style) BrightWhite() Style

func (Style) BrightYellow 

func (s Style) BrightYellow() Style

func (Style) CrossedOut 

func (s Style) CrossedOut() Style

func (Style) Cyan 

func (s Style) Cyan() Style

func (Style) Dim 

func (s Style) Dim() Style

func (Style) Green 

func (s Style) Green() Style

func (Style) Italic 

func (s Style) Italic() Style

func (Style) Magenta 

func (s Style) Magenta() Style

func (Style) OnBlack 

func (s Style) OnBlack() Style

func (Style) OnBlue 

func (s Style) OnBlue() Style

func (Style) OnBrightBlack 

func (s Style) OnBrightBlack() Style

func (Style) OnBrightBlue 

func (s Style) OnBrightBlue() Style

func (Style) OnBrightCyan 

func (s Style) OnBrightCyan() Style

func (Style) OnBrightGreen 

func (s Style) OnBrightGreen() Style

func (Style) OnBrightMagenta 

func (s Style) OnBrightMagenta() Style

func (Style) OnBrightRed 

func (s Style) OnBrightRed() Style

func (Style) OnBrightWhite 

func (s Style) OnBrightWhite() Style

func (Style) OnBrightYellow 

func (s Style) OnBrightYellow() Style

func (Style) OnCyan 

func (s Style) OnCyan() Style

func (Style) OnGreen 

func (s Style) OnGreen() Style

func (Style) OnMagenta 

func (s Style) OnMagenta() Style

func (Style) OnRGB 

func (s Style) OnRGB(r, g, b uint8) Style

func (Style) OnRed 

func (s Style) OnRed() Style

func (Style) OnWhite 

func (s Style) OnWhite() Style

func (Style) OnYellow 

func (s Style) OnYellow() Style

func (Style) Patched 

func (s Style) Patched(patch Style) Style

func (Style) RGB 

func (s Style) RGB(r, g, b uint8) Style

func (Style) Red 

func (s Style) Red() Style

func (Style) Reversed 

func (s Style) Reversed() Style

func (Style) Underlined 

func (s Style) Underlined() Style

func (Style) White 

func (s Style) White() Style

func (Style) WithBackground 

func (s Style) WithBackground(color Color) Style

func (Style) WithForeground 

func (s Style) WithForeground(color Color) Style

func (Style) WithModifier 

func (s Style) WithModifier(modifier Modifier) Style

func (Style) WithoutModifier 

func (s Style) WithoutModifier(modifier Modifier) Style

func (Style) Yellow 

func (s Style) Yellow() Style

type StyleColor 

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

func (*StyleColor) Color 

func (s *StyleColor) Color() Color

func (*StyleColor) IsSet 

func (s *StyleColor) IsSet() bool

func (*StyleColor) Reset 

func (s *StyleColor) Reset()

func (*StyleColor) Set 

func (s *StyleColor) Set(color Color)

type Terminal 

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

func NewTerminal 

func NewTerminal(backend TerminalBackend, viewport Viewport) (*Terminal, error)

func (*Terminal) Clear 

func (t *Terminal) Clear() error

func (*Terminal) CurrentBuffer 

func (t *Terminal) CurrentBuffer() *Buffer

func (*Terminal) DisableBracketedPaste 

func (t *Terminal) DisableBracketedPaste() error

func (*Terminal) DisableRawMode 

func (t *Terminal) DisableRawMode() error

func (*Terminal) Draw 

func (t *Terminal) Draw(widget Widget) (CompletedFrame, error)

func (*Terminal) EnableAlternateScreen 

func (t *Terminal) EnableAlternateScreen() error

func (*Terminal) EnableBracketedPaste 

func (t *Terminal) EnableBracketedPaste() error

func (*Terminal) EnableRawMode 

func (t *Terminal) EnableRawMode() error

func (*Terminal) Flush 

func (t *Terminal) Flush() error

Flush obtains a difference between the previous and the current buffer and passes it to the current backend for drawing.

func (*Terminal) GetFrame 

func (t *Terminal) GetFrame() Frame

func (*Terminal) HideCursor 

func (t *Terminal) HideCursor() error

func (*Terminal) Input 

func (t *Terminal) Input() io.Reader

func (*Terminal) LeaveAlternateScreen 

func (t *Terminal) LeaveAlternateScreen() error

func (*Terminal) Output 

func (t *Terminal) Output() io.Writer

func (*Terminal) PreviousBuffer 

func (t *Terminal) PreviousBuffer() *Buffer

func (*Terminal) Read 

func (t *Terminal) Read(p []byte) (n int, err error)

Read implements io.Reader.

func (*Terminal) Resize 

func (t *Terminal) Resize(area Rect) error

func (*Terminal) SetCursorPosition 

func (t *Terminal) SetCursorPosition(position Position) error

func (*Terminal) ShowCursor 

func (t *Terminal) ShowCursor() error

func (*Terminal) Size 

func (t *Terminal) Size() (Size, bool, error)

func (*Terminal) SwapBuffers 

func (t *Terminal) SwapBuffers()

func (*Terminal) Viewport 

func (t *Terminal) Viewport() Viewport

type TerminalBackend 

type TerminalBackend interface {
	io.Reader

	Draw(cells []PositionedCell) error
	HideCursor() error
	ShowCursor() error
	GetCursorPosition() (Position, error)
	SetCursorPosition(position Position) error
	GetSize() (Size, bool, error)
	Flush() error

	ClearAll() error
	ClearAfterCursor() error
	ClearBeforeCursor() error
	ClearCurrentLine() error
	ClearUntilNewLine() error

	EnableRawMode() error
	DisableRawMode() error

	EnableAlternateScreen() error
	LeaveAlternateScreen() error

	EnableBracketedPaste() error
	DisableBracketedPaste() error

	Input() io.Reader
	Output() io.Writer
}

type TryUpdater 

type TryUpdater interface {
	// TryUpdate passes message to update the receiver.
	// It returns a boolean that states whether the message was consumed
	// and should not be handled further.
	// If consumed is true the caller should return resulted cmd.
	//
	// It is adviced to call this method before any further message handling.
	TryUpdate(msg Msg) (consumed bool, cmd Cmd)
}

type Viewport 

type Viewport interface {
	// contains filtered or unexported methods
}

type ViewportFixed 

type ViewportFixed Rect

type ViewportFullscreen 

type ViewportFullscreen struct{}

type ViewportInline 

type ViewportInline int

type Widget 

type Widget interface {
	Render(area Rect, buffer *Buffer)
}

type WindowSizeMsg 

type WindowSizeMsg Size

Source Files

View all Source files

Directories

Path Synopsis
examples
demo
demo/gradient
demo/tabs
demo/theme
input
lazygitlike
list
throbber
internal
ansi
bit
casso
grapheme
reflow
sliceutil

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.