Skip to content

EditorSuggests

Defined in: src/obsidian/internals/EditorSuggests.d.ts:8

Properties

currentSuggest

currentSuggest: null | EditorSuggest<any>

Defined in: src/obsidian/internals/EditorSuggests.d.ts:12

Currently active and rendered editor suggestion popup


suggests

suggests: EditorSuggest<any>[]

Defined in: src/obsidian/internals/EditorSuggests.d.ts:19

Registered editor suggestions

Methods

addSuggest()

addSuggest(suggest): void

Defined in: src/obsidian/internals/EditorSuggests.d.ts:24

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

Parameters

suggest

EditorSuggest<any>

Returns

void


close()

close(): void

Defined in: src/obsidian/internals/EditorSuggests.d.ts:28

Close the currently active editor suggestion popup

Returns

void


isShowingSuggestion()

isShowingSuggestion(): boolean

Defined in: src/obsidian/internals/EditorSuggests.d.ts:32

Whether there is a editor suggestion popup active and visible

Returns

boolean


removeSuggest()

removeSuggest(suggest): void

Defined in: src/obsidian/internals/EditorSuggests.d.ts:36

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

Parameters

suggest

EditorSuggest<any>

Returns

void


reposition()

reposition(): void

Defined in: src/obsidian/internals/EditorSuggests.d.ts:40

Update position of currently active and rendered editor suggestion popup

Returns

void


setCurrentSuggest()

setCurrentSuggest(suggest): void

Defined in: src/obsidian/internals/EditorSuggests.d.ts:44

Set the currently active editor suggestion popup to specified suggester

Parameters

suggest

EditorSuggest<any>

Returns

void


trigger()

trigger(editor, t, n): void

Defined in: src/obsidian/internals/EditorSuggests.d.ts:48

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

Parameters

editor

MarkdownBaseView

t

TFile

n

boolean

Returns

void