timui

package module
v0.0.0-...-0962f0d Latest Latest
Warning

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

 Go to latest Published: Jul 14, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

README

TIMUI

Disclaimer: This is a personal pet project / experiment

is a terminal ui immediate mode user interface library. inspired by https://github.com/ocornut/imgui

Focus

  • simple
  • lightweight

Widgets

are rendered using function calls like:

if tui.Button("ClickMe +") {
  count++
}

if tui.Button("ClickMe -") {
  count--
}

tui.Checkbox("Alpha", &checkedA)

Backends

The manipulating of the terminal and event handling is done via backends.

Currently there is a github.com/gdamore/tcell backend.

Example

Demo

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Transparent = RGBA(0, 0, 0, 0)
	White       = RGBA(0xff, 0xff, 0xff, 0xff)
	Black       = RGBA(0x0, 0x0, 0x0, 0xff)
)
View Source 
var BorderBasic = BorderStyle{
	Rect:       [6]rune{'-', '|', '/', '\\', '\\', '/'},
	Vertical:   [3]rune{'+', '|', '+'},
	Horizontal: [3]rune{'+', '-', '+'},
}
View Source 
var BorderDouble = BorderStyle{
	Rect:       [6]rune{'═', '║', '╔', '╗', '╚', '╝'},
	Vertical:   [3]rune{'╦', '║', '╩'},
	Horizontal: [3]rune{'╠', '═', '╣'},
}
View Source 
var BorderNone = BorderStyle{
	Rect:       [6]rune{' ', ' ', ' ', ' ', ' ', ' '},
	Vertical:   [3]rune{' ', ' ', ' '},
	Horizontal: [3]rune{' ', ' ', ' '},
}
View Source 
var BorderRoundSingle = BorderStyle{
	Rect:       [6]rune{'─', '│', '╭', '╮', '╰', '╯'},
	Vertical:   [3]rune{'┬', '│', '┴'},
	Horizontal: [3]rune{'├', '─', '┤'},
}
View Source 
var BorderSingle = BorderStyle{
	Rect:       [6]rune{'─', '│', '┌', '┐', '└', '┘'},
	Vertical:   [3]rune{'┬', '│', '┴'},
	Horizontal: [3]rune{'├', '─', '┤'},
}
View Source 
var DefaultTheme = Theme{
	BG:         MustRGBS("#000"),
	Text:       MustRGBS("#f33"),
	BorderLine: MustRGBS("#3ff"),
	BorderBG:   MustRGBS("#000"),
	Widget: WidgetTheme{
		BG:         MustRGBS("#004"),
		Text:       MustRGBS("#bbb"),
		Line:       MustRGBS("#a0a"),
		HoverBG:    MustRGBS("#22a"),
		InteractBG: MustRGBS("#008"),
		FocusLine:  MustRGBS("#ffa"),
	},
	ScrollBar: ScrollBarTheme{
		Text:    MustRGBS("#bbb"),
		BG:      MustRGBS("#013"),
		ArrowBG: MustRGBS("#135"),
		Knob:    MustRGBS("#46f"),
		KnobBG:  MustRGBS("#00a"),
	},
	BorderStyle: BorderDouble,
}

Functions

func OptionGroup 

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

Types

type Backend 

type Backend interface {
	Size() mathi.Vec2
	MousePosition() mathi.Vec2
	MousePressed(key Key) bool
	Set(pos mathi.Vec2, char rune, fg, bg uint32)
	Render()
}

type BorderStyle 

type BorderStyle struct {
	Rect       [6]rune
	Horizontal [3]rune
	Vertical   [3]rune
}

type Draggable 

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

type Grid 

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

func (*Grid) Columns 

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

func (*Grid) Rows 

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

type GridCell 

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

GridCell is the context of one grid cell. Its area is the complete cell including the border lines around it, so nested splits overlap the parent's lines and their divider glyphs merge into junctions.

func (*GridCell) Columns 

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

func (*GridCell) Rows 

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

type Key 

type Key int
var (
	MouseButtonLeft  Key = 1_000_000
	MouseButtonRight Key = 1_000_001
)

type MouseInput 

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

func (*MouseInput) Hovered 

func (m *MouseInput) Hovered() int

func (*MouseInput) LeftPressed 

func (m *MouseInput) LeftPressed() int

func (*MouseInput) LeftReleased 

func (m *MouseInput) LeftReleased() bool

type OptionGroupElement 

type OptionGroupElement[V comparable] struct {
	// contains filtered or unexported fields
}

func (OptionGroupElement[V]) Option 

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

type Panel 

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

func (*Panel) HLine 

func (p *Panel) HLine()

func (*Panel) Header 

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

Header runs body inside a one-row strip on the panel's top border line.

type RGBAColor 

type RGBAColor uint32

func MustRGBAS 

func MustRGBAS(s string) RGBAColor

func RGBA 

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

func RGBAS 

func RGBAS(s string) (RGBAColor, error)

RGBAS parses "#rgba" or "#rrggbbaa" into an RGBAColor.

func (RGBAColor) RGBA 

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

func (RGBAColor) String 

func (rgb RGBAColor) String() string

type RGBColor 

type RGBColor uint32

func MustRGBS 

func MustRGBS(s string) RGBColor

func RGB 

func RGB(r, g, b int) RGBColor

func RGBS 

func RGBS(s string) (RGBColor, error)

RGBS parses "#rgb" or "#rrggbb" into an RGBColor.

func (RGBColor) Add 

func (rgb RGBColor) Add(o RGBColor) RGBColor

func (RGBColor) Blend 

func (rgb RGBColor) Blend(rgba RGBAColor) RGBColor

func (RGBColor) MulDiv 

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

func (RGBColor) RGB 

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

func (RGBColor) RGBA 

func (rgb RGBColor) RGBA(a int) RGBAColor

func (RGBColor) String 

func (rgb RGBColor) String() string

type ScrollBarTheme 

type ScrollBarTheme struct {
	Text    RGBColor
	BG      RGBColor
	ArrowBG RGBColor
	Knob    RGBColor
	KnobBG  RGBColor
}

type SplitOptions 

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

func Split 

func Split() *SplitOptions

func (*SplitOptions) Add 

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

func (*SplitOptions) Factor 

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

func (*SplitOptions) Fixed 

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

func (*SplitOptions) Pad 

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

type Theme 

type Theme struct {
	BG          RGBColor
	Text        RGBColor
	BorderLine  RGBColor
	BorderBG    RGBColor
	Widget      WidgetTheme
	ScrollBar   ScrollBarTheme
	BorderStyle BorderStyle
}

func (*Theme) WithBorder 

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

type Timui 

type Timui struct {
	Theme Theme
	// contains filtered or unexported fields
}

func New 

func New(backend Backend) *Timui

func (*Timui) Border 

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

func (*Timui) Button 

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

func (*Timui) Checkbox 

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

func (*Timui) ClipContains 

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

func (*Timui) Columns 

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

Columns splits the current area horizontally and runs one cell func per split entry, each inside its column area. Afterwards the parent cursor is advanced to the bottom of the tallest column. Panics if the cell count does not match the split count.

func (*Timui) CurrentArea 

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

func (*Timui) Dialog 

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

func (*Timui) Draggable 

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

func (*Timui) Dropdown 

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

func (*Timui) Finish 

func (t *Timui) Finish()

func (*Timui) GetMousePosition 

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

func (*Timui) Grid 

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

Grid draws a bordered container and runs body inside its padded area. Rows and Columns on the grid subdivide it with divider lines that join the surrounding border.

func (*Timui) HLine 

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

func (*Timui) Label 

func (t *Timui) Label(name string)

func (*Timui) MouseInput 

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

MouseInput creates a mouse area for the current cursor area

func (*Timui) MouseInputForArea 

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

MouseInputForArea creates a mouse area from given area relative to the current cursor area

func (*Timui) MouseInputForSize 

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

MouseInputForSize creates a mouse area from given size relative to the current cursor area

func (*Timui) Pad 

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

func (*Timui) Panel 

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

Panel draws a bordered container and runs body inside its padded area.

func (*Timui) PeekClip 

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

func (*Timui) PopArea 

func (t *Timui) PopArea()

func (*Timui) PopClip 

func (g *Timui) PopClip()

func (*Timui) PushArea 

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

func (*Timui) PushAreaTranslation 

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

func (*Timui) PushClip 

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

func (*Timui) Rows 

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

Rows splits the current area vertically and runs one cell func per split entry, each inside its row area. Panics if the cell count does not match the split count.

func (*Timui) ScrollAreaV 

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

func (*Timui) Set 

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

func (*Timui) SetAlpha 

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

func (*Timui) SetArea 

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

func (*Timui) SetAreaAlpha 

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

func (*Timui) SetBorder 

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

func (*Timui) Size 

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

func (*Timui) Text 

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

func (*Timui) VLine 

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

func (*Timui) WithArea 

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

WithArea runs body with area as the current area.

func (*Timui) WithAreaTranslation 

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

WithAreaTranslation runs body with the current area translated by dir.

func (*Timui) WithClip 

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

WithClip runs body with drawing clipped to area.

func (*Timui) WithID 

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

WithID runs body inside an id scope. Widgets created by body derive their id relative to this scope, so identically-labelled widgets (for example two "+" buttons in different rows) stay distinct.

type WidgetTheme 

type WidgetTheme struct {
	BG         RGBColor
	Text       RGBColor
	Line       RGBColor
	HoverBG    RGBColor
	InteractBG RGBColor
	FocusLine  RGBColor
}

Source Files

View all Source files

Directories

Path Synopsis
cmd
example command
test

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.