Textarea

Docs
API

Tag name: <vscode-textarea>

Multi-line text input.

When participating in a form, it supports the :invalid pseudo class. Otherwise the error styles can be applied through the invalid property.

Properties

autocomplete

Name	autocomplete
Attribute	autocomplete
Type	`'on' \| 'off' \| undefined`
Default	`undefined`

autofocusreflects

Name	autofocus
Attribute	autofocus
Type	`boolean`
Default	`false`

cols

Name	cols
Attribute	cols
Type	`number \| undefined`
Default	`undefined`

defaultValue

Name	defaultValue
Attribute	default-value
Type	`string`
Default	`''`

disabledreflects

Name	disabled
Attribute	disabled
Type	`boolean`
Default	`false`

formreadonly

Name	form
Type	`HTMLFormElement \| null`

invalidreflects

Name	invalid
Attribute	invalid
Type	`boolean`
Default	`false`

label

Name	label
Type	`string`
Default	`''`

maxLength

Name	maxLength
Attribute	maxLength
Type	`number \| undefined`
Default	`undefined`

maxlength

Name	maxlength
Type	`number \| undefined`
Description	Lowercase alias to maxLength

minLength

Name	minLength
Attribute	minLength
Type	`number \| undefined`
Default	`undefined`

minlength

Name	minlength
Type	`number \| undefined`
Description	Lowercase alias to minLength

monospacereflects

Name	monospace
Attribute	monospace
Type	`boolean`
Default	`false`
Description	Use monospace fonts. The font family, weight, size, and color will be the same as set in the VSCode code editor.

name

Name	name
Attribute	name
Type	`string \| undefined`
Default	`undefined`

placeholder

Name	placeholder
Attribute	placeholder
Type	`string \| undefined`
Default	`undefined`

readonlyreflects

Name	readonly
Attribute	readonly
Type	`boolean`
Default	`false`

requiredreflects

Name	required
Attribute	required
Type	`boolean`
Default	`false`

resize

Name	resize
Attribute	resize
Type	`'both' \| 'horizontal' \| 'vertical' \| 'none'`
Default	`'none'`

rows

Name	rows
Attribute	rows
Type	`number \| undefined`
Default	`undefined`

spellcheck

Name	spellcheck
Attribute	spellcheck
Type	`boolean`
Default	`false`

validationMessagereadonly

Name	validationMessage

validityreadonly

Name	validity
Type	`ValidityState`

value

Name	value
Attribute	value
Type	`string`

versionreadonly

Name	version
Type	`string`
Description	VSCode Elements version

willValidatereadonly

Name	willValidate

wrappedElementreadonly

Name	wrappedElement
Type	`HTMLTextAreaElement`
Description	Getter for the inner textarea element if it needs to be accessed for some reason.

Methods

checkValidity() : boolean

Name	checkValidity

reportValidity() : boolean

Name	reportValidity

Events

change

Name	change
Type	`Event`

input

Name	input
Type	`InputEvent`

vsc-changedeprecated

Name	vsc-change
Type	`CustomEvent`
Description	true

vsc-inputdeprecated

Name	vsc-input
Type	`CustomEvent`
Description	true

CSS Custom Properties

--vscode-editor-background

Name	--vscode-editor-background

--vscode-editor-font-family

Name	--vscode-editor-font-family

--vscode-editor-font-size

Name	--vscode-editor-font-size

--vscode-editor-font-weight

Name	--vscode-editor-font-weight

--vscode-editor-foreground

Name	--vscode-editor-foreground

--vscode-editor-inlineValuesForeground

Name	--vscode-editor-inlineValuesForeground

--vscode-focusBorder

Name	--vscode-focusBorder

--vscode-font-family

Name	--vscode-font-family

--vscode-font-size

Name	--vscode-font-size

--vscode-font-weight

Name	--vscode-font-weight

--vscode-input-placeholderForeground

Name	--vscode-input-placeholderForeground

--vscode-scrollbar-shadow

Name	--vscode-scrollbar-shadow

--vscode-scrollbarSlider-activeBackground

Name	--vscode-scrollbarSlider-activeBackground

--vscode-scrollbarSlider-background

Name	--vscode-scrollbarSlider-background

--vscode-scrollbarSlider-hoverBackground

Name	--vscode-scrollbarSlider-hoverBackground

--vscode-settings-textInputBackground

Name	--vscode-settings-textInputBackground

--vscode-settings-textInputBorder

Name	--vscode-settings-textInputBorder

--vscode-settings-textInputForeground

Name	--vscode-settings-textInputForeground