# kol-textarea

<!-- Auto Generated Below -->


## Overview

The **Textarea** component provides a larger input field for content. Unlike InputText, it also allows extensive content to be entered, including line breaks.

## Properties

| Property              | Attribute              | Description                                                                                                                                                                                                                                                                                        | Type                                                                                                                               | Default      |
| --------------------- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| `_accessKey`          | `_access-key`          | Defines the key combination that can be used to trigger or focus the component's interactive element.                                                                                                                                                                                              | `string \| undefined`                                                                                                              | `undefined`  |
| `_adjustHeight`       | `_adjust-height`       | Adjusts the height of the element to its content.                                                                                                                                                                                                                                                  | `boolean \| undefined`                                                                                                             | `false`      |
| `_disabled`           | `_disabled`            | Makes the element not focusable and ignore all events.                                                                                                                                                                                                                                             | `boolean \| undefined`                                                                                                             | `false`      |
| `_hasCounter`         | `_has-counter`         | Shows a character counter for the input element.                                                                                                                                                                                                                                                   | `boolean \| undefined`                                                                                                             | `false`      |
| `_hideLabel`          | `_hide-label`          | Hides the caption by default and displays the caption text with a tooltip when the interactive element is focused or the mouse is over it.                                                                                                                                                         | `boolean \| undefined`                                                                                                             | `false`      |
| `_hideMsg`            | `_hide-msg`            | Hides the error message but leaves it in the DOM for the input's aria-describedby.                                                                                                                                                                                                                 | `boolean \| undefined`                                                                                                             | `false`      |
| `_hint`               | `_hint`                | Defines the hint text.                                                                                                                                                                                                                                                                             | `string \| undefined`                                                                                                              | `''`         |
| `_icons`              | `_icons`               | Defines the icon classnames (e.g. `_icons="fa-solid fa-user"`).                                                                                                                                                                                                                                    | `string \| undefined \| { right?: IconOrIconClass \| undefined; left?: IconOrIconClass \| undefined; }`                            | `undefined`  |
| `_label` _(required)_ | `_label`               | Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.). Set to `false` to enable the expert slot.                                                                                                                                       | `string`                                                                                                                           | `undefined`  |
| `_maxLength`          | `_max-length`          | Defines the maximum number of input characters.                                                                                                                                                                                                                                                    | `number \| undefined`                                                                                                              | `undefined`  |
| `_maxLengthBehavior`  | `_max-length-behavior` | Defines the behavior when maxLength is set. 'hard' sets the maxlength attribute, 'soft' shows a character counter without preventing input.                                                                                                                                                        | `"hard" \| "soft" \| undefined`                                                                                                    | `'hard'`     |
| `_msg`                | `_msg`                 | Defines the properties for a message rendered as Alert component.                                                                                                                                                                                                                                  | `Omit<AlertProps, "_on" \| "_label" \| "_level" \| "_variant" \| "_hasCloser"> & { _description: string; } \| string \| undefined` | `undefined`  |
| `_name`               | `_name`                | Defines the technical name of an input field.                                                                                                                                                                                                                                                      | `string \| undefined`                                                                                                              | `undefined`  |
| `_on`                 | --                     | Gibt die EventCallback-Funktionen für das Input-Event an.                                                                                                                                                                                                                                          | `InputTypeOnBlur & InputTypeOnClick & InputTypeOnChange & InputTypeOnFocus & InputTypeOnInput & InputTypeOnKeyDown \| undefined`   | `undefined`  |
| `_placeholder`        | `_placeholder`         | Defines the placeholder for input field. To be shown when there's no value.                                                                                                                                                                                                                        | `string \| undefined`                                                                                                              | `undefined`  |
| `_readOnly`           | `_read-only`           | Makes the input element read only.                                                                                                                                                                                                                                                                 | `boolean \| undefined`                                                                                                             | `false`      |
| `_required`           | `_required`            | Makes the input element required.                                                                                                                                                                                                                                                                  | `boolean \| undefined`                                                                                                             | `false`      |
| `_resize`             | `_resize`              | Defines whether and in which direction the size of the input can be changed by the user. (https://developer.mozilla.org/de/docs/Web/CSS/resize) In version 3 (v3), horizontal resizing is abolished. The corresponding property is then reduced to the properties `vertical` (default) and `none`. | `"none" \| "vertical" \| undefined`                                                                                                | `'vertical'` |
| `_rows`               | `_rows`                | Maximum number of visible rows of the element.                                                                                                                                                                                                                                                     | `number \| undefined`                                                                                                              | `undefined`  |
| `_shortKey`           | `_short-key`           | Adds a visual shortcut hint after the label and instructs the screen reader to read the shortcut aloud.                                                                                                                                                                                            | `string \| undefined`                                                                                                              | `undefined`  |
| `_spellCheck`         | `_spell-check`         | Defines whether the browser should check the spelling and grammar.                                                                                                                                                                                                                                 | `boolean \| undefined`                                                                                                             | `undefined`  |
| `_tooltipAlign`       | `_tooltip-align`       | Defines where to show the Tooltip preferably: top, right, bottom or left.                                                                                                                                                                                                                          | `"bottom" \| "left" \| "right" \| "top" \| undefined`                                                                              | `'top'`      |
| `_touched`            | `_touched`             | Shows if the input was touched by a user.                                                                                                                                                                                                                                                          | `boolean \| undefined`                                                                                                             | `false`      |
| `_value`              | `_value`               | Defines the value of the element.                                                                                                                                                                                                                                                                  | `string \| undefined`                                                                                                              | `undefined`  |
| `_variant`            | `_variant`             | Defines which variant should be used for presentation.                                                                                                                                                                                                                                             | `string \| undefined`                                                                                                              | `undefined`  |


## Methods

### `click() => Promise<void>`

Clicks the primary interactive element inside this component.

#### Returns

Type: `Promise<void>`



### `focus(options?: KolFocusOptions) => Promise<void>`

Sets focus on the internal element.

#### Parameters

| Name      | Type                           | Description |
| --------- | ------------------------------ | ----------- |
| `options` | `KolFocusOptions \| undefined` |             |

#### Returns

Type: `Promise<void>`



### `getValue() => Promise<string | undefined>`

Returns the current value.

#### Returns

Type: `Promise<string | undefined>`




## Slots

| Slot | Description                   |
| ---- | ----------------------------- |
|      | The label of the input field. |


----------------------------------------------


