Skip to content

Commit d1410cb

Browse files
authored
docs: :help for api.node (#2106)
1 parent 94e3b09 commit d1410cb

File tree

1 file changed

+70
-25
lines changed

1 file changed

+70
-25
lines changed

doc/nvim-tree-lua.txt

Lines changed: 70 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1446,46 +1446,91 @@ api.tree.toggle_help() *nvim-tree.api.tree.toggle_help()*
14461446
- copy.filename
14471447
- copy.relative_path
14481448

1449-
- api.node: *nvim-tree.api.node*
1450-
- open.edit
1451-
- open.replace_tree_buffer
1452-
- open.no_window_picker
1453-
- open.vertical
1454-
- open.horizontal
1455-
- open.tab
1456-
- open.preview
1457-
- show_info_popup
1458-
- run.cmd
1459-
- run.system
1460-
- navigate.sibling.next
1461-
- navigate.sibling.prev
1462-
- navigate.sibling.first
1463-
- navigate.sibling.last
1464-
- navigate.parent
1465-
- navigate.parent_close
1466-
1467-
api.node.navigate.git.next() *nvim-tree.api.navigate.git.next()*
1449+
api.node.open.edit() *nvim-tree.api.node.open.edit()*
1450+
File: open as per |nvim-tree.actions.open_file|
1451+
Folder: expand or collapse
1452+
Root: change directory up
1453+
1454+
*nvim-tree.api.node.open.replace_tree_buffer()*
1455+
api.node.open.replace_tree_buffer()
1456+
|nvim-tree.api.node.edit()|, file will be opened in place: in the
1457+
nvim-tree window.
1458+
1459+
*nvim-tree.api.node.open.no_window_picker()*
1460+
api.node.open.no_window_picker()
1461+
|nvim-tree.api.node.edit()|, window picker will never be used as per
1462+
|nvim-tree.actions.open_file.window_picker.enable| `false`
1463+
1464+
api.node.open.vertical() *nvim-tree.api.node.open.vertical()*
1465+
|nvim-tree.api.node.edit()|, file will be opened in a new vertical split.
1466+
1467+
api.node.open.horizontal() *nvim-tree.api.node.open.horizontal()*
1468+
|nvim-tree.api.node.edit()|, file will be opened in a new horizontal split.
1469+
1470+
api.node.open.tab() *nvim-tree.api.node.open.tab()*
1471+
|nvim-tree.api.node.edit()|, file will be opened in a new tab.
1472+
1473+
api.node.open.preview() *nvim-tree.api.node.open.preview()*
1474+
|nvim-tree.api.node.edit()|, file buffer will have |bufhidden| set to `delete`.
1475+
1476+
api.node.node.navigate.git.next() *nvim-tree.api.node.navigate.git.next()*
14681477
Navigate to the next item showing git status.
14691478

1470-
api.node.navigate.git.prev() *nvim-tree.api.navigate.git.prev()*
1479+
api.node.navigate.git.prev() *nvim-tree.api.node.navigate.git.prev()*
14711480
Navigate to the previous item showing git status.
14721481

1473-
*nvim-tree.api.navigate.diagnostics.next()*
1474-
api.node.navigate.diagnostics.next()
1482+
*nvim-tree.api.node.navigate.diagnostics.next()*
1483+
api.node.navigate.diagnostics.next()
14751484
Navigate to the next item showing diagnostic status.
14761485

1477-
*nvim-tree.api.navigate.diagnostics.prev()*
1486+
*nvim-tree.api.node.navigate.diagnostics.prev()*
14781487
api.node.navigate.diagnostics.prev()
14791488
Navigate to the next item showing diagnostic status.
14801489

1481-
api.node.navigate.opened.next() *nvim-tree.api.navigate.opened.next()*
1490+
*nvim-tree.api.node.navigate.opened.next()*
1491+
api.node.navigate.opened.next()
14821492
Navigate to the next |bufloaded()| item.
14831493
See |nvim-tree.renderer.highlight_opened_files|
14841494

1485-
api.node.navigate.opened.prev() *nvim-tree.api.navigate.opened.prev()*
1495+
*nvim-tree.api.node.navigate.opened.prev()*
1496+
api.node.navigate.opened.prev()
14861497
Navigate to the previous |bufloaded()| item.
14871498
See |nvim-tree.renderer.highlight_opened_files|
14881499

1500+
*nvim-tree.api.node.navigate.sibling.next()*
1501+
api.node.navigate.sibling.next()
1502+
Navigate to the next node in the current node's folder, wraps.
1503+
1504+
*nvim-tree.api.node.navigate.sibling.prev()*
1505+
api.node.navigate.sibling.prev()
1506+
Navigate to the previous node in the current node's folder, wraps.
1507+
1508+
*nvim-tree.api.node.navigate.sibling.first()*
1509+
api.node.navigate.sibling.first()
1510+
Navigate to the first node in the current node's folder.
1511+
1512+
*nvim-tree.api.node.navigate.sibling.last()*
1513+
api.node.navigate.sibling.last()
1514+
Navigate to the last node in the current node's folder.
1515+
1516+
*nvim-tree.api.node.navigate.parent()*
1517+
api.node.navigate.parent()
1518+
Navigate to the parent folder of the current node.
1519+
1520+
*nvim-tree.api.node.navigate.parent_close()*
1521+
api.node.navigate.parent_close()
1522+
|api.node.navigate.parent()|, closing that folder.
1523+
1524+
api.node.show_info_popup() *nvim-tree.api.node.show_info_popup()*
1525+
Open a popup window showing: fullpath, size, accessed, modified, created.
1526+
1527+
api.node.run.cmd() *nvim-tree.api.node.run.cmd()*
1528+
Enter |cmdline| with the full path of the node and the cursor at the start
1529+
of the line.
1530+
1531+
api.node.run.system() *nvim-tree.api.node.run.system()*
1532+
Execute |nvim-tree.system_open|
1533+
14891534
- api.git: *nvim-tree.api.git*
14901535
- reload
14911536

0 commit comments

Comments
 (0)