plugins.yazi.settings

Options provided to the require('yazi').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  enable_mouse_support = true;
  floating_window_scaling_factor = 0.5;
  log_level = "debug";
  open_for_directories = true;
  yazi_floating_window_border = "single";
  yazi_floating_window_winblend = 50;
}

Declared by:

plugins.yazi.settings.enable_mouse_support

Enables mouse support.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.yazi.settings.clipboard_register

Some yazi.nvim commands copy text to the clipboard. This is the register yazi.nvim should use for copying. Defaults to “*”, the system clipboard.

Type: null or string or raw lua code

Default: null

Plugin default: "*"

Declared by:

plugins.yazi.settings.floating_window_scaling_factor

The floating window scaling factor. 1 means 100%, 0.9 means 90%, etc.

Type: null or signed integer or floating point number or raw lua code

Default: null

Plugin default: 0.9

Declared by:

plugins.yazi.settings.highlight_groups

Add highlight groups to different yazi events.

NOTE: this only works if use_ya_for_events_reading is enabled, etc.

Type: null or (attribute set)

Default: null

Plugin default:

{
  hovered_buffer = null;
}

Declared by:

plugins.yazi.settings.keymaps

Customize the keymaps that are active when yazi is open and focused.

Also:

  • use e.g. open_file_in_tab = false to disable a keymap
  • you can customize only some of the keymaps if you want
  • Set to false to disable all default keymaps.

Type: null or (attribute set) or value false (singular enum)

Default: null

Plugin default:

{
  copy_relative_path_to_selected_files = "<c-y>";
  cycle_open_buffers = "<tab>";
  grep_in_directory = "<c-s>";
  open_file_in_horizontal_split = "<c-x>";
  open_file_in_tab = "<c-t>";
  open_file_in_vertical_split = "<c-v>";
  replace_in_directory = "<c-g>";
  send_to_quickfix_list = "<c-q>";
  show_help = "<f1>";
}

Declared by:

plugins.yazi.settings.log_level

The log level to use. Off by default, but can be used to diagnose issues. You can find the location of the log file by running :checkhealth yazi in Neovim.

Type: null or unsigned integer, meaning >=0, or one of “off”, “error”, “warn”, “info”, “debug”, “trace”

Default: null

Plugin default: "off"

Declared by:

plugins.yazi.settings.open_file_function

What Neovim should do a when a file was opened (selected) in yazi.

Defaults to simply opening the file.

Type: null or lua function string

Default: null

Plugin default:

{
  __raw = ''
    function(chosen_file)
      vim.cmd(string.format("edit %s", vim.fn.fnameescape(chosen_file)))
    end
  '';
}

Declared by:

plugins.yazi.settings.open_for_directories

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.yazi.settings.set_keymappings_function

Completely override the keymappings for yazi. This function will be called in the context of the yazi terminal buffer.

Type: null or lua function string

Default: null

Plugin default: null

Declared by:

plugins.yazi.settings.use_ya_for_events_reading

Use the ya command to read events.

Allows more complex behaviors using the ya messaging system.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.yazi.settings.use_yazi_client_id_flag

Allows passing which instance of yazi is being controlled.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.yazi.settings.yazi_floating_window_border

The type of border to use for the floating window.

Supports all available border types from vim.api.keyset.win_config.border.

Defines the border to use for yazi. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Plugin default: "rounded"

Declared by:

plugins.yazi.settings.yazi_floating_window_winblend

0 for fully opaque and 100 for fully transparent. See :h winblend

Type: null or integer between 0 and 100 (both inclusive) or raw lua code

Default: null

Plugin default: 0

Declared by: