@app-studio/components

TextArea

A text input field for multi-line text editing with customizable features.

Import

import { TextArea } from '@app-studio/components';

New to the library? Complete installation and provider setup first.

Interactive examples

Try the component, then open Code to copy the complete example.

Loading preview…

import React from 'react';

import { TextArea } from '@app-studio/components';

export const DefaultArea = () => (
  <TextArea name="comments" placeholder="Enter your thoughts" />
);

Props

Required props are marked below. A dash indicates an unspecified default. Design system configuration can override implementation defaults.

Scroll horizontally to see every column.

TextArea
Prop	Type	Default	Description
`defaultValue`	`string`	`—`	Initial value for uncontrolled usage.Source
`error`	`boolean`	`—`	Error state — usually a string for the error message, or a boolean toggle.Source
`isEditable`	`boolean`	`true`	See the type and source declaration for this property.Source
`helperText`	`string`	`—`	Helper text rendered below the input (hint / error / explanation).Source
`id`	`string`	`—`	See the type and source declaration for this property.Source
`isReadOnly`	`boolean`	`false`	Keeps the value visible without allowing edits.Source
`isDisabled`	`boolean`	`false`	Disables user interaction.Source
`isAutoFocus`	`boolean`	`false`	See the type and source declaration for this property.Source
`label`	`string`	`—`	Visible label rendered alongside the input. Form-library wrappers (Switch, TextField, Checkbox, …) consume this. Not a native HTML attribute on <input>, but conventionally part of the form-control prop surface.Source
`maxRows`	`number`	`3`	See the type and source declaration for this property.Source
`maxCols`	`number`	`30`	See the type and source declaration for this property.Source
`name`	`string`	`—`	Field name used by forms and Formik bindings.Source
`placeholder`	`string`	`—`	Hint displayed while the field is empty.Source
`onChange`	`((value: string) => void)`	`—`	Called when the value changes, with the value itself — not the DOM event. TextArea follows the value-first convention this package already exposes through `onChangeText`, so there is no `event.target` to read: onChange={(value) => setBody(value)} // ✅ onChange={(e) => setBody(e.target.value)} // ❌ compile error The parameter is deliberately typed `string` rather than `any`: a DOM-shaped handler is an API mistake, and typing it makes that mistake a compile error instead of a field that silently never updates.Source
`onChangeText`	`((text: string) => void)`	`—`	See the type and source declaration for this property.Source
`onBlur`	`((event: any) => void)`	`—`	Called when the field loses focus, with the blur event (not the value).Source
`onFocus`	`(() => void)`	`—`	See the type and source declaration for this property.Source
`size`	`Size` `"sm""md""lg""xs""xl"`	`'sm'`	Size preset for the component.Source
`shadow`	`ViewProps \| Shadow \| Elevation`	`—`	Shadow or elevation styling.Source
`shape`	`Shape` `"square""rounded""pill""default"`	`'default'`	Shape preset for the component.Source
`views`	`TextAreaStyles`	`{ label: {}, helperText: {} }`	Style overrides for the named internal parts.Source
`value`	`string \| number`	`—`	Current controlled value. Update it from the matching change callback.Source
`variant`	`Variant` `"outline""default""none"`	`'default'`	Visual treatment of the component.Source
`rows`	`number`	`—`	See the type and source declaration for this property.Source
`cols`	`number`	`—`	See the type and source declaration for this property.Source
`isRequired`	`boolean`	`—`	Marks this field as required.Source
`required`	`boolean`	`—`	See the type and source declaration for this property.Source
`labelProps`	`any`	`—`	See the type and source declaration for this property.Source
`inputRef`	`((node: { focus: () => void; } \| null) => void)`	`—`	See the type and source declaration for this property.Source

Common inherited styling props (7)

Scroll horizontally to see every column.

TextArea inherited
Prop	Type	Default	Description
`onClick`	`any`	`—`	Called when the user activates the component.
`media`	`Record<string, CssProps>`	`—`	See the type and source declaration for this property.
`as`	`keyof JSX.IntrinsicElements` `"symbol""object""slot""style""title""pattern""form""animate""clipPath""filter""marker""mask""a""abbr""address""area""article""aside""audio""b""base""bdi""bdo""big""blockquote""body""br""button""canvas""caption""center""cite""code""col""colgroup""data""datalist""dd""del""details""dfn""dialog""div""dl""dt""em""embed""fieldset""figcaption""figure""footer""h1""h2""h3""h4""h5""h6""head""header""hgroup""hr""html""i""iframe""img""input""ins""kbd""keygen""label""legend""li""link""main""map""mark""menu""menuitem""meta""meter""nav""noindex""noscript""ol""optgroup""option""output""p""param""picture""pre""progress""q""rp""rt""ruby""s""samp""search""script""section""select""small""source""span""strong""sub""summary""sup""table""template""tbody""td""textarea""tfoot""th""thead""time""tr""track""u""ul""var""video""wbr""webview""svg""animateMotion""animateTransform""circle""defs""desc""ellipse""feBlend""feColorMatrix""feComponentTransfer""feComposite""feConvolveMatrix""feDiffuseLighting""feDisplacementMap""feDistantLight""feDropShadow""feFlood""feFuncA""feFuncB""feFuncG""feFuncR""feGaussianBlur""feImage""feMerge""feMergeNode""feMorphology""feOffset""fePointLight""feSpecularLighting""feSpotLight""feTile""feTurbulence""foreignObject""g""image""line""linearGradient""metadata""mpath""path""polygon""polyline""radialGradient""rect""set""stop""switch""text""textPath""tspan""use""view"`	`—`	See the type and source declaration for this property.
`themeMode`	`"light" \| "dark"` `"light""dark"`	`—`	See the type and source declaration for this property.
`_hover`	`string \| CssProps`	`—`	See the type and source declaration for this property.
`_active`	`string \| CssProps`	`—`	See the type and source declaration for this property.
`_focus`	`string \| CssProps`	`—`	See the type and source declaration for this property.

For shared layout, color, and responsive properties, read Styling & composition and Responsive layouts. Additional native element attributes depend on the target platform.

Usage guidance

Give controls a visible label or an accessible name, and verify keyboard interaction. See Accessibility.
For controlled inputs, update the value from the callback shown in the props table. Keep application state in your component or form library.
These previews run in the browser. Check React Native setup for platform requirements and differences.