ISuggestOwner

Defined in: obsidian.d.ts:2095

Extended by

• PopoverSuggest
• SuggestModal

Type Parameters

T

T

Methods

renderSuggestion()

Call Signature

renderSuggestion(value, el): void

Defined in: obsidian.d.ts:2100

Render the suggestion item into DOM.

Parameters

value

T

el

HTMLElement

Returns

void

Call Signature

renderSuggestion(value, el): void

Defined in: src/obsidian/augmentations/ISuggestOwner.d.ts:25

Render the suggestion item into DOM.

Parameters

value

T

The value of the suggestion.

el

HTMLElement

The DOM element to render the suggestion into.

Returns

void

Example

class MySuggestOwner implements ISuggestOwner<string> {
    public renderSuggestion(value: string, el: HTMLElement): void {
        el.createEl('strong', { text: value });
    }
}

Official

---

selectSuggestion()

Call Signature

selectSuggestion(value, evt): void

Defined in: obsidian.d.ts:2105

Called when the user makes a selection.

Parameters

value

T

evt

MouseEvent | KeyboardEvent

Returns

void

Call Signature

selectSuggestion(value, evt): void

Defined in: src/obsidian/augmentations/ISuggestOwner.d.ts:42

Called when the user makes a selection.

Parameters

value

T

The value of the suggestion.

evt

The event that triggered the selection.

MouseEvent | KeyboardEvent

Returns

void

Example

class MySuggestOwner implements ISuggestOwner<string> {
    public selectSuggestion(value: string, evt: MouseEvent | KeyboardEvent): void {
        console.log(value, evt);
    }
}

Official