EditorSuggests

Properties

currentSuggest

currentSuggest: null | EditorSuggest<any>

Currently active and rendered editor suggestion popup

---

suggests

suggests: EditorSuggest<any>[]

Registered editor suggestions

Remark

Used for providing autocompletions for specific strings

Tutorial

Reference official documentation under EditorSuggest for usage

Methods

addSuggest()

addSuggest(suggest): void

Add a new editor suggestion to the list of registered suggestion providers

Parameters

• suggest: EditorSuggest<any>

Returns

void

---

close()

close(): void

Close the currently active editor suggestion popup

Returns

void

---

isShowingSuggestion()

isShowingSuggestion(): boolean

Whether there is a editor suggestion popup active and visible

Returns

boolean

---

removeSuggest()

removeSuggest(suggest): void

Remove a registered editor suggestion from the list of registered suggestion providers

Parameters

• suggest: EditorSuggest<any>

Returns

void

---

reposition()

reposition(): void

Update position of currently active and rendered editor suggestion popup

Returns

void

---

setCurrentSuggest()

setCurrentSuggest(suggest): void

Set the currently active editor suggestion popup to specified suggester

Parameters

• suggest: EditorSuggest<any>

Returns

void

---

trigger()

trigger(editor, t, n): void

Run check on focused editor to see whether a suggestion should be triggered and rendered

Parameters

• editor: MarkdownBaseView

• t: TFile

• n: boolean

Returns

void