From a774fa186c19945d2a594de80922da2cbb4a0139 Mon Sep 17 00:00:00 2001 From: Alexander Courtis Date: Tue, 18 Apr 2023 16:51:57 +1000 Subject: [PATCH] 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 --- doc/nvim-tree-lua.txt | 22 ++++++++++++++++++++++ lua/nvim-tree/api.lua | 8 ++++++++ 2 files changed, 30 insertions(+) diff --git a/doc/nvim-tree-lua.txt b/doc/nvim-tree-lua.txt index a8158949..e44a5446 100644 --- a/doc/nvim-tree-lua.txt +++ b/doc/nvim-tree-lua.txt @@ -1408,6 +1408,28 @@ tree.toggle_hidden_filter() tree.toggle_help() *nvim-tree-api.tree.toggle_help()* Toggle help view. +tree.is_tree_buf({bufnr}) *nvim-tree-api.tree.is_tree_buf()* + Checks if a buffer is an nvim-tree. + + Parameters: ~ + • {bufnr} (number|nil) buffer handle, 0 or nil for current buffer + + Return: ~ + (boolean) buffer is an nvim-tree buffer + +tree.is_visible({opts}) *nvim-tree-api.tree.is_visible()* + Checks if nvim-tree is visible on the current, specified or any tab. + + Parameters: ~ + • {opts} (table) optional parameters + + Options: ~ + • {tabpage} (number) as per |nvim_get_current_tabpage()| + • {any_tabpage} (boolean) visible on any tab, default false + + Return: ~ + (boolean) nvim-tree is visible + ============================================================================== 5.2 API FILE SYSTEM *nvim-tree-api.fs* diff --git a/lua/nvim-tree/api.lua b/lua/nvim-tree/api.lua index 2b08529c..49dc05c1 100644 --- a/lua/nvim-tree/api.lua +++ b/lua/nvim-tree/api.lua @@ -107,6 +107,14 @@ Api.tree.toggle_hidden_filter = wrap(require("nvim-tree.actions.tree-modifiers.t Api.tree.toggle_help = wrap(require("nvim-tree.help").toggle) +Api.tree.is_tree_buf = wrap(require("nvim-tree.utils").is_nvim_tree_buf) + +---@class ApiTreeIsVisibleOpts +---@field tabpage number|nil +---@field any_tabpage boolean|nil default false + +Api.tree.is_visible = wrap(require("nvim-tree.view").is_visible) + Api.fs.create = wrap_node(require("nvim-tree.actions.fs.create-file").fn) Api.fs.remove = wrap_node(require("nvim-tree.actions.fs.remove-file").fn) Api.fs.trash = wrap_node(require("nvim-tree.actions.fs.trash").fn)