feat: add toggle_doc functionality (#1647)

* feat: Add toggle_doc functionality

fix: Update docs view on entry change

* Replace toggle logic by open/close

* add docs and pinned flags

* add faq for disabling docs

* chore(git): ignore .DS_Store

---------

Co-authored-by: hrsh7th <629908+hrsh7th@users.noreply.github.com>
This commit is contained in:
Maria José Solano
2023-08-11 19:50:49 -07:00
committed by GitHub
parent 3b9f28061a
commit 1c03ebc7dc
7 changed files with 139 additions and 6 deletions

View File

@@ -168,19 +168,23 @@ cmp.ItemField = {
---@field public entry_filter nil|function(entry: cmp.Entry, ctx: cmp.Context): boolean
---@class cmp.ViewConfig
---@field public entries cmp.EntriesConfig
---@field public entries cmp.EntriesViewConfig
---@field public docs cmp.DocsViewConfig
---@alias cmp.EntriesConfig cmp.CustomEntriesConfig|cmp.NativeEntriesConfig|cmp.WildmenuEntriesConfig|string
---@alias cmp.EntriesViewConfig cmp.CustomEntriesViewConfig|cmp.NativeEntriesViewConfig|cmp.WildmenuEntriesViewConfig|string
---@class cmp.CustomEntriesConfig
---@class cmp.CustomEntriesViewConfig
---@field name 'custom'
---@field selection_order 'top_down'|'near_cursor'
---@class cmp.NativeEntriesConfig
---@class cmp.NativeEntriesViewConfig
---@field name 'native'
---@class cmp.WildmenuEntriesConfig
---@class cmp.WildmenuEntriesViewConfig
---@field name 'wildmenu'
---@field separator string|nil
---@class cmp.DocsViewConfig
---@field public auto_open boolean
return cmp