* feat(#2948): add UserDecorator, proof of concept * feat(#2948): add UserDecorator, proof of concept * feat(#2948): add UserDecorator, proof of concept * feat(#2948): add UserDecorator * feat(#2948): add UserDecorator * feat(#2948): add UserDecorator * feat(#2948): add Decorator node icon override * feat(#2948): add nvim_tree.api.* node classes * feat(#2948): extract _meta following nvim pattern * feat(#2948): extract _meta following nvim pattern * feat(#2948): add decorator registry and order * feat(#2948): add decorator registry and order * feat(#2948): tidy * feat(#2948): document API * feat(#2948): document API * feat(#2948): document API * feat(#2948): pass api nodes to user decorators * feat(#2948): document API * feat(#2948): use renderer.decorators to define order and register * feat(#2948): tidy decorator args and complete documentation * feat(#2948): decorator classes specified by prefix rather than suffix * feat(#2948): improve doc * feat(#2948): improve doc * feat(#2948): improve doc * feat(#2948): additional user decorator safety * feat(#2948): create nvim_tree.api.decorator.UserDecorator class in API, add :extend * feat(#2948): improve doc
48 lines
1.4 KiB
Lua
48 lines
1.4 KiB
Lua
local Decorator = require("nvim-tree.renderer.decorator")
|
|
|
|
---@class (exact) BookmarkDecorator: Decorator
|
|
---@field private explorer Explorer
|
|
---@field private icon HighlightedString?
|
|
local BookmarkDecorator = Decorator:extend()
|
|
|
|
---@class BookmarkDecorator
|
|
---@overload fun(args: DecoratorArgs): BookmarkDecorator
|
|
|
|
---@protected
|
|
---@param args DecoratorArgs
|
|
function BookmarkDecorator:new(args)
|
|
self.explorer = args.explorer
|
|
|
|
self.enabled = true
|
|
self.highlight_range = self.explorer.opts.renderer.highlight_bookmarks or "none"
|
|
self.icon_placement = self.explorer.opts.renderer.icons.bookmarks_placement or "none"
|
|
|
|
if self.explorer.opts.renderer.icons.show.bookmarks then
|
|
self.icon = {
|
|
str = self.explorer.opts.renderer.icons.glyphs.bookmark,
|
|
hl = { "NvimTreeBookmarkIcon" },
|
|
}
|
|
self:define_sign(self.icon)
|
|
end
|
|
end
|
|
|
|
---Bookmark icon: renderer.icons.show.bookmarks and node is marked
|
|
---@param node Node
|
|
---@return HighlightedString[]? icons
|
|
function BookmarkDecorator:icons(node)
|
|
if self.explorer.marks:get(node) then
|
|
return { self.icon }
|
|
end
|
|
end
|
|
|
|
---Bookmark highlight: renderer.highlight_bookmarks and node is marked
|
|
---@param node Node
|
|
---@return string? highlight_group
|
|
function BookmarkDecorator:highlight_group(node)
|
|
if self.highlight_range ~= "none" and self.explorer.marks:get(node) then
|
|
return "NvimTreeBookmarkHL"
|
|
end
|
|
end
|
|
|
|
return BookmarkDecorator
|