timui

package module

Go to main page

Versions in this module

v0

v0.0.6

Sep 9, 2026

v0.0.5

Sep 4, 2026

Changes in this version

+ func WriteClipboardLocal(text string) error

v0.0.4

Sep 4, 2026

Changes in this version

type Backend

+ WriteClipboard func(text string)

+ type SelectionTheme struct

+ BG RGBColor

+ Text RGBColor

type Theme

+ Selection SelectionTheme

type Timui

+ func (t *Timui) PeekCopyRect() mathi.Box2

+ func (t *Timui) PopCopyRect()

+ func (t *Timui) PushCopyRect(area mathi.Box2)

+ func (t *Timui) WithCopyRect(area mathi.Box2, body func())

v0.0.3

Sep 2, 2026

Changes in this version

type Input

+ Mods ModMask

+ type ModMask int

+ const ModAlt

+ const ModCtrl

+ const ModShift

+ func (m ModMask) Has(o ModMask) bool

type Timui

+ func (t *Timui) Mods() ModMask

v0.0.2

Sep 1, 2026

v0.0.1

Sep 1, 2026

Changes in this version

+ var Black = RGBA(0x0, 0x0, 0x0, 0xff)

+ var BorderBasic = BorderStyle

+ var BorderDouble = BorderStyle

+ var BorderNone = BorderStyle

+ var BorderRoundSingle = BorderStyle

+ var BorderSingle = BorderStyle

+ var DefaultTheme = Theme

+ var Transparent = RGBA(0, 0, 0, 0)

+ var White = RGBA(0xff, 0xff, 0xff, 0xff)

+ func OptionGroup[V comparable](t *Timui, name string, selected *V, f func(*OptionGroupElement[V]))

+ type Backend interface

+ MousePosition func() mathi.Vec2

+ MousePressed func(key Key) bool

+ Render func()

+ Set func(pos mathi.Vec2, char rune, fg, bg uint32)

+ Size func() mathi.Vec2

+ TakeInput func() Input

+ type BorderStyle struct

+ Horizontal [3]rune

+ Rect [6]rune

+ Vertical [3]rune

+ type Draggable struct

+ type Grid struct

+ func (g *Grid) Columns(opts *SplitOptions, cells ...func(cell *GridCell))

+ func (g *Grid) Rows(opts *SplitOptions, cells ...func(cell *GridCell))

+ type GridCell struct

+ func (c *GridCell) Columns(opts *SplitOptions, cells ...func(cell *GridCell))

+ func (c *GridCell) Rows(opts *SplitOptions, cells ...func(cell *GridCell))

+ type Input struct

+ Keys []KeyEvent

+ Wheel mathi.Vec2

+ type Key int

+ const KeyBackspace

+ const KeyDelete

+ const KeyDown

+ const KeyEnd

+ const KeyEnter

+ const KeyEscape

+ const KeyHome

+ const KeyLeft

+ const KeyNone

+ const KeyPageDown

+ const KeyPageUp

+ const KeyRight

+ const KeyRune

+ const KeyTab

+ const KeyUp

+ var MouseButtonLeft Key = 1_000_000

+ var MouseButtonRight Key = 1_000_001

+ type KeyEvent struct

+ Key Key

+ Rune rune

+ type MouseInput struct

+ func (m *MouseInput) Hovered() int

+ func (m *MouseInput) LeftPressed() int

+ func (m *MouseInput) LeftReleased() bool

+ func (m *MouseInput) Wheel() mathi.Vec2

+ type OptionGroupElement struct

+ func (o OptionGroupElement[V]) Option(name string, value V) bool

+ type Panel struct

+ func (p *Panel) HLine()

+ func (p *Panel) Header(body func())

+ type RGBAColor uint32

+ func MustRGBAS(s string) RGBAColor

+ func RGBA(r, g, b, a int) RGBAColor

+ func RGBAS(s string) (RGBAColor, error)

+ func (rgb RGBAColor) String() string

+ func (rgba RGBAColor) RGBA() (int, int, int, int)

+ type RGBColor uint32

+ func MustRGBS(s string) RGBColor

+ func RGB(r, g, b int) RGBColor

+ func RGBS(s string) (RGBColor, error)

+ func (rgb RGBColor) Add(o RGBColor) RGBColor

+ func (rgb RGBColor) Blend(rgba RGBAColor) RGBColor

+ func (rgb RGBColor) MulDiv(factor, div int) RGBColor

+ func (rgb RGBColor) RGB() (int, int, int)

+ func (rgb RGBColor) RGBA(a int) RGBAColor

+ func (rgb RGBColor) String() string

+ type ScrollBarTheme struct

+ ArrowBG RGBColor

+ BG RGBColor

+ Knob RGBColor

+ KnobBG RGBColor

+ Text RGBColor

+ type ScrollState struct

+ Follow bool

+ Offset int

+ ViewHeight int

+ func (s *ScrollState) Bottom()

+ func (s *ScrollState) PageDown()

+ func (s *ScrollState) PageUp()

+ func (s *ScrollState) Scroll(rows int)

+ func (s *ScrollState) Top()

+ type SplitOptions struct

+ func Split() *SplitOptions

+ func (s *SplitOptions) Add(factor float32, fixed int) *SplitOptions

+ func (s *SplitOptions) Factor(factors ...float32) *SplitOptions

+ func (s *SplitOptions) Fixed(fixed ...int) *SplitOptions

+ func (s *SplitOptions) Pad(padding int) *SplitOptions

+ type Theme struct

+ BG RGBColor

+ BorderBG RGBColor

+ BorderLine RGBColor

+ BorderStyle BorderStyle

+ ScrollBar ScrollBarTheme

+ Text RGBColor

+ Widget WidgetTheme

+ func (t *Theme) WithBorder(b BorderStyle, content func())

+ type Timui struct

+ Theme Theme

+ func New(backend Backend) *Timui

+ func (g *Timui) Button(name string) bool

+ func (g *Timui) Checkbox(name string, checked *bool) bool

+ func (g *Timui) Columns(opts *SplitOptions, cells ...func())

+ func (g *Timui) Dropdown(id string, elements int, selected *int, paint func(i int, s bool))

+ func (g *Timui) PeekClip() mathi.Box2

+ func (g *Timui) PopClip()

+ func (g *Timui) PushClip(area mathi.Box2)

+ func (g *Timui) Rows(opts *SplitOptions, cells ...func())

+ func (g *Timui) ScrollAreaV(id string, body func())

+ func (g *Timui) ScrollListV(id string, state *ScrollState, count int, row func(i int))

+ func (g *Timui) WithClip(area mathi.Box2, body func())

+ func (t *Timui) Border(style [6]rune, fg, bg RGBColor)

+ func (t *Timui) ClipContains(pos mathi.Vec2) bool

+ func (t *Timui) CurrentArea() *mathi.Box2

+ func (t *Timui) Dialog(title string, visible *bool, content func())

+ func (t *Timui) Draggable(id string, area mathi.Box2, size mathi.Vec2, pos *mathi.Vec2) (bool, bool)

+ func (t *Timui) Finish()

+ func (t *Timui) GetMousePosition() mathi.Vec2

+ func (t *Timui) Grid(body func(grid *Grid))

+ func (t *Timui) HLine(style [3]rune, fg, bg RGBColor)

+ func (t *Timui) KeyPressed(key Key) bool

+ func (t *Timui) Keys() []KeyEvent

+ func (t *Timui) Label(name string)

+ func (t *Timui) MouseInput(id string) *MouseInput

+ func (t *Timui) MouseInputForArea(id string, area mathi.Box2) *MouseInput

+ func (t *Timui) MouseInputForSize(id string, size mathi.Vec2) *MouseInput

+ func (t *Timui) Pad(top, right, bottom, left int, body func())

+ func (t *Timui) Panel(body func(p *Panel))

+ func (t *Timui) PopArea()

+ func (t *Timui) PushArea(area mathi.Box2)

+ func (t *Timui) PushAreaTranslation(dir mathi.Vec2)

+ func (t *Timui) RunePressed(r rune) bool

+ func (t *Timui) Set(pos mathi.Vec2, char rune, fg, bg RGBColor)

+ func (t *Timui) SetAlpha(pos mathi.Vec2, char rune, fg, bg RGBAColor)

+ func (t *Timui) SetArea(char rune, fg, bg RGBColor)

+ func (t *Timui) SetAreaAlpha(char rune, fg, bg RGBAColor)

+ func (t *Timui) SetBorder(pos mathi.Vec2, char rune, fg, bg RGBColor)

+ func (t *Timui) Size() mathi.Vec2

+ func (t *Timui) Text(name string, pos mathi.Vec2, fg, bg RGBAColor)

+ func (t *Timui) VLine(style [3]rune, fg, bg RGBColor)

+ func (t *Timui) WithArea(area mathi.Box2, body func())

+ func (t *Timui) WithAreaTranslation(dir mathi.Vec2, body func())

+ func (t *Timui) WithID(id string, body func())

+ type WidgetTheme struct

+ BG RGBColor

+ FocusLine RGBColor

+ HoverBG RGBColor

+ InteractBG RGBColor

+ Line RGBColor

+ Text RGBColor

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL