@public-ui/components
Version:
Contains all web components that belong to KoliBri - The accessible HTML-Standard.
70 lines (44 loc) • 20.5 kB
Markdown
# kol-textarea
<!-- Auto Generated Below -->
## Properties
| Property | Attribute | Description | Type | Default |
| --------------------- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| `_accessKey` | `_access-key` | Defines which key combination can be used to trigger or focus the interactive element of the component. | `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` |
| `_id` | `_id` | Defines the internal ID of the primary component element. | `string \| 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. | `string \| undefined \| {} & { _level?: 0 \| 2 \| 1 \| 4 \| 3 \| 5 \| 6 \| undefined; _on?: KoliBriAlertEventCallbacks \| undefined; _label?: string \| undefined; _alert?: boolean \| undefined; _hasCloser?: boolean \| undefined; _type?: "default" \| "info" \| "success" \| "warning" \| "error" \| undefined; _variant?: "card" \| "msg" \| undefined; } & { _description: string; }` | `undefined` |
| `_name` | `_name` | Defines the technical name of an input field. | `string \| undefined` | `undefined` |
| `_on` | `_on` | Gibt die EventCallback-Funktionen für das Input-Event an. | `InputTypeOnBlur & InputTypeOnClick & InputTypeOnChange & InputTypeOnFocus & InputTypeOnInput \| 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` | Defines how many rows of text should be visible at the same time. | `number \| undefined` | `undefined` |
| `_shortKey` | `_short-key` | Adds a visual short key hint to the component. | `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 input. | `string \| undefined` | `undefined` |
## Methods
### `getValue() => Promise<string | undefined>`
Returns the current value.
#### Returns
Type: `Promise<string | undefined>`
### `kolFocus() => Promise<void>`
Sets focus on the internal element.
#### Returns
Type: `Promise<void>`
## Slots
| Slot | Description |
| ---- | ----------------------------------- |
| | Die Beschriftung des Eingabefeldes. |
----------------------------------------------