Textarea
Use Textarea for multi-line text input form fields
import {Textarea} from '@primer/react'
Textarea components must always be accompanied by a corresponding label to improve support for assistive technologies. Examples below are provided for conciseness and may not reflect accessibility best practices.
Use the FormControl component to render a Textarea with a corresponding label.
By default, Textarea
can be resized by the user vertically and horizontally. Resizing can be prevented by setting resize
to none
Name | Type | Default | Description |
---|---|---|---|
required | boolean | Indicates to the user and assistive technologies that the field value is required | |
cols | number | Specifies the visible width of a text area. | |
rows | number | Specifies the visible height of a text area. | |
block | boolean | false | Expands with width of the component to fill the parent elements |
resize | 'both' | 'horizontal' | 'vertical' | 'none' | 'both' | Changes background color to a higher contrast color |
validationStatus | 'success' | 'error' | undefined | Style the textarea to match the current form validation status | |
ref | React.RefObject<HTMLTextAreaElement> | A ref to the element rendered by this component. Because this component is polymorphic, the type will vary based on the value of the as prop. | |
ref | React.RefObject<HTMLTextareaElement> | A ref to the element rendered by this component. Because this component is polymorphic, the type will vary based on the value of the as prop. | |
as | React.ElementType | "input" | The underlying element to render — either a HTML element name or a React component. |
sx | SystemStyleObject | Style overrides to apply to the component. See also overriding styles. |