searchinput

package

v1.13.0-rc2 Latest Latest Go to latest Published: Jul 21, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

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

Model is a styled search input box that renders above the main view, mirroring the command input (":") component.

func New() *Model

New creates a new search input (inactive by default).

func (m *Model) Confirm()

Confirm locks the search input into passive mode (query visible but not editable).

func (m *Model) Editing() bool

Editing reports whether the search input is in editing mode.

func (m *Model) Hide()

Hide deactivates the search input and resets its value.

func (m *Model) Query() string

Query returns the current input value.

func (m *Model) Resume() tea.Cmd

Resume transitions from passive back to active editing mode.

func (m *Model) Show() tea.Cmd

Show activates the search input and returns a blink command.

func (m *Model) Update(msg tea.Msg) tea.Cmd

Update handles key messages while the search input is active.

func (m *Model) View() string

View renders the search input line. Returns "" when inactive.

func (m *Model) Visible() bool

Visible reports whether the search input is currently active.

type SearchClearedMsg struct{}

SearchClearedMsg is emitted when the user cancels the search (Esc or backspace on an empty query). The active view should clear any filter.

type SearchQueryMsg struct{ Query string }

SearchQueryMsg is emitted on every keystroke so the active view can apply the filter incrementally.