termi

README

termi - An Text Terminal Library

Documentation

Index

• Constants
• func Clear()
• func ClearTail()
• func Cooked()
• func DisableInvert()
• func Draw(s string)
• func EnableInvert()
• func HideCursor()
• func HomeCursor()
• func LoadCursor()
• func MoveCursor(x, y int)
• func Print(s string)
• func Printf(format string, a ...any) (n int, err error)
• func Raw()
• func SaveCursor()
• func ScrollRange(top, bottom int)
• func ShowCursor()
• func Size() (int, int)
• func StringWidth(s string, col int) int
• type Key
  • func ReadKey() Key
• type KeyKind

Constants

const RuneBackspace rune = '\b'

const RuneDelete rune = 0x7f

const RuneEnter rune = '\r'

const RuneEscape rune = 0x1b

Functions

func Clear

func Clear()

func ClearTail

func ClearTail()

func Cooked

func Cooked()

func DisableInvert

func DisableInvert()

func Draw

func Draw(s string)

func EnableInvert

func EnableInvert()

func HideCursor

func HideCursor()

func HomeCursor

func HomeCursor()

func LoadCursor

func LoadCursor()

func MoveCursor

func MoveCursor(x, y int)

func Print

func Print(s string)

func Printf

func Printf(format string, a ...any) (n int, err error)

func Raw

func Raw()

func SaveCursor

func SaveCursor()

func ScrollRange

func ScrollRange(top, bottom int)

func ShowCursor

func ShowCursor()

func Size

func Size() (int, int)

func StringWidth

func StringWidth(s string, col int) int

Types

type Key

type Key struct {
	Kind KeyKind
	Rune rune
	Raw  string
}

func ReadKey

func ReadKey() Key

type KeyKind

type KeyKind int

const (
	KeyRune KeyKind = iota
	KeyUp
	KeyDown
	KeyRight
	KeyLeft
)