@@ -1091,7 +1091,7 @@ The api is separated in multiple modules, which can be accessed with
10911091`require (" nvim-tree.api" ).moduleName.functionality` .
10921092
10931093Functions that needs a tree node parameter are exposed with an abstraction
1094- that injects the node from the cursor position in the tree when calling
1094+ that injects the node from the cursor position in the tree when calling
10951095the function. It will use the node you pass as an argument in priority if it
10961096exists.
10971097
@@ -1173,14 +1173,24 @@ exists.
11731173==============================================================================
11741174 6. MAPPINGS *nvim-tree-mappings*
11751175
1176- Setting your own mapping in the configuration will soon be deprecated, see | nvim-tree.on_attach | for experimental replacement.
1176+ Setting your own mapping in the configuration will soon be deprecated, see
1177+ | nvim-tree.on_attach | for experimental replacement.
11771178
1178- The `list ` option in `view .mappings.list ` is a table of
1179+ `view .mappings.list ` is a table of:
1180+ {key} (string| table of string) mandatory | {lhs} |.
11791181
1180- - `key ` (mandatory) string or a table of string
1181- - `action` (mandatory) is the name of the action, set to `" " ` to remove default action, set to an arbitrary description when using `action_cb`
1182- - `action_cb` (optional) is a custom function that will be called, it receives the node as a parameter.
1183- - `mode ` (optional) is `n ` by default
1182+ {action} (string) mandatory name of the action.
1183+ `" " ` to remove an action with {key} . The case of {key} must
1184+ exactly match the action you are removing e.g. `' <Tab>' ` to
1185+ remove the default preview action.
1186+ An arbitrary description when using `action_cb` .
1187+
1188+ {action_cb} (function) optional custom function that will be called.
1189+ Receives the node as a parameter.
1190+ Non-empty description for `action` is required.
1191+
1192+ {mode} (string) optional mode as per | nvim_set_keymap | .
1193+ Default `' n' ` .
11841194
11851195Examples:
11861196>
@@ -1194,7 +1204,7 @@ Examples:
11941204 mappings = {
11951205 list = {
11961206 -- remove a default mapping for cd
1197- { key = "<2-RightMouse>", action = "" }, -- will remove default cd action
1207+ { key = "<2-RightMouse>", action = "" },
11981208
11991209 -- add multiple normal mode mappings for edit
12001210 { key = { "<CR>", "o" }, action = "edit", mode = "n" },
@@ -1398,7 +1408,7 @@ nvim-tree will dispatch events whenever an action is made. These events can be
13981408subscribed to through handler functions. This allows for even further
13991409customization of nvim-tree.
14001410
1401- A handler for an event is just a function which receives one argument, the
1411+ A handler for an event is just a function which receives one argument, the
14021412payload of the event. The payload is different for each event type. Refer
14031413to | nvim_tree_registering_handlers | for more information.
14041414
@@ -1424,7 +1434,7 @@ You can access the event enum with:
14241434<
14251435Here is the list of available variant of this enum:
14261436
1427- - Event.Ready
1437+ - Event.Ready
14281438 When NvimTree has been initialized
14291439 • Note: Handler takes no parameter.
14301440
0 commit comments