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.1.0 |
Install (React) | npm install @nylas/react |
Import (React) | import { TextareaComponent } from '@nylas/react'; |
Properties
Property | Attribute | Description | Type | Default |
---|---|---|---|---|
autoFocus | auto-focus | Automatically focus the textarea when the component loads. | boolean | false |
defaultValue | default-value | The default value of the textarea, appearing when the component first renders. | string | undefined | undefined |
label | label | The label for the textarea, displayed above it. | string | '' |
maxLength | max-length | The maximum number of characters allowed in the textarea. | number | 255 |
name | name | The name of the textarea, important for form submissions. | string | 'textarea' |
placeholder | placeholder | Placeholder text shown in the textarea when it is empty. | string | '' |
readOnly | read-only | If true, the textarea cannot be edited by the user. | boolean | false |
required | required | Specifies if the textarea is required for form submission. If true, an error message shows if left empty. | boolean | false |
tooltip | tooltip | The content of the label’s tooltip | string | '' |
type | 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