Skip to content

TextAreaComponent

Defined in: obsidian.d.ts:4043

Extends

Constructors

new TextAreaComponent()

new TextAreaComponent(containerEl): TextAreaComponent

Defined in: obsidian.d.ts:4047

Parameters

containerEl

HTMLElement

Returns

TextAreaComponent

Overrides

AbstractTextComponent.constructor

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


disabled

disabled: boolean

Defined in: obsidian.d.ts:423

Inherited from

AbstractTextComponent.disabled


inputEl

inputEl: HTMLTextAreaElement

Defined in: obsidian.d.ts:333

Inherited from

AbstractTextComponent.inputEl

Methods

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:358

Returns

void

Inherited from

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


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