Skip to main content

Pick, Confirm, Cmp, Help Layers

Four smaller layers that handle dialogs and overlays.


Pick ([pick])

The [pick] layer handles the selection picker — a list-based component used by plugins and filter prompts to let the user choose an option.

ActionArguments/OptionsDescription
close--submit, (none)--submit: confirm selection; plain close: cancel
arrow--up, --down, +nMove highlight by n items
helpOpen help for this layer
pluginargsRun a plugin in the pick context
noopNo operation
[pick]
prepend_keymap = [
{ on = "<Enter>", run = "close --submit", desc = "Confirm selection" },
{ on = "<Esc>", run = "close", desc = "Cancel" },
]
append_keymap = [
{ on = "j", run = "arrow --down", desc = "Move down" },
{ on = "k", run = "arrow --up", desc = "Move up" },
]

Confirm ([confirm])

The [confirm] layer shows a yes/no confirmation dialog, typically for destructive operations (permanent delete, etc.).

ActionArguments/OptionsDescription
close--submit, (none)--submit: confirm action; plain close: cancel
arrow--left, --rightSwitch between yes/no buttons
helpOpen help for this layer
[confirm]
prepend_keymap = [
{ on = "<Enter>", run = "close --submit", desc = "Confirm" },
{ on = "y", run = "close --submit", desc = "Yes" },
{ on = "n", run = "close", desc = "No" },
{ on = "<Esc>", run = "close", desc = "Cancel" },
]
append_keymap = [
{ on = "<Tab>", run = "arrow --right", desc = "Next button" },
{ on = "<S-Tab>", run = "arrow --left", desc = "Previous button" },
]

Cmp ([cmp])

The [cmp] layer controls the completion menu that appears during tab-completion in input fields.

ActionArguments/OptionsDescription
close--submit, (none)--submit: accept completion; plain close: dismiss
arrow--up, --downNavigate completion suggestions
helpOpen help for this layer
pluginargsRun a plugin in the cmp context
noopNo operation
[cmp]
prepend_keymap = [
{ on = "<Enter>", run = "close --submit", desc = "Accept completion" },
{ on = "<Esc>", run = "close", desc = "Dismiss" },
{ on = "<Tab>", run = "close --submit", desc = "Accept and next" },
]
append_keymap = [
{ on = "<C-n>", run = "arrow --down", desc = "Next suggestion" },
{ on = "<C-p>", run = "arrow --up", desc = "Previous suggestion" },
]

Help ([help])

The [help] layer shows the built-in help menu that displays all registered keybindings grouped by layer.

ActionArguments/OptionsDescription
closeClose the help menu
escapeClose the help menu (alias)
arrow--up, --downScroll through help content
filterFilter help entries by text
pluginargsRun a plugin in the help context
noopNo operation
[help]
prepend_keymap = [
{ on = "q", run = "close", desc = "Close help" },
{ on = "<Esc>", run = "escape", desc = "Close help" },
{ on = "f", run = "filter", desc = "Filter help entries" },
]
append_keymap = [
{ on = "j", run = "arrow --down", desc = "Scroll down" },
{ on = "k", run = "arrow --up", desc = "Scroll up" },
]
tip

The help menu is your best reference while using Yazi — press F1 or ~ to open it and see all active keybindings for the current layer.