Skip to content

Commit 46652cb

Browse files
alex-courtisalex-courtis
committed
docs(#3088): extract api/node.lua functions, doc WIP
1 parent cbc97fe commit 46652cb

File tree

2 files changed

+131
-424
lines changed

2 files changed

+131
-424
lines changed

‎doc/nvim-tree-lua.txt‎

Lines changed: 78 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2676,11 +2676,16 @@ collapse({node}, {opts}) *nvim_tree.api.node.collapse()*
26762676
nodes with open buffers.
26772677

26782678
expand({node}, {opts}) *nvim_tree.api.node.expand()*
2679+
Recursively expand all nodes under a directory or a file's parent
2680+
directory.
26792681

26802682
Parameters: ~
26812683
• {node} (`nvim_tree.api.Node?`) directory or file
26822684
• {opts} (`table?`) optional
2683-
• {foo}? (`boolean`) (default: false)
2685+
• {expand_until}?
2686+
(`fun(expansion_count: integer, node: Node): boolean`)
2687+
Return `true` if `node` should be expanded.
2688+
`expansion_count` is the total number of folders expanded.
26842689

26852690
*nvim_tree.api.node.navigate.diagnostics.next()*
26862691
navigate.diagnostics.next({node})
@@ -2788,107 +2793,162 @@ navigate.sibling.prev({node})
27882793
• {node} (`nvim_tree.api.Node?`) directory or file
27892794

27902795
open.drop({node}) *nvim_tree.api.node.open.drop()*
2796+
Switch to window with selected file if it exists, open file otherwise.
2797+
• file: open file using |:drop|
2798+
• directory: expand or collapse
2799+
• root: change directory up
27912800

27922801
Parameters: ~
27932802
• {node} (`nvim_tree.api.Node?`) directory or file
27942803

27952804
open.edit({node}, {opts}) *nvim_tree.api.node.open.edit()*
2805+
• file: open as per |nvim_tree.Config.Actions.OpenFile|
2806+
• directory: expand or collapse
2807+
• root: change directory up
27962808

27972809
Parameters: ~
27982810
• {node} (`nvim_tree.api.Node?`) directory or file
27992811
• {opts} (`table?`) optional
2800-
• {foo}? (`boolean`) (default: false)
2812+
• {quit_on_open}? (`boolean`, default: false) Quits the tree
2813+
when opening the file.
2814+
• {focus}? (`boolean`, default: false) Keep focus in the tree
2815+
when opening the file.
28012816

28022817
open.horizontal({node}, {opts}) *nvim_tree.api.node.open.horizontal()*
2818+
Open file in a new horizontal split.
28032819

28042820
Parameters: ~
2805-
• {node} (`nvim_tree.api.Node?`) directory or file
2821+
• {node} (`nvim_tree.api.Node?`) file
28062822
• {opts} (`table?`) optional
2807-
• {foo}? (`boolean`) (default: false)
2823+
• {quit_on_open}? (`boolean`, default: false) Quits the tree
2824+
when opening the file.
2825+
• {focus}? (`boolean`, default: false) Keep focus in the tree
2826+
when opening the file.
28082827

28092828
*nvim_tree.api.node.open.horizontal_no_picker()*
28102829
open.horizontal_no_picker({node}, {opts})
2830+
Open file in a new horizontal split without using the window picker.
28112831

28122832
Parameters: ~
2813-
• {node} (`nvim_tree.api.Node?`) directory or file
2833+
• {node} (`nvim_tree.api.Node?`) file
28142834
• {opts} (`table?`) optional
2815-
• {foo}? (`boolean`) (default: false)
2835+
• {quit_on_open}? (`boolean`, default: false) Quits the tree
2836+
when opening the file.
2837+
• {focus}? (`boolean`, default: false) Keep focus in the tree
2838+
when opening the file.
28162839

28172840
*nvim_tree.api.node.open.no_window_picker()*
28182841
open.no_window_picker({node}, {opts})
2842+
Open file without using the window picker.
28192843

28202844
Parameters: ~
2821-
• {node} (`nvim_tree.api.Node?`) directory or file
2845+
• {node} (`nvim_tree.api.Node?`) file
28222846
• {opts} (`table?`) optional
2823-
• {foo}? (`boolean`) (default: false)
2847+
• {quit_on_open}? (`boolean`, default: false) Quits the tree
2848+
when opening the file.
2849+
• {focus}? (`boolean`, default: false) Keep focus in the tree
2850+
when opening the file.
28242851

28252852
open.preview({node}, {opts}) *nvim_tree.api.node.open.preview()*
2853+
Open file with |'bufhidden'| set to `delete`.
28262854

28272855
Parameters: ~
28282856
• {node} (`nvim_tree.api.Node?`) directory or file
28292857
• {opts} (`table?`) optional
2830-
• {foo}? (`boolean`) (default: false)
2858+
• {quit_on_open}? (`boolean`, default: false) Quits the tree
2859+
when opening the file.
2860+
• {focus}? (`boolean`, default: false) Keep focus in the tree
2861+
when opening the file.
28312862

28322863
*nvim_tree.api.node.open.preview_no_picker()*
28332864
open.preview_no_picker({node}, {opts})
2865+
Open file with |'bufhidden'| set to `delete` without using the window
2866+
picker.
28342867

28352868
Parameters: ~
28362869
• {node} (`nvim_tree.api.Node?`) directory or file
28372870
• {opts} (`table?`) optional
2838-
• {foo}? (`boolean`) (default: false)
2871+
• {quit_on_open}? (`boolean`, default: false) Quits the tree
2872+
when opening the file.
2873+
• {focus}? (`boolean`, default: false) Keep focus in the tree
2874+
when opening the file.
28392875

28402876
*nvim_tree.api.node.open.replace_tree_buffer()*
28412877
open.replace_tree_buffer({node})
2878+
Open file in place: in the nvim-tree window.
28422879

28432880
Parameters: ~
2844-
• {node} (`nvim_tree.api.Node?`) directory or file
2881+
• {node} (`nvim_tree.api.Node?`) file
28452882

28462883
open.tab({node}, {opts}) *nvim_tree.api.node.open.tab()*
2884+
Open file in a new tab.
28472885

28482886
Parameters: ~
28492887
• {node} (`nvim_tree.api.Node?`) directory or file
28502888
• {opts} (`table?`) optional
2851-
• {foo}? (`boolean`) (default: false)
2889+
• {quit_on_open}? (`boolean`, default: false) Quits the tree
2890+
when opening the file.
2891+
• {focus}? (`boolean`, default: false) Keep focus in the tree
2892+
when opening the file.
28522893

28532894
open.tab_drop({node}) *nvim_tree.api.node.open.tab_drop()*
2895+
Switch to tab containing window with selected file if it exists. Open file
2896+
in new tab otherwise.
28542897

28552898
Parameters: ~
28562899
• {node} (`nvim_tree.api.Node?`) directory or file
28572900

28582901
*nvim_tree.api.node.open.toggle_group_empty()*
28592902
open.toggle_group_empty({node}, {opts})
2903+
Toggle |nvim_tree.Config.Renderer| {group_empty} for a directory. Needs
2904+
{group_empty} set.
28602905

28612906
Parameters: ~
2862-
• {node} (`nvim_tree.api.Node?`) directory or file
2907+
• {node} (`nvim_tree.api.Node?`) directory
28632908
• {opts} (`table?`) optional
2864-
• {foo}? (`boolean`) (default: false)
2909+
• {quit_on_open}? (`boolean`, default: false) Quits the tree
2910+
when opening the file.
2911+
• {focus}? (`boolean`, default: false) Keep focus in the tree
2912+
when opening the file.
28652913

28662914
open.vertical({node}, {opts}) *nvim_tree.api.node.open.vertical()*
2915+
Open file in a new vertical split.
28672916

28682917
Parameters: ~
2869-
• {node} (`nvim_tree.api.Node?`) directory or file
2918+
• {node} (`nvim_tree.api.Node?`) file
28702919
• {opts} (`table?`) optional
2871-
• {foo}? (`boolean`) (default: false)
2920+
• {quit_on_open}? (`boolean`, default: false) Quits the tree
2921+
when opening the file.
2922+
• {focus}? (`boolean`, default: false) Keep focus in the tree
2923+
when opening the file.
28722924

28732925
*nvim_tree.api.node.open.vertical_no_picker()*
28742926
open.vertical_no_picker({node}, {opts})
2927+
Open file in a new vertical split without using the window picker.
28752928

28762929
Parameters: ~
2877-
• {node} (`nvim_tree.api.Node?`) directory or file
2930+
• {node} (`nvim_tree.api.Node?`) file
28782931
• {opts} (`table?`) optional
2879-
• {foo}? (`boolean`) (default: false)
2932+
• {quit_on_open}? (`boolean`, default: false) Quits the tree
2933+
when opening the file.
2934+
• {focus}? (`boolean`, default: false) Keep focus in the tree
2935+
when opening the file.
28802936

28812937
run.cmd({node}) *nvim_tree.api.node.run.cmd()*
2938+
Enter |cmdline| with the full path of the node and the cursor at the start
2939+
of the line.
28822940

28832941
Parameters: ~
28842942
• {node} (`nvim_tree.api.Node?`) directory or file
28852943

28862944
run.system({node}) *nvim_tree.api.node.run.system()*
2945+
Execute |nvim_tree.Config.SystemOpen|.
28872946

28882947
Parameters: ~
28892948
• {node} (`nvim_tree.api.Node?`) directory or file
28902949

28912950
show_info_popup({node}) *nvim_tree.api.node.show_info_popup()*
2951+
Open a popup window showing: fullpath, size, accessed, modified, created.
28922952

28932953
Parameters: ~
28942954
• {node} (`nvim_tree.api.Node?`) directory or file

0 commit comments

Comments
 (0)