Form Components

textarea-component

Overview

textarea-component allows users to enter multiline text. It is ideal for larger inputs like comments or messages in a form. This component is used in the scheduling form to input multiline text.

Version1.3.3
Install (React)npm install @nylas/react
Import (React)import { TextareaComponent } from '@nylas/react';
Import (CDN)<script type="module"> import { defineCustomElement } from "https://cdn.jsdelivr.net/npm/@nylas/web-elements@latest/dist/cdn/textarea-component/textarea-component.es.js"; defineCustomElement(); </script>

Properties

PropertyAttributeDescriptionTypeDefault
autoFocusAutomatically focus the textarea when the component loads.booleanfalse
defaultValueThe default value of the textarea, appearing when the component first renders.string | undefinedundefined
labelThe label for the textarea, displayed above it.string''
maxLengthThe maximum number of characters allowed in the textarea.number255
nameThe name of the textarea, important for form submissions.string'textarea'
placeholderPlaceholder text shown in the textarea when it is empty.string''
readOnlyIf true, the textarea cannot be edited by the user.booleanfalse
requiredSpecifies if the textarea is required for form submission. If true, an error message shows if left empty.booleanfalse
tooltipThe content of the label’s tooltipstring''
typeThe typestring'multi_line_text'

Events

EventDescriptionType
nylasFormInputChangedEvent emitted when the value of the textarea changes. Useful for parent components to capture user input.CustomEvent<{ value: string; name: string; error: string; label: string; type: string; }>

Shadow Parts

PartDescription
"tc__label"The label for the textarea.
"tc__textarea"The textarea element.

Built with StencilJS