Textarea
Textarea is a component that allows user to write text over multiple rows. Used when the expected user input is long. For shorter input, use the Input component.
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
resize | resize | Controls whether the textarea is resizable. By default is manually resizable vertically. Set to "auto" to enable auto-resizing as content grows. | 'vertical' | 'auto' | 'vertical' |
expand | expand | Controls whether the textarea expands to fill the width of its container. | boolean | false |
maxLength | maxlength | Controls the max allowed length for the textarea. | number | undefined | — |
characterCounter | character-counter | Controls whether to show a count of the number of characters in the textarea. When combined with `maxlength`, both the count and the max length are shown. | boolean | false |
size | size | The size of the component. | 's' | 'm' | 'l' | 'm' |
label | label | Label for the input. | string | '' |
hint | hint | Optional hint text to be displayed with the input. Alternatively use the hint slot. | string | undefined | — |
hideLabel | hide-label | Visually hide the label, but still show it to assistive technologies like screen readers. | boolean | false |
placeholder | placeholder | Placeholder text to display within the input. | string | undefined | — |
error | error | Optional error to be shown with the input. Alternatively use the error slot. | string | undefined | — |
required | required | Determines whether the input is required or not. An input marked as required will be announced as such to users of assistive technology. When using this property you need to also set “novalidate” attribute on a form element to prevent browser from displaying its own validation errors. | boolean | false |
hideRequired | hide-required | Visually hide the required indicator, but still show required attribute to assistive technologies like screen readers. | boolean | false |
autocomplete | autocomplete | Specifies the data type of the field, so that the browser may attempt to fill out the field automatically on behalf of the user. | AutocompleteAttribute | 'off' |
readonly | readonly | Makes the component readonly, so that it is not editable. Readonly differs from disabled in that readonly fields are still focusable and will be submitted with a form. | boolean | false |
disabled | disabled | Makes the component disabled. This prevents users from being able to interact with the component, and conveys its inactive state to assistive technologies. | boolean | false |
name | name | The name of the form component. | string | undefined | — |
value | value | The value of the form component. | string | '' |
form | form | Gets the form, if any, associated with the form element. The setter accepts a string, which is the id of the form. | HTMLFormElement | null | — |
Slots
| Slot name | Description |
|---|---|
label | Use when a label requires more than plain text. |
hint | Optional slot that holds hint text for the textarea. |
error | Optional slot that holds error text for the textarea. |
Methods
| Method name | Parameters | Description |
|---|---|---|
focus(options?: FocusOptions) => void | options: An object which controls aspects of the focusing process. | Programmatically move focus to the component. |
blur() => void | N/A | Programmatically remove focus from the component. |
click() => void | N/A | Programmatically simulates a click on the component. |
| Event | Detail Type | Description |
|---|---|---|
select | NordEvent | Fired when some text has been selected. |
input | NordEvent | Fired as the user types into the input. |
change | NordEvent | Fired whenever the input's value is changed via user interaction. |
CSS Properties
CSS Custom Properties provide more fine grain control over component presentation. We advise utilizing existing properties on the component before using these.
| Property | Description | Default |
|---|---|---|
--n-textarea-inline-size | Controls the inline size, or width, of the textarea. | 240px |
--n-textarea-block-size | Controls the block size, or height, of the textarea. | 76px |
--n-textarea-background | Controls the background of the textarea, using our color tokens. | var(--n-color-active) |
--n-textarea-color | Controls the text color of the textarea, using our color tokens. | var(--n-color-text) |
--n-textarea-border-color | Controls the border color of the textarea, using our color tokens. | var(--n-color-border-strong) |
--n-textarea-border-radius | Controls how rounded the corners are, using border radius tokens. | var(--n-border-radius-s) |
--n-label-color | Controls the text color of the label, using our color tokens. | var(--n-color-text) |
Usage
This section includes guidelines for designers and developers about the usage of this component in different contexts.
Do
- Use to allow text input where the expected input is long.
Don’t
- Don’t use when the expected text input is short. Use input component instead.
Content guidelines
Textarea labels act as a title for the text field. Labels should typically be short and in noun form:
Company name
What is your company name?
When writing textarea labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):
Provide description
Provide Description
When a textarea isn’t part of a form and is placed individually on a page, you could provide the textarea label as a call to action:
Leave a comment
Comment
Do not use colons in textarea labels:
Provide description
Provide description:
Integration
For integration guidelines, please see Web Components documentation .