Skip to content

Commit a774fa1

Browse files
authored
feat(api): add tree.is_visible, tree.is_tree_buf (#2150)
* feat(api): add api.tree.is_visible * feat(api): add api.tree.is_tree_buf
1 parent 5b53732 commit a774fa1

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

doc/nvim-tree-lua.txt

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1408,6 +1408,28 @@ tree.toggle_hidden_filter()
14081408
tree.toggle_help() *nvim-tree-api.tree.toggle_help()*
14091409
Toggle help view.
14101410

1411+
tree.is_tree_buf({bufnr}) *nvim-tree-api.tree.is_tree_buf()*
1412+
Checks if a buffer is an nvim-tree.
1413+
1414+
Parameters: ~
1415+
{bufnr} (number|nil) buffer handle, 0 or nil for current buffer
1416+
1417+
Return: ~
1418+
(boolean) buffer is an nvim-tree buffer
1419+
1420+
tree.is_visible({opts}) *nvim-tree-api.tree.is_visible()*
1421+
Checks if nvim-tree is visible on the current, specified or any tab.
1422+
1423+
Parameters: ~
1424+
{opts} (table) optional parameters
1425+
1426+
Options: ~
1427+
{tabpage} (number) as per |nvim_get_current_tabpage()|
1428+
• {any_tabpage} (boolean) visible on any tab, default false
1429+
1430+
Return: ~
1431+
(boolean) nvim-tree is visible
1432+
14111433
==============================================================================
14121434
5.2 API FILE SYSTEM *nvim-tree-api.fs*
14131435

lua/nvim-tree/api.lua

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,14 @@ Api.tree.toggle_hidden_filter = wrap(require("nvim-tree.actions.tree-modifiers.t
107107

108108
Api.tree.toggle_help = wrap(require("nvim-tree.help").toggle)
109109

110+
Api.tree.is_tree_buf = wrap(require("nvim-tree.utils").is_nvim_tree_buf)
111+
112+
---@class ApiTreeIsVisibleOpts
113+
---@field tabpage number|nil
114+
---@field any_tabpage boolean|nil default false
115+
116+
Api.tree.is_visible = wrap(require("nvim-tree.view").is_visible)
117+
110118
Api.fs.create = wrap_node(require("nvim-tree.actions.fs.create-file").fn)
111119
Api.fs.remove = wrap_node(require("nvim-tree.actions.fs.remove-file").fn)
112120
Api.fs.trash = wrap_node(require("nvim-tree.actions.fs.trash").fn)

0 commit comments

Comments
 (0)