fuzzy

Documentation

Index

• type DismissMsg
• type FileWalkMsg
• type Model
  • func New(rootDir string, width, height int) Model
  • func (m Model) BoxSize(screenWidth, screenHeight int) (int, int)
  • func (m Model) Done() bool
  • func (m Model) Init() tea.Cmd
  • func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)
  • func (m Model) View(th theme.Theme, screenWidth, screenHeight int) string
• type ResultMsg

Types

type DismissMsg

type DismissMsg struct{}

DismissMsg is sent when the user cancels the fuzzy finder.

type FileWalkMsg

type FileWalkMsg struct {
	Paths []string
	Done  bool
}

FileWalkMsg delivers a batch of discovered paths.

type Model

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

Model is the fuzzy finder overlay.

func New

func New(rootDir string, width, height int) Model

New creates a new fuzzy finder searching from rootDir.

func (Model) BoxSize

func (m Model) BoxSize(screenWidth, screenHeight int) (int, int)

BoxSize returns the desired box dimensions for the overlay.

func (Model) Done

func (m Model) Done() bool

Done returns true when the finder should be closed (never — closed via messages).

func (Model) Init

func (m Model) Init() tea.Cmd

Init starts the background file walker.

func (Model) Update

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

Update handles messages.

func (Model) View

func (m Model) View(th theme.Theme, screenWidth, screenHeight int) string

View renders the fuzzy finder as a bordered floating box content.

type ResultMsg

type ResultMsg struct {
	Path string // full path of the selected file/directory
}

ResultMsg is sent when the user selects a result.