Textarea Component Component - Scheduler UI Components

Textarea Component Component - Scheduler UI Components

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	`2.1.0`
Install (React)	`npm install @nylas/react`
Import (React)	`import { TextareaComponent } from '@nylas/react';`
Import (CDN)	You do not need to individually import the component, just import the parent component either `nylas-scheduling` or `nylas-scheduler-editor`.

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`
`errorMessage`		Error message to display when the textarea is required and empty.	`string`	`''`
`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`
`themeConfig`		The theme configuration.	undefined \| { '--nylas-primary'?: string \| undefined; '--nylas-info'?: string \| undefined; '--nylas-success'?: string \| undefined; '--nylas-warning'?: string \| undefined; '--nylas-error'?: string \| undefined; '--nylas-error-pressed'?: string \| undefined; '--nylas-base-0'?: string \| undefined; '--nylas-base-25'?: string \| undefined; '--nylas-base-50'?: string \| undefined; '--nylas-base-100'?: string \| undefined; '--nylas-base-200'?: string \| undefined; '--nylas-base-300'?: string \| undefined; '--nylas-base-400'?: string \| undefined; '--nylas-base-500'?: string \| undefined; '--nylas-base-600'?: string \| undefined; '--nylas-base-700'?: string \| undefined; '--nylas-base-800'?: string \| undefined; '--nylas-base-900'?: string \| undefined; '--nylas-base-950'?: string \| undefined; '--nylas-color-blue-50'?: string \| undefined; '--nylas-color-blue-100'?: string \| undefined; '--nylas-color-blue-300'?: string \| undefined; '--nylas-color-blue-500'?: string \| undefined; '--nylas-color-blue-700'?: string \| undefined; '--nylas-color-blue-900'?: string \| undefined; '--nylas-color-red-50'?: string \| undefined; '--nylas-color-red-100'?: string \| undefined; '--nylas-color-red-300'?: string \| undefined; '--nylas-color-red-500'?: string \| undefined; '--nylas-color-red-700'?: string \| undefined; '--nylas-color-red-900'?: string \| undefined; '--nylas-color-green-50'?: string \| undefined; '--nylas-color-green-100'?: string \| undefined; '--nylas-color-green-300'?: string \| undefined; '--nylas-color-green-500'?: string \| undefined; '--nylas-color-green-700'?: string \| undefined; '--nylas-color-green-900'?: string \| undefined; '--nylas-color-yellow-50'?: string \| undefined; '--nylas-color-yellow-100'?: string \| undefined; '--nylas-color-yellow-300'?: string \| undefined; '--nylas-color-yellow-500'?: string \| undefined; '--nylas-color-yellow-700'?: string \| undefined; '--nylas-color-yellow-900'?: string \| undefined; '--nylas-color-purple-50'?: string \| undefined; '--nylas-color-purple-100'?: string \| undefined; '--nylas-color-purple-300'?: string \| undefined; '--nylas-color-purple-500'?: string \| undefined; '--nylas-color-purple-700'?: string \| undefined; '--nylas-color-purple-900'?: string \| undefined; '--nylas-color-sky-50'?: string \| undefined; '--nylas-color-sky-100'?: string \| undefined; '--nylas-color-sky-300'?: string \| undefined; '--nylas-color-sky-500'?: string \| undefined; '--nylas-color-sky-700'?: string \| undefined; '--nylas-color-sky-900'?: string \| undefined; '--nylas-color-black'?: string \| undefined; '--nylas-color-grey-900'?: string \| undefined; '--nylas-color-grey-800'?: string \| undefined; '--nylas-color-grey-700'?: string \| undefined; '--nylas-color-grey-600'?: string \| undefined; '--nylas-color-grey-500'?: string \| undefined; '--nylas-color-grey-400'?: string \| undefined; '--nylas-color-grey-300'?: string \| undefined; '--nylas-color-grey-200'?: string \| undefined; '--nylas-color-grey-100'?: string \| undefined; '--nylas-color-grey-50'?: string \| undefined; '--nylas-color-white'?: string \| undefined; '--nylas-font-family'?: string \| undefined; '--nylas-font-size'?: string \| undefined; '--nylas-border-radius'?: string \| undefined; '--nylas-border-radius-2x'?: string \| undefined; '--nylas-border-radius-3x'?: string \| undefined; }	`undefined`
`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