Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

twin

package module

Go to main page

Versions in this module

v0

v0.9.3

Sep 7, 2026

Changes in this version

type FakeScreen

+ func (screen *FakeScreen) PrintLines(int)

type Screen

+ PrintLines func(lineCountToShow int)

v0.9.2

Sep 6, 2026

v0.9.1

Sep 5, 2026

v0.9.0

Sep 4, 2026

Changes in this version

+ var ColorDefault = newColor(ColorCountDefault, 0)

+ func Printable(char rune) bool

+ type AttrMask uint

+ const AttrBlink

+ const AttrBold

+ const AttrDim

+ const AttrHidden

+ const AttrItalic

+ const AttrNone

+ const AttrReverse

+ const AttrStrikeThrough

+ const AttrUnderline

+ type Color uint32

+ func NewColor16(colorNumber0to15 int) Color

+ func NewColor24Bit(red uint8, green uint8, blue uint8) Color

+ func NewColor256(colorNumber uint8) Color

+ func NewColorHex(rgb uint32) Color

+ func (color Color) Distance(other Color) float64

+ func (color Color) Mix(other Color, weight float64) Color

+ func (color Color) RGBA() (r, g, b, a uint32)

+ func (color Color) String() string

+ type ColorCount uint8

+ const ColorCount16

+ const ColorCount24bit

+ const ColorCount256

+ const ColorCount8

+ const ColorCountDefault

+ type Event any

+ type EventExit struct

+ type EventKeyCode struct

+ KeyCode KeyCode

+ type EventMouse struct

+ Buttons MouseButtonMask

+ type EventResize struct

+ type EventRune struct

+ Rune rune

+ type FakeScreen struct

+ func NewFakeScreen(width int, height int) *FakeScreen

+ func (screen *FakeScreen) Clear()

+ func (screen *FakeScreen) Close()

+ func (screen *FakeScreen) Events() chan Event

+ func (screen *FakeScreen) GetCell(column int, row int) StyledRune

+ func (screen *FakeScreen) GetRow(row int) []StyledRune

+ func (screen *FakeScreen) PauseAndCall(run func() error) error

+ func (screen *FakeScreen) SetCell(column int, row int, styledRune StyledRune) int

+ func (screen *FakeScreen) SetProgress(state ProgressState, percent int)

+ func (screen *FakeScreen) Show()

+ func (screen *FakeScreen) ShowNLines(int)

+ func (screen *FakeScreen) Size() (width int, height int)

+ func (screen *FakeScreen) TerminalBackground() *Color

+ type KeyCode uint16

+ const KeyAltDown

+ const KeyAltLeft

+ const KeyAltRight

+ const KeyAltUp

+ const KeyBackspace

+ const KeyDelete

+ const KeyDown

+ const KeyEnd

+ const KeyEnter

+ const KeyEscape

+ const KeyHome

+ const KeyLeft

+ const KeyPgDown

+ const KeyPgUp

+ const KeyRight

+ const KeyUp

+ type Logger interface

+ Debug func(message string)

+ Error func(message string)

+ Info func(message string)

+ type MouseButtonMask uint16

+ const MouseWheelDown

+ const MouseWheelLeft

+ const MouseWheelRight

+ const MouseWheelUp

+ type MouseMode int

+ const MouseModeAuto

+ const MouseModeScroll

+ const MouseModeSelect

+ type Options struct

+ Logger Logger

+ MouseMode MouseMode

+ TerminalColorCount ColorCount

+ type Progress struct

+ Percent int

+ State ProgressState

+ type ProgressState int

+ const ProgressStateError

+ const ProgressStateIndeterminate

+ const ProgressStatePause

+ const ProgressStateRemove

+ const ProgressStateSet

+ type Screen interface

+ Clear func()

+ Close func()

+ Events func() chan Event

+ GetCell func(column int, row int) StyledRune

+ PauseAndCall func(run func() error) error

+ SetCell func(column int, row int, styledRune StyledRune) int

+ SetProgress func(state ProgressState, percent int)

+ Show func()

+ ShowNLines func(lineCountToShow int)

+ Size func() (width int, height int)

+ TerminalBackground func() *Color

+ func NewScreen(options Options) (Screen, error)

+ type Style struct

+ var StyleDefault Style

+ func (style Style) Background() Color

+ func (style Style) Equal(other Style) bool

+ func (style Style) Foreground() Color

+ func (style Style) HasAttr(attr AttrMask) bool

+ func (style Style) HyperlinkURL() *string

+ func (style Style) RenderUpdateFrom(previous Style, terminalColorCount ColorCount) string

+ func (style Style) String() string

+ func (style Style) WithAttr(attr AttrMask) Style

+ func (style Style) WithBackground(color Color) Style

+ func (style Style) WithForeground(color Color) Style

+ func (style Style) WithHyperlink(hyperlinkURL *string) Style

+ func (style Style) WithUnderlineColor(color Color) Style

+ func (style Style) WithoutAttr(attr AttrMask) Style

+ type StyledRune struct

+ Rune rune

+ Style Style

+ func (styledRune StyledRune) Equal(other StyledRune) bool

+ func (styledRune StyledRune) String() string

+ func (styledRune StyledRune) Width() int