SuggestModal

Defined in: obsidian.d.ts:3924

Extends

• Modal.ISuggestOwner<T>

Extended by

• FuzzySuggestModal

Type Parameters

• T

Implements

• ISuggestOwner<T>

Constructors

new SuggestModal()

new SuggestModal<T>(app): SuggestModal<T>

Defined in: obsidian.d.ts:3947

Parameters

app

App

Returns

SuggestModal<T>

Overrides

Modal.constructor

Properties

app

app: App

Defined in: obsidian.d.ts:2810

Inherited from

Modal.app

---

containerEl

containerEl: HTMLElement

Defined in: obsidian.d.ts:2818

Inherited from

Modal.containerEl

---

contentEl

contentEl: HTMLElement

Defined in: obsidian.d.ts:2831

Inherited from

Modal.contentEl

---

ctaEl

ctaEl: HTMLDivElement

Defined in: src/obsidian/augmentations/SuggestModal.d.ts:8

---

emptyStateText

emptyStateText: string

Defined in: obsidian.d.ts:3932

---

inputEl

inputEl: HTMLInputElement

Defined in: obsidian.d.ts:3937

---

limit

limit: number

Defined in: obsidian.d.ts:3928

---

modalEl

modalEl: HTMLElement

Defined in: obsidian.d.ts:2822

Inherited from

Modal.modalEl

---

resultContainerEl

resultContainerEl: HTMLElement

Defined in: obsidian.d.ts:3942

---

scope

scope: Scope

Defined in: obsidian.d.ts:2814

Inherited from

Modal.scope

---

shouldAnimate

shouldAnimate: boolean

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

Whether the modal should animate

Inherited from

Modal.shouldAnimate

---

shouldRestoreSelection

shouldRestoreSelection: boolean

Defined in: obsidian.d.ts:2836

Inherited from

Modal.shouldRestoreSelection

---

titleEl

titleEl: HTMLElement

Defined in: obsidian.d.ts:2827

Inherited from

Modal.titleEl

---

win

win: null | Window

Defined in: src/obsidian/augmentations/Modal.d.ts:22

Reference to the global Window object

Inherited from

Modal.win

Methods

close()

close(): void

Defined in: obsidian.d.ts:2850

Returns

void

Inherited from

Modal.close

---

getSuggestions()

abstract getSuggestions(query): T[] | Promise<T[]>

Defined in: obsidian.d.ts:3972

Parameters

query

string

Returns

T[] | Promise<T[]>

---

onChooseSuggestion()

abstract onChooseSuggestion(item, evt): void

Defined in: obsidian.d.ts:3980

Parameters

item

T

evt

MouseEvent | KeyboardEvent

Returns

void

---

onClose()

onClose(): void

Defined in: obsidian.d.ts:2858

Returns

void

Inherited from

Modal.onClose

---

onNoSuggestion()

onNoSuggestion(): void

Defined in: obsidian.d.ts:3960

Returns

void

---

onOpen()

onOpen(): void

Defined in: obsidian.d.ts:2854

Returns

void

Inherited from

Modal.onOpen

---

open()

open(): void

Defined in: obsidian.d.ts:2845

Returns

void

Inherited from

Modal.open

---

renderSuggestion()

abstract renderSuggestion(value, el): void

Defined in: obsidian.d.ts:3976

Parameters

value

T

el

HTMLElement

Returns

void

Implementation of

ISuggestOwner.renderSuggestion

Inherited from

ISuggestOwner.renderSuggestion

---

selectActiveSuggestion()

selectActiveSuggestion(evt): void

Defined in: obsidian.d.ts:3968

Parameters

evt

MouseEvent | KeyboardEvent

Returns

void

---

selectSuggestion()

selectSuggestion(value, evt): void

Defined in: obsidian.d.ts:3964

Parameters

value

T

evt

MouseEvent | KeyboardEvent

Returns

void

Implementation of

ISuggestOwner.selectSuggestion

Inherited from

ISuggestOwner.selectSuggestion

---

setContent()

setContent(content): this

Defined in: obsidian.d.ts:2867

Parameters

content

string | DocumentFragment

Returns

this

Inherited from

Modal.setContent

---

setInstructions()

setInstructions(instructions): void

Defined in: obsidian.d.ts:3955

Parameters

instructions

Instruction[]

Returns

void

---

setPlaceholder()

setPlaceholder(placeholder): void

Defined in: obsidian.d.ts:3951

Parameters

placeholder

string

Returns

void

---

setTitle()

setTitle(title): this

Defined in: obsidian.d.ts:2863

Parameters

title

string

Returns

this

Inherited from

Modal.setTitle