tea

Apr 29, 2024

Changes in this version

type Key

+ Paste bool

type Msg

+ func DisableBracketedPaste() Msg

+ func EnableBracketedPaste() Msg

type ProgramOption

+ func WithoutBracketedPaste() ProgramOption

Dec 7, 2023

Changes in this version

type Cmd

+ func SetWindowTitle(title string) Cmd

+ type MouseAction int

+ const MouseActionMotion

+ const MouseActionPress

+ const MouseActionRelease

type MouseButton

+ const MouseButton10

+ const MouseButton11

+ const MouseButtonBackward

+ const MouseButtonForward

+ const MouseButtonLeft

+ const MouseButtonMiddle

+ const MouseButtonNone

+ const MouseButtonRight

+ const MouseButtonWheelDown

+ const MouseButtonWheelLeft

+ const MouseButtonWheelRight

+ const MouseButtonWheelUp

type MouseEvent

+ Action MouseAction

+ Shift bool

+ func (m MouseEvent) IsWheel() bool

type MouseEventType

+ const MouseBackward

+ const MouseForward

+ const MouseWheelLeft

+ const MouseWheelRight

type MouseMsg

+ func (m MouseMsg) String() string

type Program

+ func (p *Program) SetWindowTitle(title string)

type ProgramOption

+ func WithFPS(fps int) ProgramOption

May 5, 2023

Changes in this version

+ func LogToFileWith(path string, prefix string, log LogOptionsSetter) (*os.File, error)

+ type LogOptionsSetter interface

+ SetOutput func(io.Writer)

+ SetPrefix func(string)

type Program

+ func (p *Program) Wait()

type ProgramOption

+ func WithFilter(filter func(Model, Msg) Msg) ProgramOption

+ func WithoutSignals() ProgramOption

+ type QuitMsg struct

Nov 3, 2022

Changes in this version

+ var ErrProgramKilled = errors.New("program was killed")

+ type BatchMsg []Cmd

type Cmd

+ func Sequence(cmds ...Cmd) Cmd

type KeyType

+ const KeyCtrlEnd

+ const KeyCtrlHome

+ const KeyCtrlPgDown

+ const KeyCtrlPgUp

+ const KeyCtrlShiftEnd

+ const KeyCtrlShiftHome

+ const KeyInsert

+ const KeyShiftEnd

+ const KeyShiftHome

type Msg

+ func ClearScreen() Msg

+ func ShowCursor() Msg

type Program

+ func (p *Program) Run() (Model, error)

type ProgramOption

+ func WithContext(ctx context.Context) ProgramOption

+ func WithoutSignalHandler() ProgramOption

Jun 23, 2022

Changes in this version

type Cmd

+ func Printf(template string, args ...interface{}) Cmd

+ func Println(args ...interface{}) Cmd

type Program

+ func (p *Program) Printf(template string, args ...interface{})

+ func (p *Program) Println(args ...interface{})

Jun 2, 2022

Changes in this version

type Cmd

+ func Exec(c ExecCommand, fn ExecCallback) Cmd

+ func ExecProcess(c *exec.Cmd, fn ExecCallback) Cmd

+ type ExecCallback func(error) Msg

+ type ExecCommand interface

+ Run func() error

+ SetStderr func(io.Writer)

+ SetStdin func(io.Reader)

+ SetStdout func(io.Writer)

type KeyType

+ const KeyCtrlDown

+ const KeyCtrlLeft

+ const KeyCtrlRight

+ const KeyCtrlShiftDown

+ const KeyCtrlShiftLeft

+ const KeyCtrlShiftRight

+ const KeyCtrlShiftUp

+ const KeyCtrlUp

+ const KeyF1

+ const KeyF10

+ const KeyF11

+ const KeyF12

+ const KeyF13

+ const KeyF14

+ const KeyF15

+ const KeyF16

+ const KeyF17

+ const KeyF18

+ const KeyF19

+ const KeyF2

+ const KeyF20

+ const KeyF3

+ const KeyF4

+ const KeyF5

+ const KeyF6

+ const KeyF7

+ const KeyF8

+ const KeyF9

+ const KeyShiftDown

+ const KeyShiftLeft

+ const KeyShiftRight

+ const KeyShiftUp

type Program

+ func (p *Program) ReleaseTerminal() error

+ func (p *Program) RestoreTerminal() error

Feb 15, 2022

Changes in this version

type Program

+ func (p *Program) Kill()

Oct 30, 2021

Changes in this version

type Program

+ func (p *Program) StartReturningModel() (Model, error)

type ProgramOption

+ func WithANSICompressor() ProgramOption

Oct 28, 2021

Changes in this version

type Program

+ func (p *Program) Quit()

Sep 7, 2021

Changes in this version

type Program

+ func (p *Program) Send(msg Msg)

type ProgramOption

+ func WithInputTTY() ProgramOption

Jun 2, 2021

Changes in this version

type ProgramOption

+ func WithAltScreen() ProgramOption

+ func WithMouseAllMotion() ProgramOption

+ func WithMouseCellMotion() ProgramOption

May 10, 2021

Changes in this version

type Msg

+ func DisableMouse() Msg

+ func EnableMouseAllMotion() Msg

+ func EnableMouseCellMotion() Msg

Mar 11, 2021

Changes in this version

type Key

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

type KeyType

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

type Msg

+ func EnterAltScreen() Msg

type ProgramOption

+ func WithoutRenderer() ProgramOption

Jan 17, 2021

Changes in this version

type Cmd

+ func Sequentially(cmds ...Cmd) Cmd

Jan 15, 2021

Changes in this version

type Msg

+ func HideCursor() Msg

+ type ProgramOption func(*Program)

+ func WithInput(input io.Reader) ProgramOption

+ func WithOutput(output *os.File) ProgramOption

+ func WithoutCatchPanics() ProgramOption

Nov 1, 2020

Changes in this version

+ const KeyRunes

type Key

+ Runes []rune

Oct 16, 2020

Changes in this version

type Model

+ Init func() Cmd

+ Update func(Msg) (Model, Cmd)

+ View func() string

Oct 2, 2020

Changes in this version

type MouseEvent

+ Type MouseEventType

+ type MouseEventType int

Sep 21, 2020

Changes in this version

type Program

+ CatchPanics bool

Aug 19, 2020

Changes in this version

+ func LogToFile(path string, prefix string) (*os.File, error) — js/wasm, windows/amd64

Jul 14, 2020

Changes in this version

+ type MouseButton int

+ const MouseLeft

+ const MouseMiddle

+ const MouseMotion

+ const MouseRelease

+ const MouseRight

+ const MouseUnknown

+ const MouseWheelDown

+ const MouseWheelUp

+ type MouseEvent struct

+ Alt bool

+ Button MouseButton

+ Ctrl bool

+ X int

+ Y int

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

+ type MouseMsg MouseEvent

type Msg

+ func ReadInput(r io.Reader) (Msg, error)

type Program

+ func (p *Program) DisableMouseAllMotion()

+ func (p *Program) DisableMouseCellMotion()

+ func (p *Program) EnableMouseAllMotion()

+ func (p *Program) EnableMouseCellMotion()

+ func (p *Program) EnterAltScreen()

+ func (p *Program) ExitAltScreen()

Jun 22, 2020

Changes in this version

type Cmd

+ func ScrollDown(newLines []string, topBoundary, bottomBoundary int) Cmd

+ func ScrollUp(newLines []string, topBoundary, bottomBoundary int) Cmd

+ func SyncScrollArea(lines []string, topBoundary int, bottomBoundary int) Cmd

type Msg

+ func ClearScrollArea() Msg

+ type WindowSizeMsg struct

+ Height int

+ Width int

Jun 16, 2020

Changes in this version

+ const BlankSymbol

May 26, 2020

Changes in this version

+ const KeyBackspace

+ const KeyBreak

+ const KeyCtrlA

+ const KeyCtrlAt

+ const KeyCtrlB

+ const KeyCtrlBackslash

+ const KeyCtrlC

+ const KeyCtrlCaret

+ const KeyCtrlCloseBracket

+ const KeyCtrlD

+ const KeyCtrlE

+ const KeyCtrlF

+ const KeyCtrlG

+ const KeyCtrlH

+ const KeyCtrlI

+ const KeyCtrlJ

+ const KeyCtrlK

+ const KeyCtrlL

+ const KeyCtrlM

+ const KeyCtrlN

+ const KeyCtrlO

+ const KeyCtrlOpenBracket

+ const KeyCtrlP

+ const KeyCtrlQ

+ const KeyCtrlQuestionMark

+ const KeyCtrlR

+ const KeyCtrlS

+ const KeyCtrlT

+ const KeyCtrlU

+ const KeyCtrlUnderscore

+ const KeyCtrlV

+ const KeyCtrlW

+ const KeyCtrlX

+ const KeyCtrlY

+ const KeyCtrlZ

+ const KeyDelete

+ const KeyDown

+ const KeyEnd

+ const KeyEnter

+ const KeyEsc

+ const KeyEscape

+ const KeyHome

+ const KeyLeft

+ const KeyNull

+ const KeyPgDown

+ const KeyPgUp

+ const KeyRight

+ const KeyRune

+ const KeyShiftTab

+ const KeySpace

+ const KeyTab

+ const KeyUp

+ func AltScreen()

+ func ExitAltScreen()

+ func LogToFile(path string, prefix string) (*os.File, error) — darwin/amd64, linux/amd64

+ func UseSysLog(programName string) error — darwin/amd64, linux/amd64

+ type Cmd func() Msg

+ func Batch(cmds ...Cmd) Cmd

+ func Every(duration time.Duration, fn func(time.Time) Msg) Cmd

+ func GetTerminalSize(newMsgFunc func(int, int, error) TerminalSizeMsg) Cmd

+ func OnResize(newMsgFunc func() Msg) Cmd

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

+ type Init func() (Model, Cmd)

+ type Key struct

+ Alt bool

+ Rune rune

+ Type KeyType

+ func ReadKey(r io.Reader) (Key, error)

+ type KeyMsg Key

+ func (k *KeyMsg) IsRune() bool

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

+ type KeyType int

+ type Model interface

+ type Msg interface

+ func Quit() Msg

+ type Program struct

+ func NewProgram(init Init, update Update, view View) *Program

+ func (p *Program) Start() error

+ type TerminalSizeMsg interface

+ Error func() error

+ Size func() (int, int)

+ type Update func(Msg, Model) (Model, Cmd)

+ type View func(Model) string