dilemma

package module

v0.0.0-...-083b5a5 Latest Latest Go to latest Published: Sep 23, 2016 License: MIT Imports: 3 Imported by: 1

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

github.com/robbiev/dilemma

Links

Open Source Insights

README ¶

Documentation ¶

Overview ¶

Package dilemma allows creating a TTY selection prompt.

Index ¶

type Config
type Key
- func Prompt(config Config) (string, Key, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	Title   string
	Options []string
	Help    string
}

Config holds the configuration to display a list of options for a user to select.

type Key ¶

type Key int

Key represents keys pressed by the user.

const (
	// Empty means key code information is not applicable
	Empty Key = iota

	// CtrlC means CTRL-C was pressed.
	// Usually this means the user wants to send SIGINT.
	CtrlC
)

func Prompt ¶

func Prompt(config Config) (string, Key, error)

Prompt asks the user to select an option from the list. The selected option is returned in the first return value. The second return value is set to Empty unless the user presses CTRL-C (indicating she wants to signal SIGINT) in which case the value will be CtrlC.

Source Files ¶

View all Source files

dilemma.go

Directories ¶

Path	Synopsis
_example

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