Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrCancelled = errors.New("cancelled")
ErrCancelled is returned when the user cancelled fzf.
Functions ¶
This section is empty.
Types ¶
type Binding ¶
type Binding struct {
// Keyboard shortcut, e.g. `ctrl-n`.
Keys string
// fzf action, see `man fzf`.
Action string
// Description which will be displayed as a fzf header if not empty.
Description string
}
Binding represents a keyboard shortcut bound to an action in fzf.
type Fzf ¶
type Fzf struct {
// contains filtered or unexported fields
}
Fzf filters a set of fields using fzf.
After adding all the fields with Add, use Selection to get the filtered results.
func New ¶
New runs a fzf instance.
To show a preview of each line, provide a previewCmd which will be executed by fzf.
type NoteFilter ¶
type NoteFilter struct {
// contains filtered or unexported fields
}
NoteFilter uses fzf to filter interactively a set of notes.
func NewNoteFilter ¶
func NewNoteFilter(opts NoteFilterOpts, fs core.FileStorage, terminal *term.Terminal, templateLoader core.TemplateLoader) *NoteFilter
func (*NoteFilter) Apply ¶
func (f *NoteFilter) Apply(notes []core.ContextualNote) ([]core.ContextualNote, error)
Apply filters the given notes with fzf.
type NoteFilterOpts ¶
type NoteFilterOpts struct {
// Indicates whether the filtering is interactive. If not, fzf is bypassed.
Interactive bool
// Indicates whether fzf is opened for every query, even if empty.
AlwaysFilter bool
// Format for a single line, taken from the config `fzf-line` property.
LineTemplate opt.String
// Preview command to run when selecting a note.
PreviewCmd opt.String
// When non null, a "create new note from query" binding will be added to
// fzf to create a note in this directory.
NewNoteDir *core.Dir
// Absolute path to the notebook.
NotebookDir string
}
NoteFilterOpts holds the configuration for the fzf notes filtering.
The absolute path to the notebook (NotebookDir) and the working directory (WorkingDir) are used to make the path of each note relative to the working directory.
type Opts ¶
type Opts struct {
// Preview command executed by fzf when hovering a line.
PreviewCmd opt.String
// Amount of space between two non-empty fields.
Padding int
// Delimiter used by fzf between fields.
Delimiter string
// List of key bindings enabled in fzf.
Bindings []Binding
}
Opts holds the options used to run fzf.
Source Files