README
¶
Find Bar
In-buffer search overlay: a narrow query input with a match counter, navigation messages, and a stateless
FindMatcheshelper.
The bar is purely an input. It owns the query, the cursor, and the active
match index; the consumer owns the buffer and is the one that scrolls
to a hit. Pair with editor for Ctrl-F search inside a buffer, or
with any row-oriented component (log-stream, markdown-viewer) that
wants a search affordance.
Install
glyph add find-bar
Hello, world
package main
import (
"fmt"
tea "github.com/charmbracelet/bubbletea"
findbar "github.com/truffle-dev/glyph/components/find-bar"
"github.com/truffle-dev/glyph/components/theme"
)
var lines = []string{"hello world", "world hello", "WORLD"}
type model struct{ bar findbar.Bar }
func (m model) Init() tea.Cmd { return nil }
func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
switch msg := msg.(type) {
case findbar.QueryMsg:
matches := findbar.FindMatches(lines, msg.Value, m.bar.CaseSensitive())
m.bar = m.bar.WithMatches(matches, 0)
return m, nil
case findbar.CloseMsg:
return m, tea.Quit
}
updated, cmd := m.bar.Update(msg)
m.bar = updated
return m, cmd
}
func (m model) View() string { return m.bar.View() }
func main() {
m := model{bar: findbar.New(theme.Default).WithWidth(56)}
if _, err := tea.NewProgram(m).Run(); err != nil {
fmt.Println(err)
}
}
Bindings
typing insert into query (emits QueryMsg)
← → cursor by one rune
Home / End query edges
Backspace delete-back (emits QueryMsg)
Delete delete-forward (emits QueryMsg)
Ctrl-U clear query (emits QueryMsg "")
Enter emit NextMsg
Alt-Enter / F3 with Alt emit PrevMsg
F3 emit NextMsg
Esc emit CloseMsg
API surface
Package: findbar
Types
Bar— Bubble Tea modelMatch{Row, ColStart, ColEnd}— one buffer hit (rune indices)QueryMsg{Value},NextMsg,PrevMsg,CloseMsg
Functions
NewFindMatches(lines, query, caseSensitive) []Match— stateless helper
Model methods
Init,Update,ViewWithWidth,WithQuery,WithCaseSensitive,WithMatchesFocus,Blur,FocusedQuery,CaseSensitive,Current,MatchCount,CurrentMatch
Dependencies
- glyph component
theme(installed automatically) github.com/charmbracelet/bubbletea@v1.3.10github.com/charmbracelet/lipgloss@v1.1.0
Notes
The bar emits messages via Cmd rather than mutating any parent state.
The consumer subscribes by intercepting the four message types in its
own Update: re-run FindMatches on QueryMsg, advance/retreat the
active match index on Next/Prev, dismiss the overlay on Close.
This is what every editor does at the boundary between an input widget
and the buffer it searches.
FindMatches walks lines for plain substring hits and returns matches
in document order. Empty queries return nil. Non-overlapping by
construction: a 2-char query in aaaa produces 2 matches at columns
0..2 and 2..4, not 3. If you want fuzzy or regex behavior, wire your
own search and pass the resulting []Match to WithMatches.
See also
- components/editor — pairs naturally as the search target
- components/find-bar/story — runnable story binary
(
go run -tags glyph_story ./components/find-bar/story/) - registry manifest — the JSON contract
glyph addreads
License
MIT, same as the rest of glyph.
Documentation
¶
Overview ¶
Package findbar renders an in-buffer search bar — the narrow query input that overlays an editor when the user hits Ctrl-F. It owns nothing but the query, the active match index, and the navigation buttons; the actual buffer-side search is performed by the consumer (FindMatches walks any "lines" string for plain or case-insensitive matches; if the consumer wants fuzzy or regex they wire their own).
Composition shape:
bar := findbar.New(theme.Default) bar = bar.WithQuery(q).WithMatches(matches, current) // In Update: pass tea.KeyMsg to bar.Update; act on its messages.
The bar emits four messages: QueryMsg{Value} when the input changes, NextMsg / PrevMsg when the user hits Enter/F3/Shift-F3, CloseMsg when the user hits Esc. The consumer is the one that scrolls the editor to the next match — the bar is purely an input.
Index ¶
- type Bar
- func (b Bar) Blur() Bar
- func (b Bar) CaseSensitive() bool
- func (b Bar) Current() int
- func (b Bar) CurrentMatch() (Match, bool)
- func (b Bar) Focus() Bar
- func (b Bar) Focused() bool
- func (b Bar) Init() tea.Cmd
- func (b Bar) MatchCount() int
- func (b Bar) Query() string
- func (b Bar) Update(msg tea.Msg) (Bar, tea.Cmd)
- func (b Bar) View() string
- func (b Bar) WithCaseSensitive(on bool) Bar
- func (b Bar) WithMatches(matches []Match, current int) Bar
- func (b Bar) WithQuery(s string) Bar
- func (b Bar) WithWidth(w int) Bar
- type CloseMsg
- type Match
- type NextMsg
- type PrevMsg
- type QueryMsg
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Bar ¶
type Bar struct {
// contains filtered or unexported fields
}
Bar is a Bubble Tea model for the find bar.
func (Bar) CaseSensitive ¶
CaseSensitive reports the bar's current match mode.
func (Bar) CurrentMatch ¶
CurrentMatch returns the active match and true when one exists.
func (Bar) MatchCount ¶
MatchCount returns the size of the bar's match set.
func (Bar) Update ¶
Update implements tea.Model. It returns its own messages via Cmd rather than mutating any parent state; the consumer is expected to re-issue queries and navigate the editor on each message.
func (Bar) View ¶
View renders the bar: query input on the left, match counter on the right ("3 / 12" or "no matches"), wrapped in a single-line bordered frame the same height as a status-bar row.
func (Bar) WithCaseSensitive ¶
WithCaseSensitive toggles case-sensitive matching for FindMatches.
func (Bar) WithMatches ¶
WithMatches replaces the match set; current is clamped to a valid index or -1 when empty.
type Match ¶
Match is a single hit inside the buffer. Row is 0-based; ColStart and ColEnd are rune indices (start-inclusive, end-exclusive).
func FindMatches ¶
FindMatches is a stateless helper: walk lines for every occurrence of query and return the match set in document order. Empty queries return nil. The bar passes b.CaseSensitive() through; consumers can call FindMatches directly with any boolean.
type NextMsg ¶
type NextMsg struct{}
NextMsg / PrevMsg are emitted when the user requests cursor motion.
Source Files