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.
Version | 1.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
Property | Attribute | Description | Type | Default |
---|---|---|---|---|
autoFocus | Automatically focus the textarea when the component loads. | boolean | false | |
defaultValue | The default value of the textarea, appearing when the component first renders. | string | undefined | undefined | |
label | The label for the textarea, displayed above it. | string | '' | |
maxLength | The maximum number of characters allowed in the textarea. | number | 255 | |
name | The name of the textarea, important for form submissions. | string | 'textarea' | |
placeholder | Placeholder text shown in the textarea when it is empty. | string | '' | |
readOnly | If true, the textarea cannot be edited by the user. | boolean | false | |
required | Specifies if the textarea is required for form submission. If true, an error message shows if left empty. | boolean | false | |
tooltip | The content of the label’s tooltip | string | '' | |
type | The type | string | 'multi_line_text' |
Events
Event | Description | Type |
---|---|---|
nylasFormInputChanged | Event 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
Part | Description |
---|---|
"tc__label" | The label for the textarea. |
"tc__textarea" | The textarea element. |
Built with StencilJS