EditorSuggest

Generate suggestion items based on this context. Can be async, but preferably sync. When generating async suggestions, you should pass the context along.

Parameters

context

EditorSuggestContext

Returns

T[] | Promise<T[]>

getSuggestions__()

getSuggestions__(context): T[] | Promise<T[]>

Defined in: src/obsidian/augmentations/EditorSuggest.d.ts:59

Generate suggestion items based on this context. Can be async, but preferably sync. When generating async suggestions, you should pass the context along.

Parameters

context

EditorSuggestContext

The context of the suggestion.

Returns

T[] | Promise<T[]>

The suggestion items.

Examples

class MyEditorSuggest extends EditorSuggest<string> {
    public override getSuggestions(context: EditorSuggestContext): string[] {
        return ['Item 1', 'Item 2', 'Item 3'];
    }
}

class MyEditorSuggest extends EditorSuggest<string> {
    public override getSuggestions(context: EditorSuggestContext): Promise<string[]> {
        return Promise.resolve(['Item 1', 'Item 2', 'Item 3']);
    }
}

onTrigger()

abstract onTrigger(cursor, editor, file): null | EditorSuggestTriggerInfo

Defined in: obsidian.d.ts:1396

Based on the editor line and cursor position, determine if this EditorSuggest should be triggered at this moment. Typically, you would run a regular expression on the current line text before the cursor. Return null to indicate that this editor suggest is not supposed to be triggered.

Please be mindful of performance when implementing this function, as it will be triggered very often (on each keypress). Keep it simple, and return null as early as possible if you determine that it is not the right time.

Parameters

cursor

EditorPosition

editor

Editor

file

null | TFile

Returns

null | EditorSuggestTriggerInfo

onTrigger__()

onTrigger__(cursor, editor, file): null | EditorSuggestTriggerInfo

Defined in: src/obsidian/augmentations/EditorSuggest.d.ts:88

Based on the editor line and cursor position, determine if this EditorSuggest should be triggered at this moment. Typically, you would run a regular expression on the current line text before the cursor. Return null to indicate that this editor suggest is not supposed to be triggered.

Please be mindful of performance when implementing this function, as it will be triggered very often (on each keypress). Keep it simple, and return null as early as possible if you determine that it is not the right time.

Parameters

cursor

EditorPosition

The cursor position.

editor

Editor

The editor instance.

file

The file instance.

null | TFile

Returns

null | EditorSuggestTriggerInfo

The trigger info or null if the suggestion is not supposed to be triggered.

Example

class MyEditorSuggest extends EditorSuggest<string> {
    public override onTrigger(cursor: EditorPosition, editor: Editor, file: TFile | null): EditorSuggestTriggerInfo | null {
        return {
            start: cursor,
            end: cursor,
            query: file?.basename ?? ''
        };
    }
}

open()

Call Signature

open(): void

Defined in: obsidian.d.ts:3407

Returns

void

Inherited from

PopoverSuggest.open

Call Signature

open(): void

Defined in: src/obsidian/augmentations/PopoverSuggest.d.ts:69

Opens the popover.

Returns

void

Inherited from

PopoverSuggest.open

renderSuggestion()

abstract renderSuggestion(value, el): void

Defined in: obsidian.d.ts:3415

Render the suggestion item into DOM.

Parameters

value

T

el

HTMLElement

Returns

void

Inherited from

PopoverSuggest.renderSuggestion

renderSuggestion__()

renderSuggestion__(value, el): void

Defined in: src/obsidian/augmentations/PopoverSuggest.d.ts:88

Render the suggestion.

Parameters

value

T

The value to render.

el

HTMLElement

The element to render the suggestion to.

Returns

void

Example

class MyPopoverSuggest extends PopoverSuggest<string> {
    public override renderSuggestion(value: string, el: HTMLElement): void {
        el.createEl('strong', { text: value });
    }
}

Inherit Doc

Inherited from

PopoverSuggest.renderSuggestion__

selectSuggestion()

abstract selectSuggestion(value, evt): void

Defined in: obsidian.d.ts:3420

Called when the user makes a selection.

Parameters

value

T

evt

MouseEvent | KeyboardEvent

Returns

void

Inherited from

PopoverSuggest.selectSuggestion

selectSuggestion__()

selectSuggestion__(value, evt): void

Defined in: src/obsidian/augmentations/PopoverSuggest.d.ts:107

Select the suggestion.

Parameters

value

T

The value to select.

evt

The event that triggered the selection.

MouseEvent | KeyboardEvent

Returns

void

Example

class MyPopoverSuggest extends PopoverSuggest<string> {
    public override selectSuggestion(value: string, evt: MouseEvent | KeyboardEvent): void {
        console.log(value);
    }
}

Inherit Doc

Inherited from

PopoverSuggest.selectSuggestion__

setInstructions()

Call Signature

setInstructions(instructions): void

Defined in: obsidian.d.ts:1385

Parameters

instructions

Instruction[]

Returns

void

Call Signature

setInstructions(instructions): void

Defined in: src/obsidian/augmentations/EditorSuggest.d.ts:100

Set the instructions for the suggestion.

Parameters

instructions

Instruction[]

The instructions for the suggestion.

Returns

void

Example

suggest.setInstructions([{ command: '↑↓', purpose: 'Navigate' }]);

showSuggestions()

showSuggestions(results): void

Defined in: src/obsidian/augmentations/EditorSuggest.d.ts:107

Show suggestions.

Parameters

results

SearchResult[]

Returns

void