Skip to main content AWT

Text area

A multi-line text field with a label, helper text, and error, warning, and read-only states.

Live example

These are real Text area blocks rendering on this page right now. Tab to them and try them in both color schemes.

Up to 200 characters.
Cannot be empty.
Looks unusual.

Dark mode you don’t have to build

Every block supports dark mode. Use the light/dark toggle in the header and the live example above switches with it.

Parameters

Everything the Text area block accepts. Setting is the label you see in the block’s settings panel. Parameter is what the same value is called in code. Accepts is what you can put in it.

Text area block parameters
SettingParameterTypeDefaultAcceptsWhat it does
Typed on the blocklabelstring“Description”Any textThe visible label. Screen readers announce it too, so make it say what the control does.
NamenamestringemptyAny textThe field name submitted with the form.
PlaceholderplaceholderstringemptyAny textGhost text inside the empty field. Never use it instead of a label.
Default valuevaluestringemptyAny textPre-filled content.
Rowsrowsnumber4A numberThe visible height, in lines.
Columns (0 = auto)colsnumber0A numberThe visible width, in characters.
Helper texthelperTextstringemptyAny textA short hint under the control, linked to it for screen readers.
Invalidinvalidbooleanfalsetrue or falseRenders the error state.
Invalid messageinvalidTextstringemptyAny textThe error message. It is announced to screen readers, not just colored red.
Warningwarnbooleanfalsetrue or falseRenders the warning state: something needs attention but does not block submission.
Warning messagewarnTextstringemptyAny textThe warning message shown and announced in the warning state.
Disableddisabledbooleanfalsetrue or falseRenders the disabled state. Disabled controls are skipped by keyboard focus, so prefer hiding over disabling when you can.
Read-onlyreadonlybooleanfalsetrue or falseMakes the field read-only: visible and focusable, but not editable.
Requiredrequiredbooleanfalsetrue or falseMarks the field as required, in the markup and for screen readers. Following Carbon, a required field shows no mark: when most fields in a form are required, add (optional) to the labels of the others.
Max lengthmaxlengthnumber0A numberThe maximum number of characters accepted.
Visually hide labelhideLabelbooleanfalsetrue or falseVisually hides the label while keeping it for screen readers. Use only when the context makes the purpose obvious.
Carbon defaultcarbonDefaultbooleanfalsetrue or falseUses Carbon’s own field look (a shaded fill with one line under the text) instead of AWT’s default border on all four sides.

Accessibility parameters, on this and every AWT block

Every AWT block has an Accessibility panel in its settings. Each control in it becomes a real HTML attribute on the block’s outer element:

Accessibility parameters shared by every AWT block
SettingParameterWhat it does
Accessible name (aria-label)ariaLabelBecomes aria-label on the block’s outer element. Replaces the accessible name screen readers announce. Set it only when the visible label is not enough.
Described by (aria-describedby)ariaDescribedbyBecomes aria-describedby. Point it at the ID of another element on the page whose text adds a longer description.
Labelled by (aria-labelledby)ariaLabelledbyBecomes aria-labelledby. Point it at the ID of another element whose text should become this block’s accessible name.
RoleawtRoleBecomes the role attribute. Overrides the element’s ARIA role. The list offers only roles that suit the element.
Language (lang)awtLangBecomes the lang attribute. Set it when this block’s content is in a different language from the page, as a BCP-47 code like “fr”.