suggest

Documentation

Index

• type Item
• type Model
  • func New(width int) Model
  • func (m Model) CursorDown() Model
  • func (m Model) CursorUp() Model
  • func (m Model) Selected() (Item, bool)
  • func (m Model) SetItems(items []Item) Model
  • func (m Model) SetWidth(width int) Model
  • func (m Model) Update(query string) Model
  • func (m Model) View() string
  • func (m Model) Visible() bool

Types

type Item

type Item struct {
	Label       string // display text
	Description string // optional description
	Value       string // the actual value to insert
}

Item represents a single autocomplete suggestion.

type Model

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

Model is the autocomplete suggestion dropdown component.

func New

func New(width int) Model

New creates a new suggestion Model with default settings.

func (Model) CursorDown

func (m Model) CursorDown() Model

CursorDown moves the selection down, wrapping to the top at the bottom.

func (Model) CursorUp

func (m Model) CursorUp() Model

CursorUp moves the selection up, wrapping to the bottom at the top.

func (Model) Selected

func (m Model) Selected() (Item, bool)

Selected returns the currently selected item, or false if nothing is selected.

func (Model) SetItems

func (m Model) SetItems(items []Item) Model

SetItems sets the available completion items and re-filters.

func (Model) SetWidth

func (m Model) SetWidth(width int) Model

SetWidth sets the dropdown width.

func (Model) Update

func (m Model) Update(query string) Model

Update updates the filter based on the current input query.

func (Model) View

func (m Model) View() string

View renders the suggestion dropdown.

func (Model) Visible

func (m Model) Visible() bool

Visible returns whether the dropdown should be shown.