CommandPaletteModal

Defined in: src/obsidian/internals/InternalPlugins/CommandPalette/CommandPaletteModal.d.ts:8

Extends

• FuzzySuggestModal<Command>

Properties

app

app: App

Defined in: obsidian.d.ts:2810

Inherited from

FuzzySuggestModal.app

---

chooser

chooser: SuggestModalChooser<FuzzyMatch<Command>, CommandPaletteModal>

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

Inherited from

FuzzySuggestModal.chooser

---

commands

commands: null | Command[]

Defined in: src/obsidian/internals/InternalPlugins/CommandPalette/CommandPaletteModal.d.ts:9

---

containerEl

containerEl: HTMLElement

Defined in: obsidian.d.ts:2818

Inherited from

FuzzySuggestModal.containerEl

---

contentEl

contentEl: HTMLElement

Defined in: obsidian.d.ts:2831

Inherited from

FuzzySuggestModal.contentEl

---

ctaEl

ctaEl: HTMLDivElement

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

Inherited from

FuzzySuggestModal.ctaEl

---

emptyStateText

emptyStateText: string

Defined in: obsidian.d.ts:3932

Inherited from

FuzzySuggestModal.emptyStateText

---

headerEl

headerEl: HTMLDivElement

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

Inherited from

FuzzySuggestModal.headerEl

---

inputEl

inputEl: HTMLInputElement

Defined in: obsidian.d.ts:3937

Inherited from

FuzzySuggestModal.inputEl

---

instructionsEl

instructionsEl: HTMLDivElement

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

Inherited from

FuzzySuggestModal.instructionsEl

---

isOpen

isOpen: boolean

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

Inherited from

FuzzySuggestModal.isOpen

---

limit

limit: number

Defined in: obsidian.d.ts:3928

Inherited from

FuzzySuggestModal.limit

---

modalEl

modalEl: HTMLElement

Defined in: obsidian.d.ts:2822

Inherited from

FuzzySuggestModal.modalEl

---

plugin

plugin: CommandPalettePluginInstance

Defined in: src/obsidian/internals/InternalPlugins/CommandPalette/CommandPaletteModal.d.ts:10

---

resultContainerEl

resultContainerEl: HTMLElement

Defined in: obsidian.d.ts:3942

Inherited from

FuzzySuggestModal.resultContainerEl

---

scope

scope: Scope

Defined in: obsidian.d.ts:2814

Inherited from

FuzzySuggestModal.scope

---

shouldAnimate

shouldAnimate: boolean

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

Whether the modal should animate

Inherited from

FuzzySuggestModal.shouldAnimate

---

shouldRestoreSelection

shouldRestoreSelection: boolean

Defined in: obsidian.d.ts:2836

Inherited from

FuzzySuggestModal.shouldRestoreSelection

---

titleEl

titleEl: HTMLElement

Defined in: obsidian.d.ts:2827

Inherited from

FuzzySuggestModal.titleEl

---

win

win: null | Window

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

Reference to the global Window object

Inherited from

FuzzySuggestModal.win

Methods

close()

close(): void

Defined in: obsidian.d.ts:2850

Returns

void

Inherited from

FuzzySuggestModal.close

---

getItems()

abstract getItems(): Command[]

Defined in: obsidian.d.ts:1847

Returns

Command[]

Inherited from

FuzzySuggestModal.getItems

---

getItemText()

abstract getItemText(item): string

Defined in: obsidian.d.ts:1851

Parameters

item

Command

Returns

string

Inherited from

FuzzySuggestModal.getItemText

---

getSuggestions()

getSuggestions(query): FuzzyMatch<Command>[]

Defined in: obsidian.d.ts:1835

Parameters

query

string

Returns

FuzzyMatch<Command>[]

Inherited from

FuzzySuggestModal.getSuggestions

---

onChooseItem()

abstract onChooseItem(item, evt): void

Defined in: obsidian.d.ts:1855

Parameters

item

Command

evt

MouseEvent | KeyboardEvent

Returns

void

Inherited from

FuzzySuggestModal.onChooseItem

---

onChooseSuggestion()

onChooseSuggestion(item, evt): void

Defined in: obsidian.d.ts:1843

Parameters

item

FuzzyMatch<Command>

evt

MouseEvent | KeyboardEvent

Returns

void

Inherited from

FuzzySuggestModal.onChooseSuggestion

---

onClose()

onClose(): void

Defined in: obsidian.d.ts:2858

Returns

void

Inherited from

FuzzySuggestModal.onClose

---

onInput()

onInput(): void

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

Returns

void

Inherited from

FuzzySuggestModal.onInput

---

onNoSuggestion()

onNoSuggestion(): void

Defined in: obsidian.d.ts:3960

Returns

void

Inherited from

FuzzySuggestModal.onNoSuggestion

---

onOpen()

onOpen(): void

Defined in: obsidian.d.ts:2854

Returns

void

Inherited from

FuzzySuggestModal.onOpen

---

open()

open(): void

Defined in: obsidian.d.ts:2845

Returns

void

Inherited from

FuzzySuggestModal.open

---

renderSuggestion()

renderSuggestion(item, el): void

Defined in: obsidian.d.ts:1839

Parameters

item

FuzzyMatch<Command>

el

HTMLElement

Returns

void

Inherited from

FuzzySuggestModal.renderSuggestion

---

selectActiveSuggestion()

selectActiveSuggestion(evt): void

Defined in: obsidian.d.ts:3968

Parameters

evt

MouseEvent | KeyboardEvent

Returns

void

Inherited from

FuzzySuggestModal.selectActiveSuggestion

---

selectSuggestion()

selectSuggestion(value, evt): void

Defined in: obsidian.d.ts:3964

Parameters

value

FuzzyMatch<Command>

evt

MouseEvent | KeyboardEvent

Returns

void

Inherited from

FuzzySuggestModal.selectSuggestion

---

setContent()

setContent(content): this

Defined in: obsidian.d.ts:2867

Parameters

content

string | DocumentFragment

Returns

this

Inherited from

FuzzySuggestModal.setContent

---

setInstructions()

setInstructions(instructions): void

Defined in: obsidian.d.ts:3955

Parameters

instructions

Instruction[]

Returns

void

Inherited from

FuzzySuggestModal.setInstructions

---

setPlaceholder()

setPlaceholder(placeholder): void

Defined in: obsidian.d.ts:3951

Parameters

placeholder

string

Returns

void

Inherited from

FuzzySuggestModal.setPlaceholder

---

setTitle()

setTitle(title): this

Defined in: obsidian.d.ts:2863

Parameters

title

string

Returns

this

Inherited from

FuzzySuggestModal.setTitle

---

updateSuggestions()

updateSuggestions(): void

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

Returns

void

Inherited from

FuzzySuggestModal.updateSuggestions