Design Tokens

Utilities

Accordion

Actionable

Overlay

Hooks

useResponsiveClientValue

Text area

Form field to enter and edit multiline text.

Import

import { TextArea } from "reshaped";
import type { TextAreaProps } from "reshaped";

Related components

Text Field

Storybook

Text area stories

Full keyboard navigation support

Can be controlled and uncontrolled

Automatic integration with FormControl utility

Usage

Form fields have a required name property, so that's the only property you have to pass to TextArea to start using it. If you need to handle its change events - add an onChange property to it.


<TextArea
  name="email"
  placeholder="Enter your email"
  onChange={(args) => console.log(args)}
/>

Same as when using native inputs in React, TextArea can be used as a controlled or uncontrolled component. By default, TextArea is uncontrolled and lets you define its default value using the defaultValue property. In this case, all change events are handled automatically. This approach is helpful when you're pre-filling a form from a data source, but you don't need to control the further behavior of the input.


<TextArea
  name="email"
  placeholder="your.email@gmail.com"
  defaultValue="reshaped.example@gmail.com"
/>

If you need to control the state of the field manually, you can use the value property. That will give you complete control of the component value and will stop handling the value automatically. You will have to update the state using the onChange handler and will be able to add custom logic before that happens.


<TextArea
  name="email"
  placeholder="your.email@gmail.com"
  value="reshaped.example@gmail.com"
  onChange={({ value }) => {
    /* Update your state here */
  }}
/>

Sizes

TextArea comes in 3 sizes, with the medium size used by default. All sizes are aligned with the paddings of other input components like TextField or Select.


<View gap={3}>
  <TextArea name="desc" size="medium" placeholder="Enter the description" />
  <TextArea name="desc" size="large" placeholder="Enter the description" />
  <TextArea name="desc" size="xlarge" placeholder="Enter the description" />
</View>

TextField supports responsive syntax for its size property, which means you can change its size based on the viewport.


<TextArea
  name="desc"
  size={{ s: "medium", l: "xlarge" }}
  placeholder="Enter the description"
/>

Variants

If you want to alternate the styles of the select, you can use its faded variant.


<TextArea name="desc" placeholder="Enter the description" variant="faded" />

Otherwise, you can also use the headless variant which removes most of the styles from the select and lets you use it for custom layouts.


<TextArea name="desc" placeholder="Enter the description" variant="unstyled" />

Since headless variant removes the horizontal padding, you might want to add it yourself with a custom wrapper for the select that would expand the clickable area.
headless variant removes the focused and error outline since most of the time you would want to display them in a different place. You can use :focus-within selector in your css to implement the focus state.

States

You can use hasError property to show the user that TextArea is not passing the form validation.


<TextArea name="desc" hasError />

You can disable TextArea with the disabled flag. However, remember that disabling the field will remove it from the form submit query.


<TextArea name="desc" disabled />

Using with FormControl

To let the user know what data you expect them to type in, add labels or status messages to your fields with the help of the FormControl utility. In case you're using xlarge TextArea size, you can also combine it with the large FormControl size for better visual alignment.

Note: Don't use placeholders as labels for the fields as users won't see the placeholder when input contains a value.


<FormControl>
  <FormControl.Label>Email</FormControl.Label>
  <TextArea name="name" placeholder="example@gmail.com" />
</FormControl>

FormControl

Related utility

Composition

When using the headless TextArea, you can align its text content with the rest of the page with TextArea.Aligner utility which will adjust the space automatically based on the size of the TextArea and the padding value it uses. By default it applies negative margins on all sides of the field, but you can control that with the side propery of the aligner.


<View gap={2}>
  <Text variant="featured-3" weight="bold">
    Create a new post
  </Text>

  <TextArea.Aligner>
    <TextArea
      variant="headless"
      placeholder="Tell us your story"
      name="content"
    />
  </TextArea.Aligner>
</View>

Accessibility

When using TextArea without a label - make sure to provide a text description. You can either provide the label by using the FormControl utility or by passing inputAttributes={{ 'aria-label': 'Your label' }} to the component if you don't want to display it visually.


<TextArea attributes={{ "aria-label": "Description" }} />

Tabs