tui

package module

v0.0.2 Latest Latest Go to latest Published: Mar 25, 2021 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

git.crumpington.com/public/tui

Links

Open Source Insights

README ¶

tui

Text user interface for golang.

Documentation ¶

Index ¶

Variables
func Clear()
func EditInEditor(s string) (string, error)
func Print(a ...interface{})
func Printf(format string, a ...interface{})
func Println(a ...interface{})
func ReadPassword(prompt string) string
func Readline(prompt string) string
func Start()
func Stop()
func TermSize() (w, h int)
func WrapText(s string, width int) ([]string, int)
func Write(b []byte)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	EscapeNormal    = []byte{27, '[', '0', 'm'}
	EscapeBold      = []byte{27, '[', '1', 'm'}
	EscapeFaint     = []byte{27, '[', '2', 'm'}
	EscapeItalic    = []byte{27, '[', '3', 'm'}
	EscapeUnderline = []byte{27, '[', '4', 'm'}
	EscapeInvert    = []byte{27, '[', '7', 'm'}
)

Functions ¶

func Clear ¶

func Clear()

Clear clears the terminal.

func EditInEditor ¶ added in v0.0.2

func EditInEditor(s string) (string, error)

Edit the string s using the editor defined by the environment variable EDITOR.

func Print ¶ added in v0.0.2

func Print(a ...interface{})

func Printf ¶ added in v0.0.2

func Printf(format string, a ...interface{})

func Println ¶ added in v0.0.2

func Println(a ...interface{})

func ReadPassword ¶ added in v0.0.2

func ReadPassword(prompt string) string

ReadPassword reads a line of input from the user, but doesn't echo to the screen.

func Readline ¶ added in v0.0.2

func Readline(prompt string) string

Readline reads a line of input from the user.

func Start ¶

func Start()

func Stop ¶

func Stop()

func TermSize ¶ added in v0.0.2

func TermSize() (w, h int)

func WrapText ¶ added in v0.0.2

func WrapText(s string, width int) ([]string, int)

WrapText takes the text in s and wraps it to the width. It returns the individual wrapped lines, and the length of the longest wrapped line.

If the width is less than or equal to zero, it is set to the terminal width.

In order to wrap the text in a reasonable way, white space is trimmed and collapsed througout the text.

func Write ¶ added in v0.0.2

func Write(b []byte)

Write sends raw bytes to the terminal.

Types ¶

This section is empty.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
example
simple

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