Skip to content

Commit be90141

Browse files
committed
update docs
1 parent 6da1c0e commit be90141

File tree

4 files changed

+51
-16
lines changed

4 files changed

+51
-16
lines changed

README.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -39,26 +39,16 @@ import (
3939
"github.com/koki-develop/go-fzf"
4040
)
4141

42-
type Items []string
43-
44-
func (items Items) ItemString(i int) string {
45-
return items[i]
46-
}
47-
48-
func (items Items) Len() int {
49-
return len(items)
50-
}
51-
5242
func main() {
53-
items := Items{"hello", "world", "foo", "bar"}
43+
items := []string{"hello", "world", "foo", "bar"}
5444

5545
fzf := fzf.New(
5646
fzf.WithStyles(
5747
fzf.WithStyleCursor(fzf.Style{ForegroundColor: "#ff0000"}),
5848
fzf.WithStyleMatches(fzf.Style{ForegroundColor: "#00ff00"}),
5949
),
6050
)
61-
idxs, err := fzf.Find(items)
51+
idxs, err := fzf.Find(items, func(i int) string { return items[i] })
6252
if err != nil {
6353
log.Fatal(err)
6454
}

docs/cli/README.md

Lines changed: 49 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,53 @@ Usage:
3131
gofzf [flags]
3232

3333
Flags:
34-
-h, --help help for gofzf
35-
-l, --limit int maximum number of items to select (default 1)
36-
--no-limit unlimited number of items to select
37-
-v, --version version for gofzf
34+
--limit int maximum number of items to select (default 1)
35+
--no-limit unlimited number of items to select
36+
--prompt string (default "> ")
37+
--cursor string (default "> ")
38+
--selected-prefix string (default "● ")
39+
--unselected-prefix string (default "◯ ")
40+
--input-placeholder string (default "Filter...")
41+
--cursor-fg string (default "#00ADD8")
42+
--cursor-bg string
43+
--cursor-bold
44+
--cursor-blink
45+
--cursor-italic
46+
--cursor-strike
47+
--cursor-underline
48+
--cursor-faint
49+
--cursorline-fg string
50+
--cursorline-bg string
51+
--cursorline-bold (default true)
52+
--cursorline-blink
53+
--cursorline-italic
54+
--cursorline-strke
55+
--cursorline-underline
56+
--cursorline-faint
57+
--selected-prefix-fg string (default "#00ADD8")
58+
--selected-prefix-bg string
59+
--selected-prefix-bold
60+
--selected-prefix-blink
61+
--selected-prefix-italic
62+
--selected-prefix-strke
63+
--selected-prefix-underline
64+
--selected-prefix-faint
65+
--unselected-prefix-fg string
66+
--unselected-prefix-bg string
67+
--unselected-prefix-bold
68+
--unselected-prefix-blink
69+
--unselected-prefix-italic
70+
--unselected-prefix-strke
71+
--unselected-prefix-underline
72+
--unselected-prefix-faint (default true)
73+
--matches-fg string (default "#00ADD8")
74+
--matches-bg string
75+
--matches-bold
76+
--matches-blink
77+
--matches-italic
78+
--matches-strke
79+
--matches-underline
80+
--matches-faint
81+
-h, --help help for gofzf
82+
-v, --version version for gofzf
3883
```

docs/cli/demo.gif

-768 Bytes
Loading

docs/library/demo.gif

240 Bytes
Loading

0 commit comments

Comments
 (0)