plugins.arrow.settings
Options provided to the require('arrow').setup function.
Type: attribute set of anything
Default:
{ }
Example:
{
always_show_path = false;
custom_actions = {
open = "function(target_file_name, current_file_name) end";
split_horizontal = "function(target_file_name, current_file_name) end";
split_vertical = "function(target_file_name, current_file_name) end";
};
full_path_list = [
"update_stuff"
];
global_bookmarks = false;
hide_handbook = false;
index_keys = "123456789zxcbnmZXVBNM,afghjklAFGHJKLwrtyuiopWRTYUIOP";
leader_key = ";";
mappings = {
clear_all_items = "C";
delete_mode = "d";
edit = "e";
next_item = "]";
open_horizontal = "-";
open_vertical = "v";
prev_item = "[";
quit = "q";
remove = "x";
toggle = "s";
};
per_buffer_config = {
lines = 4;
satellite = {
enable = false;
overlap = true;
priority = 1000;
};
sort_automatically = true;
zindex = 10;
};
save_key = "cwd";
save_path = ''
function()
return vim.fn.stdpath("cache") .. "/arrow"
end
'';
separate_by_branch = false;
separate_save_and_remove = false;
show_icons = true;
window = {
border = "double";
col = "auto";
height = "auto";
row = "auto";
width = "auto";
};
}
Declared by:
plugins.arrow.settings.always_show_path
If true will show path.
Type: null or boolean or raw lua code
Default:
null
Plugin default: false
Declared by:
plugins.arrow.settings.full_path_list
Filenames on this list will ALWAYS show the file path too
Type: null or (list of (string or raw lua code))
Default:
null
Plugin default:
[
"update_stuff"
]
Declared by:
plugins.arrow.settings.global_bookmarks
If true arrow will save files globally (ignores separate_by_branch).
Type: null or boolean or raw lua code
Default:
null
Plugin default: false
Declared by:
plugins.arrow.settings.hide_handbook
If true to hide the shortcuts on menu.
Type: null or boolean or raw lua code
Default:
null
Plugin default: false
Declared by:
plugins.arrow.settings.index_keys
Keys mapped to bookmark index.
Type: null or string or raw lua code
Default:
null
Plugin default: "123456789zxcbnmZXVBNM,afghjklAFGHJKLwrtyuiopWRTYUIOP"
Declared by:
plugins.arrow.settings.leader_key
The leader key to use for arrow. Will precede all mappings. Recommended to be a single character.
Type: null or string or raw lua code
Default:
null
Plugin default: ";"
Declared by:
plugins.arrow.settings.save_key
What will be used as root to save the bookmarks. Can be also git_root.
Type: null or string or raw lua code
Default:
null
Plugin default: "cwd"
Declared by:
plugins.arrow.settings.save_path
Function used to determine where to save arrow data.
Type: null or lua function string
Default:
null
Plugin default:
''
function()
return vim.fn.stdpath("cache") .. "/arrow"
end
''
Declared by:
plugins.arrow.settings.separate_by_branch
If true will split bookmarks by git branch.
Type: null or boolean or raw lua code
Default:
null
Plugin default: false
Declared by:
plugins.arrow.settings.separate_save_and_remove
If true will remove the toggle and create the save/remove keymaps.
Type: null or boolean or raw lua code
Default:
null
Plugin default: false
Declared by:
plugins.arrow.settings.show_icons
If true will show icons.
Type: null or boolean or raw lua code
Default:
null
Plugin default: false
Declared by:
plugins.arrow.settings.window
Controls the appearance and position of an arrow window.
See :h nvim_open_win() for all options.
Type: null or (attribute set of (anything or raw lua code))
Default:
null
Plugin default:
{
border = "single";
col = "auto";
height = "auto";
relative = "editor";
row = "auto";
style = "minimal";
width = "auto";
}
Declared by: