Skip to content

Feature: add option for user keybindings #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 3, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,20 @@ let g:lua_tree_show_icons = {
"1 by default, notice that if 'files' is 1, it will only display
"if web-devicons is installed and on your runtimepath

" You can edit keybindings be defining this variable
" You don't have to define all keys.
" NOTE: the 'edit' key will wrap/unwrap a folder and open a file
let g:lua_tree_bindings = {
\ 'edit': '<CR>',
\ 'edit_vsplit': '<C-v>',
\ 'edit_split': '<C-x>',
\ 'edit_tab': '<C-t>',
\ 'cd': '.',
\ 'create': 'a',
\ 'remove': 'd',
\ 'rename': 'r'
\ }

nnoremap <C-n> :LuaTreeToggle<CR>
nnoremap <leader>r :LuaTreeRefresh<CR>
nnoremap <leader>n :LuaTreeFindFile<CR>
Expand Down
16 changes: 16 additions & 0 deletions doc/nvim-tree-lua.txt
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,22 @@ INFORMATIONS *nvim-tree-info*
- Double left click acts like '<CR>'
- Double right click acts like '.'

|g:lua_tree_bindings| *g:lua_tree_bindings*

you can change default keybindings by defining this variable.
default keybindings will be applied to undefined keys.
>
let g:lua_tree_bindings = {
\ edit: '<cr>',
\ edit_vsplit: '<c-v>',
\ edit_split: '<c-x>',
\ edit_tab: '<c-t>',
\ cd: '.',
\ create: 'a',
\ remove: 'd',
\ rename: 'r'
\ }

|Features| *nvim-tree-features*

File icons with vim-devicons.
Expand Down
1 change: 1 addition & 0 deletions doc/tags
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:LuaTreeToggle nvim-tree-lua.txt /*:LuaTreeToggle*
g:lua_tree_auto_close nvim-tree-lua.txt /*g:lua_tree_auto_close*
g:lua_tree_auto_open nvim-tree-lua.txt /*g:lua_tree_auto_open*
g:lua_tree_bindings nvim-tree-lua.txt /*g:lua_tree_bindings*
g:lua_tree_follow nvim-tree-lua.txt /*g:lua_tree_follow*
g:lua_tree_ignore nvim-tree-lua.txt /*g:lua_tree_ignore*
g:lua_tree_show_icons nvim-tree-lua.txt /*g:lua_tree_show_icons*
Expand Down
16 changes: 15 additions & 1 deletion lua/lib/config.lua
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,24 @@ local colors = {
dark_red = get('terminal_color_9', 'DarkRed'),
}

local keybindings = get('lua_tree_bindings', {});

local bindings = {
edit = keybindings.edit or '<CR>',
edit_vsplit = keybindings.edit_vsplit or '<C-v>',
edit_split = keybindings.edit_split or '<C-x>',
edit_tab = keybindings.edit_tab or '<C-t>',
cd = keybindings.cd or '.',
create = keybindings.create or 'a',
remove = keybindings.remove or 'd',
rename = keybindings.remove or 'r',
}

return {
SHOW_FOLDER_ICON = SHOW_FOLDER_ICON,
SHOW_FILE_ICON = SHOW_FILE_ICON,
SHOW_GIT_ICON = SHOW_GIT_ICON,
colors = colors
colors = colors,
bindings = bindings
}

18 changes: 10 additions & 8 deletions lua/lib/winutils.lua
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ local highlight = libformat.highlight_buffer
local stateutils = require 'lib/state'
local get_tree = stateutils.get_tree

local bindings = require 'lib/config'.bindings

local function get_buf()
local regex = '.*'..BUF_NAME..'$';

Expand Down Expand Up @@ -132,16 +134,16 @@ local function set_mappings()
if not buf then return end

local mappings = {
['<CR>'] = 'open_file("edit")';
['<2-LeftMouse>'] = 'open_file("edit")';
['<2-RightMouse>'] = 'open_file("chdir")';
['<C-v>'] = 'open_file("vsplit")';
['<C-x>'] = 'open_file("split")';
['<C-t>'] = 'open_file("tabnew")';
['.'] = 'open_file("chdir")';
a = 'edit_file("create")';
d = 'edit_file("remove")';
r = 'edit_file("rename")';
[bindings.edit] = 'open_file("edit")';
[bindings.edit_vsplit] = 'open_file("vsplit")';
[bindings.edit_split] = 'open_file("split")';
[bindings.edit_tab] = 'open_file("tabnew")';
[bindings.cd] = 'open_file("chdir")';
[bindings.create] = 'edit_file("create")';
[bindings.remove] = 'edit_file("remove")';
[bindings.rename] = 'edit_file("rename")';
}

for k,v in pairs(mappings) do
Expand Down