FuzzySuggestModal

Defined in: obsidian.d.ts:1831

Extends

• SuggestModal<FuzzyMatch<T>>

Type Parameters

• T

Constructors

new FuzzySuggestModal()

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

Defined in: obsidian.d.ts:3947

Parameters

app

App

Returns

FuzzySuggestModal<T>

Inherited from

SuggestModal.constructor

Properties

app

app: App

Defined in: obsidian.d.ts:2810

Inherited from

SuggestModal.app

---

containerEl

containerEl: HTMLElement

Defined in: obsidian.d.ts:2818

Inherited from

SuggestModal.containerEl

---

contentEl

contentEl: HTMLElement

Defined in: obsidian.d.ts:2831

Inherited from

SuggestModal.contentEl

---

ctaEl

ctaEl: HTMLDivElement

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

Inherited from

SuggestModal.ctaEl

---

emptyStateText

emptyStateText: string

Defined in: obsidian.d.ts:3932

Inherited from

SuggestModal.emptyStateText

---

inputEl

inputEl: HTMLInputElement

Defined in: obsidian.d.ts:3937

Inherited from

SuggestModal.inputEl

---

limit

limit: number

Defined in: obsidian.d.ts:3928

Inherited from

SuggestModal.limit

---

modalEl

modalEl: HTMLElement

Defined in: obsidian.d.ts:2822

Inherited from

SuggestModal.modalEl

---

resultContainerEl

resultContainerEl: HTMLElement

Defined in: obsidian.d.ts:3942

Inherited from

SuggestModal.resultContainerEl

---

scope

scope: Scope

Defined in: obsidian.d.ts:2814

Inherited from

SuggestModal.scope

---

shouldAnimate

shouldAnimate: boolean

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

Whether the modal should animate

Inherited from

SuggestModal.shouldAnimate

---

shouldRestoreSelection

shouldRestoreSelection: boolean

Defined in: obsidian.d.ts:2836

Inherited from

SuggestModal.shouldRestoreSelection

---

titleEl

titleEl: HTMLElement

Defined in: obsidian.d.ts:2827

Inherited from

SuggestModal.titleEl

---

win

win: null | Window

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

Reference to the global Window object

Inherited from

SuggestModal.win

Methods

close()

close(): void

Defined in: obsidian.d.ts:2850

Returns

void

Inherited from

SuggestModal.close

---

getItems()

abstract getItems(): T[]

Defined in: obsidian.d.ts:1847

Returns

T[]

---

getItemText()

abstract getItemText(item): string

Defined in: obsidian.d.ts:1851

Parameters

item

T

Returns

string

---

getSuggestions()

getSuggestions(query): FuzzyMatch<T>[]

Defined in: obsidian.d.ts:1835

Parameters

query

string

Returns

FuzzyMatch<T>[]

Overrides

SuggestModal.getSuggestions

---

onChooseItem()

abstract onChooseItem(item, evt): void

Defined in: obsidian.d.ts:1855

Parameters

item

T

evt

MouseEvent | KeyboardEvent

Returns

void

---

onChooseSuggestion()

onChooseSuggestion(item, evt): void

Defined in: obsidian.d.ts:1843

Parameters

item

FuzzyMatch<T>

evt

MouseEvent | KeyboardEvent

Returns

void

Overrides

SuggestModal.onChooseSuggestion

---

onClose()

onClose(): void

Defined in: obsidian.d.ts:2858

Returns

void

Inherited from

SuggestModal.onClose

---

onNoSuggestion()

onNoSuggestion(): void

Defined in: obsidian.d.ts:3960

Returns

void

Inherited from

SuggestModal.onNoSuggestion

---

onOpen()

onOpen(): void

Defined in: obsidian.d.ts:2854

Returns

void

Inherited from

SuggestModal.onOpen

---

open()

open(): void

Defined in: obsidian.d.ts:2845

Returns

void

Inherited from

SuggestModal.open

---

renderSuggestion()

renderSuggestion(item, el): void

Defined in: obsidian.d.ts:1839

Parameters

item

FuzzyMatch<T>

el

HTMLElement

Returns

void

Overrides

SuggestModal.renderSuggestion

---

selectActiveSuggestion()

selectActiveSuggestion(evt): void

Defined in: obsidian.d.ts:3968

Parameters

evt

MouseEvent | KeyboardEvent

Returns

void

Inherited from

SuggestModal.selectActiveSuggestion

---

selectSuggestion()

selectSuggestion(value, evt): void

Defined in: obsidian.d.ts:3964

Parameters

value

FuzzyMatch<T>

evt

MouseEvent | KeyboardEvent

Returns

void

Inherited from

SuggestModal.selectSuggestion

---

setContent()

setContent(content): this

Defined in: obsidian.d.ts:2867

Parameters

content

string | DocumentFragment

Returns

this

Inherited from

SuggestModal.setContent

---

setInstructions()

setInstructions(instructions): void

Defined in: obsidian.d.ts:3955

Parameters

instructions

Instruction[]

Returns

void

Inherited from

SuggestModal.setInstructions

---

setPlaceholder()

setPlaceholder(placeholder): void

Defined in: obsidian.d.ts:3951

Parameters

placeholder

string

Returns

void

Inherited from

SuggestModal.setPlaceholder

---

setTitle()

setTitle(title): this

Defined in: obsidian.d.ts:2863

Parameters

title

string

Returns

this

Inherited from

SuggestModal.setTitle