TextArea Field

The TextArea Field component provides a multi-line text input for collecting longer text content from users, such as descriptions, comments, or notes.

Basic Usage

Custom Rows

Required Field

Field Schema

A textarea field is authored as TextareaFieldMetadata (@object-ui/types), which is the source of truth for the key set: it extends BaseFieldMetadata with the length bounds and the editor's visible row count.

import type { TextareaFieldMetadata } from '@object-ui/types';

const description: TextareaFieldMetadata = {
  type: 'textarea',
  name: 'description',
  label: 'Description',
  placeholder: 'Describe this record…',
  rows: 6,
  required: false,
  min_length: 0,
  max_length: 2000,
};

The value being edited, and the className / disabled a host supplies, are not metadata keys — they are runtime widget props. See Field Widget Props.

Use Cases

• Descriptions: Product descriptions, bio information
• Comments: User feedback, review comments
• Notes: Meeting notes, task descriptions
• Messages: Contact form messages, support tickets

Cell Renderer

When displayed in tables or grids, long text is truncated:

import { TextCellRenderer } from '@object-ui/fields';

// Same renderer as text field - truncates long content