boltless.me
Expand your neovim sense with small UI components
3.6 kB
96 lines
1==============================================================================
2Public api to control sense.nvim UI components *sense.api*
3
4
5The Lua API for sense.nvim
6Intended for use by third-party modules that extend its functionalities.
7
8
9M.register_renderer({renderer}) *M.register_renderer*
10 Register Indicator
11 This method will call Indicator:init() immediately.
12
13 Parameters: ~
14 {renderer} (sense.Indicator)
15
16
17sense.api.redraw.Opts *sense.api.redraw.Opts*
18 winid can be used instead of wininfo.
19 When wininfo exists, winid will be ignored.
20
21 Fields: ~
22 {winid?} (integer)
23 {wininfo?} (vim.fn.getwininfo.ret.item)
24
25
26M.redraw({opts?}) *M.redraw*
27 Redraw indicators.
28 When opts is not given, it will redraw indicators for every existing windows.
29
30 Parameters: ~
31 {opts?} (sense.api.redraw.Opts)
32
33
34==============================================================================
35Builtin StatusColumn UI element *sense.ui.statuscol*
36
37sense.ui.statuscol.create.Opts *sense.ui.statuscol.create.Opts*
38
39 Fields: ~
40 {name} (string) Unique name used to save & restore UI state on each windows
41 {on_init?} (fun(self:sense.Indicator)) Called on Indicator:init()
42 {render_lines} (fun(wininfo:vim.fn.getwininfo.ret.item):sense.ui.TopBotLines) Abstracted version of Indicator:render()
43
44
45statuscol.create({opts}) *statuscol.create*
46
47 Parameters: ~
48 {opts} (sense.ui.statuscol.create.Opts)
49
50 Returns: ~
51 (sense.Indicator)
52
53
54==============================================================================
55Builtin VirtualText UI element *sense.ui.virtualtext*
56
57sense.ui.virtualtext.create.Opts *sense.ui.virtualtext.create.Opts*
58
59 Fields: ~
60 {name} (string) Unique name used to save & restore UI state on each windows
61 {on_init?} (fun(self:sense.Indicator)) Called on Indicator:init()
62 {render_lines} (fun(wininfo:vim.fn.getwininfo.ret.item):sense.ui.TopBotLines) Abstracted version of Indicator:render()
63
64
65M.create({opts}) *M.create*
66
67 Parameters: ~
68 {opts} (sense.ui.virtualtext.create.Opts)
69
70 Returns: ~
71 (sense.Indicator)
72
73
74==============================================================================
75useful functions to build custom UI components *sense.helper*
76
77sense.helper.DiagnosticScreenInfo *sense.helper.DiagnosticScreenInfo*
78 Captured diagnostics for current window view.
79
80 Fields: ~
81 {above} (vim.Diagnostic[]) diagnostics above the window. Ordered by distance
82 {below} (vim.Diagnostic[]) diagnostics below the window. Ordered by distance
83 {top_edge?} (vim.Diagnostic) diagnostic on the top-edge line in current window
84 {bot_edge?} (vim.Diagnostic) diagnostic on the bottom-edge line in current window
85
86
87M.capture_diagnostics({wininfo}) *M.capture_diagnostics*
88
89 Parameters: ~
90 {wininfo} (vim.fn.getwininfo.ret.item)
91
92 Returns: ~
93 (sense.helper.DiagnosticScreenInfo) screen
94
95
96vim:tw=78:ts=8:noet:ft=help:norl: