leigh/outline.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'main' of github.com:hedyhli/outline.nvim

Browse Source
This commit is contained in:
hedy
2023-11-26 15:16:50 +08:00
parent b90174c6c2 f4f864c959
commit 8062cff1a4
1 changed files with 20 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
doc/outline.txt
View File

@@ -1,4 +1,4 @@
*outline.txt* For NVIM v0.7.0 Last change: 2023 November 25 *outline.txt* For NVIM v0.7.0 Last change: 2023 November 26
============================================================================== ==============================================================================
Table of Contents *outline-table-of-contents* Table of Contents *outline-table-of-contents*
@@ -667,13 +667,13 @@ Outline.nvim provides the following public API for use in lua.
< <
- setup(opts) - setup(opts)
- **toggle_outline(opts)** - **toggle(opts)**
Toggle opening/closing of outline window. Toggle opening/closing of outline window.
If `opts.focus_outline=false`, keep focus on previous window. If `opts.focus_outline=false`, keep focus on previous window.
- **open_outline(opts)** - **open(opts)**
Open the outline window. Open the outline window.
If `opts.focus_outline=false`, keep focus on previous window. If `opts.focus_outline=false`, keep focus on previous window.
- **close_outline()** - **close()**
Close the outline window. Close the outline window.
- **focus_toggle()** - **focus_toggle()**
Toggle cursor focus between code and outline window. Toggle cursor focus between code and outline window.
@@ -686,19 +686,32 @@ Outline.nvim provides the following public API for use in lua.
- **show_status()** - **show_status()**
Display provider and outline window status in a floating window. Display provider and outline window status in a floating window.
- **has_provider()** - **has_provider()**
Returns whether a provider is available for current window. Returns whether a provider is available.
- **follow_cursor(opts)** - **follow_cursor(opts)**
Go to corresponding node in outline based on cursor position in code, and focus Go to corresponding node in outline based on cursor position in code, and focus
on the outline window. on the outline window.
With `opts.focus_outline=false`, cursor focus will remain on code window. With `opts.focus_outline=false`, cursor focus will remain on code window.
This is automatically called on events This is automatically called on events
`outline_items.auto_update_events.follow` from config. `outline_items.auto_update_events.follow` from config.
- **is_focus_in_outline()** - **has_focus()**
Return whether outline is open and current focus is in outline. Return whether outline is open and current focus is in outline.
- **refresh_outline()** - **refresh()**
Re-request symbols from provider and update outline items. Re-request symbols from provider and update outline items.
This is automatically called on events This is automatically called on events
`outline_items.auto_update_events.refresh` from config. `outline_items.auto_update_events.refresh` from config.
- **get_breadcrumb(opts)**
Return a string concatenated from hovered symbols hierarchy representing code
location.
Optional opts table fields:
- depth (nil): Maximum depth of the last symbol included. First item has depth 1.
Set to 0 or nil to include all
- sep (`>`): String for separator
- **get_symbol(opts)**
Return the symbol name of the deepest hovered symbol representing code
location.
Optional opts table fields:
- depth (nil): Maximum depth of the returned symbol
- kind (nil): Symbol kind to search for (string).
TIPS *outline-tips* TIPS *outline-tips*