Skip to content

SearchBar

Enter fires onSubmit with the current text. If the dropdown is open, Enter selects the highlighted result instead. Esc closes the dropdown; a second Esc clears the input.

SearchBar preview

SearchBar provides search input with optional results dropdown

Constructor func NewSearchBar() *SearchBar

Usage

bar := components.NewSearchBar().
SetPlaceholder("Search pods...").
SetIcon("").
SetMaxResults(8)
bar.SetOnChange(func(query string) {
bar.SetResults([]components.SearchResult{
{Text: query + "-1"},
{Text: query + "-2"},
})
})
bar.SetOnSelect(func(r components.SearchResult) {
fmt.Println("selected:", r.Text)
})
fmt.Println(bar != nil)

Methods

Method Signature Description
Clear func (s *SearchBar) Clear() *SearchBar Clear clears the query and results
ClearResults func (s *SearchBar) ClearResults() *SearchBar ClearResults removes all results
GetFieldHeight func (s *SearchBar) GetFieldHeight() int GetFieldHeight returns preferred height
GetQuery func (s *SearchBar) GetQuery() string GetQuery returns the current query
SetIcon func (s *SearchBar) SetIcon(icon string) *SearchBar SetIcon sets the search icon
SetMaxResults func (s *SearchBar) SetMaxResults(max int) *SearchBar SetMaxResults sets maximum results to display
SetOnCancel func (s *SearchBar) SetOnCancel(fn func()) *SearchBar SetOnCancel sets the cancel callback
SetOnChange func (s *SearchBar) SetOnChange(fn func(query string)) *SearchBar SetOnChange sets the query change callback
SetOnSearch func (s *SearchBar) SetOnSearch(fn func(query string)) *SearchBar SetOnSearch sets the search callback
SetOnSelect func (s *SearchBar) SetOnSelect(fn func(result SearchResult)) *SearchBar SetOnSelect sets the result selection callback
SetPlaceholder func (s *SearchBar) SetPlaceholder(text string) *SearchBar SetPlaceholder sets the placeholder text
SetQuery func (s *SearchBar) SetQuery(query string) *SearchBar SetQuery sets the search query
SetResults func (s *SearchBar) SetResults(results []SearchResult) *SearchBar SetResults sets the search results
SetShowSpinner func (s *SearchBar) SetShowSpinner(show bool) *SearchBar SetShowSpinner shows/hides the loading spinner

Types

type SearchResult struct SearchResult represents a search result item
FieldTypeDescription
Text string
Description string
Icon string
Data any