Text area API

Import

import { TextArea } from '@cimpress-ui/react';

Controlled/uncontrolled usage

This component can be used in a controlled or uncontrolled way.

In the controlled way, this component doesn’t maintain its own internal state, and its value is provided by the parent component. Use the controlled way when you need to be able to change the state of this component in other parts of your application.

In the uncontrolled way, this component maintains its own internal state, and can optionally notify the parent component when its internal state changes. Use the uncontrolled way when you don’t need to change the state of this component in other parts of your application.

Preview
Code

Feedback (controlled)

Feedback (uncontrolled)

import { TextArea, Stack } from '@cimpress-ui/react';
import { useState } from 'react';

export default function Demo() {
  const [feedback, setFeedback] = useState('Everything is fine.');

  return (
    <Stack gap={32}>
      <TextArea label="Feedback (controlled)" rows={3} value={feedback} onChange={setFeedback} />
      <TextArea label="Feedback (uncontrolled)" rows={3} defaultValue="Everything is fine." />
    </Stack>
  );
}

Imperative API

This component exposes an imperative API through the apiRef prop. This API allows triggering behaviors that can’t be expressed by props.

Preview
Code

Feedback

import { Button, Stack, TextArea, type TextAreaApi } from '@cimpress-ui/react';
import { useRef } from 'react';

export default function Demo() {
  const apiRef = useRef<TextAreaApi>(null);

  return (
    <Stack gap={16}>
      <TextArea label="Feedback" rows={3} defaultValue="Everything is fine." apiRef={apiRef} />

      <Stack gap={16} direction={{ md: 'horizontal' }}>
        <Button onPress={() => apiRef.current?.focus()}>Focus</Button>
        <Button onPress={() => apiRef.current?.select()}>Select contents</Button>
      </Stack>
    </Stack>
  );
}

Accessibility notes

TextArea requires a textual label to remain accessible to assistive technologies. See our accessibility guide for more details.

Forms

Text area can integrate with native HTML forms. See our forms guide to learn how to work with forms.

API reference

TextArea

Allows users to enter multiple lines of text with a keyboard.

See text area usage guidelines.

ref Section titled “ ref ” Ref<HTMLDivElement>: The ref type for this component.

TextAreaProps

autoCapitalize Section titled “ autoCapitalize ” 'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters' | (string & ({ })): Controls whether inputted text is automatically capitalized. See MDN.
autoCorrect Section titled “ autoCorrect ” 'off' | 'on': Controls whether inputted text can be autocorrected by the browser. See MDN.
rows Section titled “ rows ” number: Controls how many lines of text are visible by default. See MDN.
spellCheck Section titled “ spellCheck ” boolean: Controls whether the inputted text may be checked for spelling errors. See MDN.
wrap Section titled “ wrap ” 'soft' | 'hard': Controls how the inputted text will be wrapped for form submission. See MDN.

Defaults to 'soft' .
id Section titled “ id ” string: The element's unique identifier. See MDN.
data-cim-style-root Section titled “ data-cim-style-root ” boolean: Use this attribute to "claim" the component tree for exclusive Cimpress UI usage.
UNSAFE_className Section titled “ UNSAFE_className ” string: Sets the CSS className for the element. Only use as a last resort. Use style props instead.

See styling guide.
UNSAFE_style Section titled “ UNSAFE_style ” CSSProperties: Sets the CSS style for the element. Only use as a last resort. Use style props instead.

See styling guide.
label Section titled “ label ” string: The content to display as the label.
aria-label Section titled “ aria-label ” string: Defines a string value that labels the current element.
aria-labelledby Section titled “ aria-labelledby ” string: Identifies the element (or elements) that labels the current element.
aria-describedby Section titled “ aria-describedby ” string: Identifies the element (or elements) that describes the object.
aria-details Section titled “ aria-details ” string: Identifies the element (or elements) that provide a detailed, extended description for the object.
form Section titled “ form ” string: The <form> element to associate the input with. The value of this attribute must be the id of a <form> in the same document. See MDN.
name Section titled “ name ” string: The name of the input element, used when submitting an HTML form. See MDN.
description Section titled “ description ” string: A description for the field. Provides a hint such as specific requirements for what to choose.
error Section titled “ error ” FieldError: An error message for the field.
validate Section titled “ validate ” (value: string) => string | true | string[] | undefined: A function that returns an error message (or true) if a given value is invalid. Validation errors are displayed to the user when the form is submitted. For real-time validation, use the error prop instead.
placeholder Section titled “ placeholder ” string: The placeholder text displayed in the input field.
apiRef Section titled “ apiRef ” RefObject<TextAreaApi | null>: A React ref that allows access to the imperative API of this component.
autoComplete Section titled “ autoComplete ” string: Describes the type of autocomplete functionality the input should provide if any. See MDN.
maxLength Section titled “ maxLength ” number: The maximum number of characters supported by the input. See MDN.
minLength Section titled “ minLength ” number: The minimum number of characters required by the input. See MDN.
type Section titled “ type ” 'search' | (string & ({ })) | 'text' | 'tel' | 'url' | 'email' | 'password': The type of input to render. See MDN.

Defaults to 'text' .
inputMode Section titled “ inputMode ” 'search' | 'none' | 'text' | 'tel' | 'url' | 'email' | 'numeric' | 'decimal': Hints at the type of data that might be entered by the user while editing the element or its contents. See MDN.
onKeyDown Section titled “ onKeyDown ” (e: KeyboardEvent) => void: Handler that is called when a key is pressed.
onFocus Section titled “ onFocus ” (e: FocusEvent<HTMLInputElement>) => void: Handler that is called when the element receives focus.
onBlur Section titled “ onBlur ” (e: FocusEvent<HTMLInputElement>) => void: Handler that is called when the element loses focus.
autoFocus Section titled “ autoFocus ” boolean: Whether the element should receive focus on render.
isRequired Section titled “ isRequired ” boolean: Whether user input is required on the input before form submission.
isDisabled Section titled “ isDisabled ” boolean: Whether the input is disabled.
isReadOnly Section titled “ isReadOnly ” boolean: Whether the input can be selected but not changed by the user.
value Section titled “ value ” string: The current value (controlled).
defaultValue Section titled “ defaultValue ” string: The default value (uncontrolled).
onChange Section titled “ onChange ” (value: string) => void: Handler that is called when the value changes.
isInvalid Section titled “ isInvalid ” boolean: Whether the value is invalid.

StyleProps

margin Section titled “ margin ” Responsive<Spacing | "auto">: The amount of margin applied to all edges of this component.
marginX Section titled “ marginX ” Responsive<Spacing | "auto">: The amount of margin applied to the left and right edges of this component. Takes priority over margin.
marginY Section titled “ marginY ” Responsive<Spacing | "auto">: The amount of margin applied to the top and bottom edges of this component. Takes priority over margin.
marginTop Section titled “ marginTop ” Responsive<Spacing | "auto">: The amount of margin applied to the top edge of this component. Takes priority over marginY and margin.
marginRight Section titled “ marginRight ” Responsive<Spacing | "auto">: The amount of margin applied to the right edge of this component. Takes priority over marginX and margin.
marginBottom Section titled “ marginBottom ” Responsive<Spacing | "auto">: The amount of margin applied to the bottom edge of this component. Takes priority over marginY and margin.
marginLeft Section titled “ marginLeft ” Responsive<Spacing | "auto">: The amount of margin applied to the left edge of this component. Takes priority over marginX and margin.

Text area API

Import

Controlled/uncontrolled usage

Imperative API

Accessibility notes

Forms

API reference

TextArea

ref

autoCapitalize

autoCorrect

rows

spellCheck

wrap

id

data-cim-style-root

UNSAFE_className

UNSAFE_style

label

aria-label

aria-labelledby

aria-describedby

aria-details

form

name

description

error

validate

placeholder

apiRef

autoComplete

maxLength

minLength

type

inputMode

onKeyDown

onFocus

onBlur

autoFocus

isRequired

isDisabled

isReadOnly

value

defaultValue

onChange

isInvalid

margin

marginX

marginY

marginTop

marginRight

marginBottom

marginLeft