PopoverSuggest

Defined in: obsidian.d.ts:3330

Base class for adding a type-ahead popover.

Extends

• ISuggestOwner<T>.CloseableComponent

Extended by

• AbstractInputSuggest
• EditorSuggest

Type Parameters

• T

Implements

• ISuggestOwner<T>
• CloseableComponent

Constructors

new PopoverSuggest()

new PopoverSuggest<T>(app, scope?): PopoverSuggest<T>

Defined in: obsidian.d.ts:3337

Parameters

app

App

scope?

Scope

Returns

PopoverSuggest<T>

Properties

app

app: App

Defined in: obsidian.d.ts:3332

---

isOpen

isOpen: boolean

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

Whether the suggestion popup is currently open and visible

---

scope

scope: Scope

Defined in: obsidian.d.ts:3334

---

suggestEl

suggestEl: HTMLElement

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

Suggestion container element

---

suggestions

suggestions: SuggestionContainer<T>

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

Handles selection and rendering of the suggestions

Methods

close()

close(): void

Defined in: obsidian.d.ts:3341

Returns

void

Implementation of

CloseableComponent.close

Inherited from

CloseableComponent.close

---

open()

open(): void

Defined in: obsidian.d.ts:3339

Returns

void

---

renderSuggestion()

abstract renderSuggestion(value, el): void

Defined in: obsidian.d.ts:3347

Render the suggestion item into DOM.

Parameters

value

T

el

HTMLElement

Returns

void

Implementation of

ISuggestOwner.renderSuggestion

Inherited from

ISuggestOwner.renderSuggestion

---

selectSuggestion()

abstract selectSuggestion(value, evt): void

Defined in: obsidian.d.ts:3352

Called when the user makes a selection.

Parameters

value

T

evt

MouseEvent | KeyboardEvent

Returns

void

Implementation of

ISuggestOwner.selectSuggestion

Inherited from

ISuggestOwner.selectSuggestion