package ui

Import Path
	github.com/reeflective/console/internal/ui (on go.dev)

Dependency Relation
	imports 4 packages, and imported by one package

Involved Source Files

	    prompt.go
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type Prompt (struct)
		Prompt - A prompt is a set of functions that return the strings to print
		for each prompt type. The console will call these functions to retrieve
		the prompt strings to print. Each menu has its own prompt.

		Fields (total 5)
			Primary func() string
				// Primary is the main prompt.

			Right func() string
				// Right is the prompt printed on the right side of the screen.

			Secondary func() string
				// Secondary is the prompt used when the user is typing a multi-line command.

			Tooltip func(word string) string
				// Tooltip is used to hint on the root command, replacing right prompts if not empty.

			Transient func() string
				// Transient is used if the console shell is configured to be transient.

		As Outputs Of (at least one exported)
			func NewPrompt(appName, menuName string, stdout *bytes.Buffer) *Prompt
		As Inputs Of (at least one exported)
			func BindPrompt(p *Prompt, shell *readline.Shell)


Package-Level Functions (total 2)

	 func BindPrompt(p *Prompt, shell *readline.Shell)
		BindPrompt reassigns the prompt printing functions to the shell helpers.

	 func NewPrompt(appName, menuName string, stdout *bytes.Buffer) *Prompt
		NewPrompt requires the name of the application and the current menu,
		as well as the current menu output buffer to produce a new, default prompt.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.