Skip to content

Commit fd61609

Browse files
committed
docs(README): added default profile/hide tip
1 parent 2836832 commit fd61609

1 file changed

Lines changed: 14 additions & 15 deletions

File tree

README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -148,21 +148,6 @@ Alternatively, resuming work on a specific picker:
148148
:FzfLua files resume=true
149149
```
150150

151-
> [!TIP]
152-
> By default pressing esc or ctrl-c terminates the fzf process,
153-
> as such resume is not perfect and is limited to resuming the
154-
> picker/query and sometimes additional parameters such as regex
155-
> in grep, etc, for a more complete resume use the "hide" profile,
156-
> this will modify the esc bind to hide fzf-lua and keep the fzf
157-
> process running in the background allowing `:FzfLua resume` to
158-
> restore the picker state entirely, including cursor position
159-
> and selection. To configure hiding by default:
160-
> ```lua
161-
> require("fzf-lua").setup({
162-
> "hide",
163-
> -- your other settings here
164-
> })
165-
> ```
166151

167152
### Combining Pickers
168153

@@ -1445,6 +1430,20 @@ the first argument:
14451430
:lua require"fzf-lua".setup({{"telescope","fzf-native"},winopts={fullscreen=true}})
14461431
```
14471432

1433+
> [!TIP]
1434+
> The default profile is a combination of border-fused+hide profiles,
1435+
> without the "hide" profile pressing esc terminates the fzf process
1436+
> which makes for an imperfect resume limited to resuming only the
1437+
> picker/query (without cursor position, selection, etc), to restore
1438+
> the default esc behavior combine any existing profile with "hide"
1439+
> by using a table in `opts[1]`:
1440+
> ```lua
1441+
> require("fzf-lua").setup({
1442+
> { "fzf-native", "hide" },
1443+
> -- your other settings here
1444+
> })
1445+
> ```
1446+
14481447
#### Coming from fzf.vim?
14491448
14501449
Easy! just use the `fzf-vim` profile:

0 commit comments

Comments
 (0)