Skip to content

Commit f8ec80e

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

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 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

@@ -1457,6 +1442,21 @@ require('fzf-lua').setup({'fzf-vim'})
14571442
> (i.e. `:Files`, `:Rg`), if you wish to use a different profile you can create the same
14581443
> user commands by running `:FzfLua setup_fzfvim_cmds`.
14591444
1445+
> [!TIP]
1446+
> The default profile is a combination of border-fused+hide profiles
1447+
> without the "hide" profile pressing esc terminates the fzf process
1448+
> which makes for an imperfect resume limited to resuming only the
1449+
> picker/query (without cursor position, selection, etc), to restore
1450+
> the default esc behavior combine any existing profile with "hide"
1451+
> by using a table in `opts[1]`:
1452+
> ```lua
1453+
> require("fzf-lua").setup({
1454+
> { "fzf-native", "hide" },
1455+
> -- your other settings here
1456+
> })
1457+
> ```
1458+
1459+
14601460
<details>
14611461
<summary>CLICK TO SEE THE AVAILABLE PROFILES</summary>
14621462

0 commit comments

Comments
 (0)