package
0.10.0
Repository: https://github.com/abhinav/git-spice.git
Documentation: pkg.go.dev

# Packages

Package fliptree renders a tree of nodes as text in reverse: children first, then parent.
Package uitest provides means of testing UI interactions.
Package widget implements more complex user interface components on top of the primitives offered in the ui package.

# Functions

AcceptField is a [tea.Cmd] to accept the currently focused field.
ComparableOptions creates a list of options from a list of comparable values and sets the selected option.
DefaultEditor returns the default editor configuration.
Defer defers field construction using the given function.
Interactive reports whether the given view is interactive.
NewConfirm builds a new confirm field that prompts the user with a yes or no question.
NewForm builds a new form with the given fields.
NewInput builds a new input field.
NewList creates a new [List] with default settings.
NewMultiSelect constructs a new multi-select field.
NewOpenEditor builds an [OpenEditor] field.
NewSelect builds a new [Select] field.
NewStyle returns a new lipgloss style based on our default renderer.
Run presents the given field to the user using the given View.
SkipField is a [tea.Cmd] to skip the currently focused field.

# Variables

This file defines the common defaults and styles for the UI components.
DefaultConfirmKeyMap is the default key map for a [Confirm] field.
DefaultConfirmStyle is the default style for a [Confirm] field.
DefaultFormKeyMap is the default key map for a [Form].
DefaultFormStyle is the default style for a [Form].
DefaultInputKeyMap is the default key map for an input field.
DefaultInputStyle is the default style for an input field.
DefaultListKeyMap specifies the default key bindings for [List].
DefaultListStyle is the default style for a [List].
DefaultMultiSelectKeyMap is the default key map for a [MultiSelect].
DefaultMultiSelectStyle is the default style for a [MultiSelect].
DefaultOpenEditorKeyMap is the default key map for an [OpenEditor] field.
DefaultOpenEditorStyle is the default style for an [OpenEditor] field.
DefaultSelectKeyMap is the default key map for a [Select].
DefaultSelectStyle is the default style for a [Select].
ErrPrompt indicates that we're not running in interactive mode.
This file defines the common defaults and styles for the UI components.
This file defines the common defaults and styles for the UI components.
This file defines the common defaults and styles for the UI components.
This file defines the common defaults and styles for the UI components.
This file defines the common defaults and styles for the UI components.
Renderer is a lipgloss renderer that writes to stderr.
This file defines the common defaults and styles for the UI components.

# Structs

Confirm is a boolean confirmation field that takes a yes or no answer.
ConfirmKeyMap defines the key bindings for [Confirm].
ConfirmStyle configures the appearance of a [Confirm] field.
Deferred is a field that is not constructed until initialization time.
Editor configures the editor to open.
FileView is a non-interactive view that posts messages to the given file.
Form presents a series of fields for the user to fill.
FormKeyMap defines the key bindings for a form.
FormRunOptions specifies options for [Form.Run].
FormStyle configures the appearance of a [Form].
Input is a text input field.
InputKeyMap defines the key bindings for an input field.
InputStyle defines the styles for an input field.
List is a prompt that allows selecting from a list of options.
ListItem is an item in a [List].
ListKeyMap defines key bindings for [List].
ListStyle defines the styles for [List].
MultiSelect is a prompt that allows selecting one or more options.
MultiSelectKeyMap defines the key bindings for [MultiSelect].
MultiSelectOption is an option for a multi-select field.
MultiSelectStyle defines the styles for [MultiSelect].
OpenEditor is a dialog that asks the user to press a key to open an editor and write a message.
OpenEditorKeyMap defines the key bindings for [OpenEditor].
OpenEditorStyle defines the display style for [OpenEditor].
Select is a prompt that allows selecting from a list of options using a fuzzy filter.
SelectKeyMap defines the key bindings for [Select].
SelectOption is a single option for a select field.
SelectStyle defines the styles for [Select].
TerminalView is a view that posts messages to the user's terminal and allows prompting for input.

# Interfaces

Field is a single field in a form.
InteractiveView is a view that allows prompting the user for input.
View provides access to the UI, allowing the application to send messages to the user, and in interactive mode, prompt for input.
Writer receives a rendered view of a [Field].