Textarea
<ahi-textarea> | AhiTextarea
Textareas collect data from the user and allow multiple lines of text.
Use the label attribute to give the textarea an accessible label. For labels that contain HTML,
use the label slot instead.
<ahi-textarea label="Comments"></ahi-textarea>
This component works with standard <form> elements. Please refer to the section on
form controls to learn more about form submission
and client-side validation.
Examples
Help text
Add descriptive help text to a textarea with the help-text attribute. For help texts that
contain HTML, use the help-text slot instead.
<ahi-textarea label="Feedback" help-text="Please tell us what you think."></ahi-textarea>
Rows
Use the rows attribute to change the number of text rows that get shown.
<ahi-textarea label="Two rows" rows="2"></ahi-textarea>
Placeholders
Use the placeholder attribute to add a placeholder.
<ahi-textarea label="Comments" placeholder="Type something"></ahi-textarea>
Disabled
Use the disabled attribute to disable a textarea.
<ahi-textarea label="Disabled" placeholder="Type something" disabled></ahi-textarea>
Prevent resizing
By default, textareas can be resized vertically by the user. To prevent resizing, set the
resize attribute to none.
<ahi-textarea label="No resize" resize="none"></ahi-textarea>
Expand with content
Textareas will automatically expand to fit their content when resize is set to
auto.
<ahi-textarea label="Auto resize" resize="auto"></ahi-textarea>
Character Count
Use to show the character count of the input. If the textarea also has a maxlength attribute,
the number of characters left will be displayed.
<ahi-textarea label="With max length" character-count maxlength="25"></ahi-textarea>
<ahi-textarea label="Without max length" character-count></ahi-textarea>
Importing
To import this component using a script tag:
<script type="module" src="/path/to/azalea-kit-ui/dist/components/textarea/textarea.js"></script>To import this component using a bundler:
import '@azaleahealth/azalea-kit-ui/dist/components/textarea/textarea.js';Slots
| Name | Description |
|---|---|
label
|
The textarea’s label. Alternatively, you can use the label attribute. |
help-text
|
Text that describes how to use the input. Alternatively, you can use the
help-text attribute.
|
error
|
An error message shown once the control is invalid. Plain text can be set with the
error property instead; use this slot when the message needs markup.
|
Learn more about using slots.
Properties
| Name | Description | Type | Default | |
|---|---|---|---|---|
error
|
An error message to show on the control. Setting it makes the control genuinely invalid: it enters
the user-invalid state, matches :invalid, and blocks native form
submission — which is what a consumer binding a server-side rejection expects. Clearing it clears
that validity. Use the error slot instead when the message needs markup rather than
plain text.
|
string
|
''
|
|
autocapitalize
|
Controls whether and how text input is automatically capitalized as it is entered by the user. |
'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'
|
- | |
autocomplete
|
Specifies what permission the browser has to provide assistance in filling out form field values. Refer to this page on MDN for available values. |
string
|
- | |
autocorrect
|
Indicates whether the browser’s autocorrect feature is on or off. As an attribute, use
"on" or "off"; as a property it is a boolean, matching the platform’s
autocorrect IDL attribute.
|
boolean
|
- | |
autofocus
|
Indicates that the input should receive focus on page load. |
boolean
|
- | |
characterCount
character-count
|
Enables a character count display under the input. |
boolean
|
false
|
|
defaultValue
|
The default value of the form control. Primarily used for resetting the form control. |
string
|
''
|
|
disabled
|
Disables the textarea. |
boolean
|
false
|
|
enterkeyhint
|
Used to customize the label or icon of the Enter key on virtual keyboards. |
'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'
|
- | |
helpText
help-text
|
The textarea’s help text. If you need to display HTML, use the help-text
slot instead.
|
string
|
''
|
|
inputmode
|
Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual keyboard on supportive devices. |
'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'
|
- | |
label
|
The textarea’s label. If you need to display HTML, use the label slot instead. |
string
|
''
|
|
maxlength
|
The maximum length of input that will be considered valid. |
number
|
- | |
minlength
|
The minimum length of input that will be considered valid. |
number
|
- | |
name
|
The name of the textarea, submitted as a name/value pair with form data. |
string
|
''
|
|
placeholder
|
Placeholder text to show as a hint when the input is empty. |
string
|
''
|
|
readonly
|
Makes the textarea readonly. |
boolean
|
false
|
|
required
|
Makes the textarea a required field. |
boolean
|
false
|
|
resize
|
Controls how the textarea can be resized. |
'none' | 'vertical' | 'auto'
|
'vertical'
|
|
rows
|
The number of rows to display by default. |
number
|
4
|
|
spellcheck
|
Enables spell checking on the textarea. |
boolean
|
true
|
|
value
|
The current value of the textarea, submitted as a name/value pair with form data. |
string
|
''
|
|
validity
|
Gets the validity state object | - | - | |
validationMessage
|
Gets the validation message | - | - | |
formId
form
|
By default, form controls are associated with the nearest containing
<form> element. This attribute allows you to place the form control outside of a
form and associate it with the form that has this id. The form must be in the same
document or shadow root for this to work.
|
string
|
''
|
|
form
|
The form the control is associated with, following the native form-control contract: reading returns
the associated <form> element (or null if there is none), assigning
takes a form id — assign an empty string to restore association with the nearest containing form.
|
HTMLFormElement | null
|
- | |
updateComplete |
A read-only promise that resolves when the component has finished updating. |
Learn more about properties and attributes.
Events
| Name | Description | Event Detail |
|---|---|---|
ahi-blur |
Emitted when the control loses focus. | - |
ahi-change |
Emitted when an alteration to the control’s value is committed by the user. | - |
ahi-focus |
Emitted when the control gains focus. | - |
ahi-input |
Emitted when the control receives input. | - |
ahi-invalid |
Emitted when the form control has been checked for validity and its constraints aren’t satisfied. | - |
Learn more about events.
Methods
| Name | Description | Arguments |
|---|---|---|
focus() |
Sets focus on the textarea. |
options: FocusOptions
|
blur() |
Removes focus from the textarea. | - |
select() |
Selects all the text in the textarea. | - |
scrollPosition() |
Gets or sets the textarea’s scroll position. |
position: { top?: number; left?: number }
|
setSelectionRange() |
Sets the start and end positions of the text selection (0-based). |
selectionStart: number, selectionEnd: number, selectionDirection: 'forward' | 'backward' | 'none'
|
setRangeText() |
Replaces a range of text with a new string. |
replacement: string, start: number, end: number, selectMode: 'select' | 'start' | 'end' |
'preserve'
|
checkValidity() |
Checks for validity but does not show a validation message. Returns true when valid and
false when invalid.
|
- |
reportValidity() |
Checks for validity and shows the browser’s validation message if the control is invalid. | - |
setCustomValidity() |
Sets a custom validation message. If message is not empty, the field will be considered
invalid.
|
message: string
|
resetValidity() |
Hides validity again, returning the control to its pristine state: it stops matching
:user-invalid and drops its error styling until the user next interacts with it. The
value and the validity are both untouched — an empty required control is still invalid and still
blocks submission. This only changes whether that invalidity is shown. Interaction state
otherwise has exactly one automatic exit, form.reset(). Call this when the application
replaces a value itself and the old error no longer describes anything the user did: loading a
draft, switching which record is being edited, or clearing a filter row.
|
- |
Learn more about methods.
CSS Parts
| Name | Description |
|---|---|
base |
Deprecated. Use the textarea-wrapper part instead. |
textarea-wrapper |
The component’s outer wrapper. |
character-count |
The character count. |
form-control |
The form control that wraps the label, input, and help text. |
form-control-label |
The label’s wrapper. |
form-control-input |
The input’s wrapper. |
form-control-help-text |
The help text’s wrapper. |
form-control-error |
The error’s wrapper. |
textarea |
The internal <textarea> control. |
textarea-adjuster |
The hidden element used to auto-size the control when resize="auto". This control
inherits setCustomValidity(message), checkValidity() and
reportValidity() from the form-control base class. Because they are inherited rather
than declared here, they do not appear in this component’s generated type definitions – which is why
they are easy to conclude do not exist. They do, and they work.
|
Learn more about customizing CSS parts.
Dependencies
This component automatically imports the following dependencies.
<ahi-icon>