Skip to content

EditorSuggestEx

Unofficial

Extended editor suggest interface for managing editor suggestion providers.

Import:

import type { EditorSuggestEx } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface EditorSuggestEx

Properties

PropertyTypeDescription
currentSuggest?EditorSuggest<unknown>Currently active and rendered editor suggestion popup.
suggestsEditorSuggest<unknown>[]Registered editor suggestion providers.

Methods

MethodReturnsDescription
addSuggest(suggest)voidRegisters an editor suggestion provider.
close()voidCloses the active suggestion provider.
isShowingSuggestion()booleanChecks whether a suggestion popup is currently shown.
removeSuggest(suggest)voidUnregisters an editor suggestion provider.
reposition()voidRepositions the active suggestion popup.
setCurrentSuggest(suggest)voidSets the active suggestion provider, closing the previous one.
trigger(editor, file, force)voidTriggers the registered suggestion providers at the cursor.

Links to this page: