Skip to content

SuggestModalChooser

Defined in: src/obsidian/internals/SuggestModalChooser.d.ts:2

Type Parameters

T

TModal

Properties

chooser

chooser: TModal

Defined in: src/obsidian/internals/SuggestModalChooser.d.ts:3


containerEl

containerEl: HTMLDivElement

Defined in: src/obsidian/internals/SuggestModalChooser.d.ts:4


numVisibleItems

numVisibleItems: number

Defined in: src/obsidian/internals/SuggestModalChooser.d.ts:5


rowHeight

rowHeight: number

Defined in: src/obsidian/internals/SuggestModalChooser.d.ts:6


selectedItem

selectedItem: number

Defined in: src/obsidian/internals/SuggestModalChooser.d.ts:7


suggestions

suggestions: HTMLDivElement[]

Defined in: src/obsidian/internals/SuggestModalChooser.d.ts:8


values

values: null | T[]

Defined in: src/obsidian/internals/SuggestModalChooser.d.ts:9

Methods

addMessage()

addMessage(text): void

Defined in: src/obsidian/internals/SuggestModalChooser.d.ts:11

Parameters

text

string | DocumentFragment

Returns

void


addSuggestion()

addSuggestion(value): void

Defined in: src/obsidian/internals/SuggestModalChooser.d.ts:12

Parameters

value

T

Returns

void


forceSetSelectedItem()

forceSetSelectedItem(index, evt): void

Defined in: src/obsidian/internals/SuggestModalChooser.d.ts:13

Parameters

index

number

evt

MouseEvent | KeyboardEvent

Returns

void


moveDown()

moveDown(evt): false | void

Defined in: src/obsidian/internals/SuggestModalChooser.d.ts:14

Parameters

evt

KeyboardEvent

Returns

false | void


moveUp()

moveUp(evt): false | void

Defined in: src/obsidian/internals/SuggestModalChooser.d.ts:15

Parameters

evt

KeyboardEvent

Returns

false | void


onSuggestionClick()

onSuggestionClick(evt, suggestion): void

Defined in: src/obsidian/internals/SuggestModalChooser.d.ts:16

Parameters

evt

MouseEvent

suggestion

HTMLDivElement

Returns

void


onSuggestionMouseover()

onSuggestionMouseover(evt, suggestion): void

Defined in: src/obsidian/internals/SuggestModalChooser.d.ts:17

Parameters

evt

MouseEvent

suggestion

HTMLDivElement

Returns

void


pageDown()

pageDown(evt): false | void

Defined in: src/obsidian/internals/SuggestModalChooser.d.ts:18

Parameters

evt

KeyboardEvent

Returns

false | void


pageUp()

pageUp(evt): false | void

Defined in: src/obsidian/internals/SuggestModalChooser.d.ts:19

Parameters

evt

KeyboardEvent

Returns

false | void


setSelectedItem()

setSelectedItem(index, evt): void

Defined in: src/obsidian/internals/SuggestModalChooser.d.ts:20

Parameters

index

number

evt

MouseEvent | KeyboardEvent

Returns

void


setSuggestions()

setSuggestions(values): void

Defined in: src/obsidian/internals/SuggestModalChooser.d.ts:21

Parameters

values

T[]

Returns

void


useSelectedItem()

useSelectedItem(evt): void

Defined in: src/obsidian/internals/SuggestModalChooser.d.ts:22

Parameters

evt

MouseEvent | KeyboardEvent

Returns

void