menu

Documentation

Index

• type Item
• type Search
  • func NewSearch(items []Item, emptyQueryShowAll bool) *Search
  • func (s *Search) Execute(q string)
  • func (s *Search) Results() []Item

Types

type Item

type Item struct {
	// Name is the displayed name of the item.
	// This is also used when searching for menu items.
	Name string

	// Aliases are a search terms for which this item will always rank first.
	Aliases []string

	// Action is the action to perform when the user selects the menu item.
	// This should be a function that accepts a single *EditorState arg.
	Action any
}

Item represents an item in the editor's menu.

type Search

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

Search performs approximate text searches for menu items matching a query string.

func NewSearch

func NewSearch(items []Item, emptyQueryShowAll bool) *Search

func (*Search) Execute

func (s *Search) Execute(q string)

Execute searches for the given query.

func (*Search) Results

func (s *Search) Results() []Item

Results returns the menu items matching the current query. Items are sorted descending by relevance to the query, with ties broken by lexicographic ordering.