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

Property Type Description
currentSuggest? EditorSuggest<unknown> Currently active and rendered editor suggestion popup.
suggests EditorSuggest<unknown>[] Registered editor suggestion providers.

Methods

Method Returns Description
addSuggest(suggest) void Registers an editor suggestion provider.
close() void Closes the active suggestion provider.
isShowingSuggestion() boolean Checks whether a suggestion popup is currently shown.
removeSuggest(suggest) void Unregisters an editor suggestion provider.
reposition() void Repositions the active suggestion popup.
setCurrentSuggest(suggest) void Sets the active suggestion provider, closing the previous one.
trigger(editor, file, force) void Triggers the registered suggestion providers at the cursor.

Links to this page: