SearchComponent

Defined in: obsidian.d.ts:3588

Extends

AbstractTextComponent<HTMLInputElement>

Constructors

new SearchComponent()

new SearchComponent(containerEl): SearchComponent

Defined in: obsidian.d.ts:3597

Parameters

Properties

changeCallback()?

optional changeCallback: (value) => void

Defined in: src/obsidian/augmentations/Components/AbstractTextComponent.d.ts:9

The function that’s called after changing the value of the component.

Parameters

value

string

Returns

void

Inherited from

AbstractTextComponent.changeCallback

clearButtonEl

clearButtonEl: HTMLElement

Defined in: obsidian.d.ts:3592

containerEl

containerEl: HTMLElement

Defined in: src/obsidian/augmentations/Components/SearchComponent.d.ts:8

The containing element for the component’s clearButtonEl and inputEl

disabled

disabled: boolean

Defined in: obsidian.d.ts:423

Inherited from

AbstractTextComponent.disabled

inputEl

inputEl: HTMLInputElement

Defined in: obsidian.d.ts:333

Inherited from

AbstractTextComponent.inputEl

Methods

addRightDecorator()

addRightDecorator(decoratorFn): this

Defined in: src/obsidian/augmentations/Components/SearchComponent.d.ts:13

Adds a decorator to the right side of the search component

Parameters

decoratorFn

(containerEl) => void

Returns

this

getValue()

getValue(): string

Defined in: obsidian.d.ts:346

Returns

string

Inherited from

AbstractTextComponent.getValue

onChange()

onChange(callback): this

Defined in: obsidian.d.ts:362

Parameters

callback

(value) => any

Returns

this

Inherited from

AbstractTextComponent.onChange

onChanged()

onChanged(): void

Defined in: obsidian.d.ts:3601

Returns

void

Overrides

AbstractTextComponent.onChanged

registerOptionListener()

registerOptionListener(listeners, key): this

Defined in: obsidian.d.ts:4219

Parameters

listeners

Record<string, (value?) => string>

key

string

Returns

this

Inherited from

AbstractTextComponent.registerOptionListener

setClass()

setClass(cls): this

Defined in: src/obsidian/augmentations/Components/SearchComponent.d.ts:17

Adds a class to the search component

Parameters

cls

string

Returns

this

setDisabled()

setDisabled(disabled): this

Defined in: obsidian.d.ts:342

Parameters

disabled

boolean

Returns

this

Inherited from

AbstractTextComponent.setDisabled

setPlaceholder()

setPlaceholder(placeholder): this

Defined in: obsidian.d.ts:354

Parameters

placeholder

string

Returns

this

Inherited from

AbstractTextComponent.setPlaceholder

setValue()

setValue(value): this

Defined in: obsidian.d.ts:350

Parameters

value

string

Returns

this

Inherited from

AbstractTextComponent.setValue

then()

then(cb): this

Defined in: obsidian.d.ts:428

Facilitates chaining

Parameters

cb

(component) => any

Returns

this

Inherited from

AbstractTextComponent.then