cui

package

v0.179.1 Latest Latest Go to latest Published: Apr 19, 2024 License: Apache-2.0 Imports: 6 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

Package cui implements the Console User Interface for wunderctl

This section is empty.

This section is empty.

This section is empty.

type Handler interface {
	Quit()
	ClearCache()
	RebuildAndRestartApp()
	Restart(debugMode bool)
}

type Options struct {
	// Debug indicates whether debug mode is enabled
	// (it causes changes in the menu)
	Debug bool
}

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

func New(handler Handler, opts Options) *UI

func (u *UI) Close()

Close closes the keyboard handle

func (u *UI) Open() error

Open grabs the keyboard but doesn't start monitoring it. Call Close to properly dispose of it. To start listening for keyboard events, see Run()

func (u *UI) PrintShortHelp()

PrintShortHelp prints a short help menu with the actions for help and quit

func (u *UI) Run()

Run listens for keypresses and runs each respective actions, indefinitely