fzf

README

go-fzf

Fuzzy Finder CLI and Library.

• Usage
  • CLI
  • Library
• LICENSE

Usage

Using as a CLI

If you want to see what go-fzf can do for you, try the gofzf CLI.

See docs/cli/README.md for more information.

Using as a Library

go-fzf makes it easy to create a highly customizable Fuzzy Finder.
For example, the following Fuzzy Finder can be created with just this program.

package main

import (
	"fmt"
	"log"

	"github.com/koki-develop/go-fzf"
)

func main() {
	items := []string{"hello", "world", "foo", "bar"}

	f := fzf.New(
		fzf.WithStyles(
			fzf.WithStyleCursor(fzf.Style{ForegroundColor: "#ff0000"}),
			fzf.WithStyleMatches(fzf.Style{ForegroundColor: "#00ff00"}),
		),
	)
	idxs, err := f.Find(items, func(i int) string { return items[i] })
	if err != nil {
		log.Fatal(err)
	}

	for _, i := range idxs {
		fmt.Println(items[i])
	}
}

See docs/library/README.md for more information.

LICENSE

MIT

Documentation

Index

• Variables
• type FZF
  • func New(opts ...Option) *FZF
  • func (fzf *FZF) Find(items interface{}, itemFunc func(i int) string, opts ...FindOption) ([]int, error)
• type FindOption
  • func WithItemPrefix(f func(i int) string) FindOption
• type KeyMap
• type Option
  • func WithCountView(f func(itemsCount, matchesCount, windowWidth int) string) Option
  • func WithCountViewEnabled(b bool) Option
  • func WithCursor(c string) Option
  • func WithInputPlaceholder(p string) Option
  • func WithKeyMap(km KeyMap) Option
  • func WithLimit(l int) Option
  • func WithNoLimit(n bool) Option
  • func WithPrompt(p string) Option
  • func WithSelectedPrefix(p string) Option
  • func WithStyles(opts ...StylesOption) Option
  • func WithUnselectedPrefix(p string) Option
• type Style
• type Styles
  • func NewStyles(opts ...StylesOption) *Styles
• type StylesOption
  • func WithStyleCursor(s Style) StylesOption
  • func WithStyleCursorLine(s Style) StylesOption
  • func WithStyleMatches(s Style) StylesOption
  • func WithStyleSelectedPrefix(s Style) StylesOption
  • func WithStyleUnselectedPrefix(s Style) StylesOption

Variables

var (
	// ErrAbort is returned when a Fuzzy Finder is aborted.
	ErrAbort = errors.New("abort")
)

Types

type FZF

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

Fuzzy Finder.

func New

func New(opts ...Option) *FZF

New returns a new Fuzzy Finder.

func (*FZF) Find

func (fzf *FZF) Find(items interface{}, itemFunc func(i int) string, opts ...FindOption) ([]int, error)

Find launches the Fuzzy Finder and returns a list of indexes of the selected items.

type FindOption

type FindOption func(o *findOption)

Option represents a option for the Find.

func WithItemPrefix

func WithItemPrefix(f func(i int) string) FindOption

WithItemPrefix sets the prefix function of the item.

type KeyMap

type KeyMap struct {
	Up     []string
	Down   []string
	Toggle []string
	Choose []string
	Abort  []string
}

KeyMap is the key mapping for the Fuzzy Finder.

type Option

type Option func(o *option)

Option represents a option for the Fuzzy Finder.

func WithCountView

func WithCountView(f func(itemsCount, matchesCount, windowWidth int) string) Option

WithCountView sets the function to create the count view.

func WithCountViewEnabled

func WithCountViewEnabled(b bool) Option

WithCountViewEnabled enables or disables count view.

func WithCursor

func WithCursor(c string) Option

WithCursor sets the cursor.

func WithInputPlaceholder

func WithInputPlaceholder(p string) Option

WithInputPlaceholder sets the placeholder for input.

func WithKeyMap

func WithKeyMap(km KeyMap) Option

WithKeyMap sets the key mapping.

func WithLimit

func WithLimit(l int) Option

WithLimit sets the number of items that can be selected.

func WithNoLimit

func WithNoLimit(n bool) Option

WithNoLimit can be set to `true` to allow unlimited item selection.

func WithPrompt

func WithPrompt(p string) Option

WithPrompt sets the prompt text.

func WithSelectedPrefix

func WithSelectedPrefix(p string) Option

WithSelectedPrefix sets the prefix of the selected item.

func WithStyles

func WithStyles(opts ...StylesOption) Option

WithStyles sets the various styles.

func WithUnselectedPrefix

func WithUnselectedPrefix(p string) Option

WithUnselectedPrefix sets the prefix of the unselected item.

type Style

type Style struct {
	ForegroundColor string
	BackgroundColor string
	Bold            bool
	Blink           bool
	Italic          bool
	Strikethrough   bool
	Underline       bool
	Faint           bool
}

Style represents a style.

type Styles

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

Styles is the styles for each component.

func NewStyles

func NewStyles(opts ...StylesOption) *Styles

NewStyles returns a new styles.

type StylesOption

type StylesOption func(o *stylesOption)

Option represents a option for the styles.

func WithStyleCursor

func WithStyleCursor(s Style) StylesOption

WithStyleCursor sets the style of cursor.

func WithStyleCursorLine

func WithStyleCursorLine(s Style) StylesOption

WithStyleCursorLine sets the style of cursor line.

func WithStyleMatches

func WithStyleMatches(s Style) StylesOption

WithStyleMatches sets the style of the matched characters.

func WithStyleSelectedPrefix

func WithStyleSelectedPrefix(s Style) StylesOption

WithStyleSelectedPrefix sets the style of prefix of the selected item.

func WithStyleUnselectedPrefix

func WithStyleUnselectedPrefix(s Style) StylesOption

WithStyleUnselectedPrefix sets the style of prefix of the unselected item.