Textarea Field

The Textarea Field is nearly identical to the Text Field but it features a slightly larger input that is better suited to edit longer text.

Admin Panel screenshot of a Textarea field and read-only Textarea field

To add a Textarea Field, set the type to textarea in your Field Config:

1import type { Field } from 'payload'
2
3export const MyTextareaField: Field = {
4  // ...
5  type: 'textarea', 
6}

Config Options

Option	Description
`name` *	To be used as the property name when stored and retrieved from the database. More
`label`	Text used as a field label in the Admin Panel or an object with keys for each language.
`unique`	Enforce that each entry in the Collection has a unique value for this field.
`minLength`	Used by the default validation function to ensure values are of a minimum character length.
`maxLength`	Used by the default validation function to ensure values are of a maximum character length.
`validate`	Provide a custom validation function that will be executed on both the Admin Panel and the backend. More
`index`	Build an index for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often.
`saveToJWT`	If this field is top-level and nested in a config supporting Authentication, include its data in the user JWT.
`hooks`	Provide Field Hooks to control logic for this field. More details.
`access`	Provide Field Access Control to denote what users can see and do with this field's data. More details.
`hidden`	Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin Panel.
`defaultValue`	Provide data to be used for this field's default value. More
`localized`	Enable localization for this field. Requires localization to be enabled in the Base config.
`required`	Require this field to have a value.
`admin`	Admin-specific configuration. More details.
`custom`	Extension point for adding custom data (e.g. for plugins)
`typescriptSchema`	Override field type generation with providing a JSON schema
`virtual`	Provide `true` to disable field in the database. See Virtual Fields

* An asterisk denotes that a property is required.

Admin Options

The customize the appearance and behavior of the Textarea Field in the Admin Panel, you can use the admin option:

1import type { Field } from 'payload'
2
3export const MyTextareaField: Field = {
4  // ...
5  admin: { 
6    // ...
7  },
8}

The Textarea Field inherits all of the default options from the base Field Admin Config, plus the following additional options:

Option	Description
`placeholder`	Set this property to define a placeholder string in the textarea.
`autoComplete`	Set this property to a string that will be used for browser autocomplete.
`rows`	Set the number of visible text rows in the textarea. Defaults to `2` if not specified.
`rtl`	Override the default text direction of the Admin Panel for this field. Set to `true` to force right-to-left text direction.

Example

collections/ExampleCollection.ts

1import type { CollectionConfig } from 'payload'
2
3export const ExampleCollection: CollectionConfig = {
4  slug: 'example-collection',
5  fields: [
6    {
7      name: 'metaDescription', // required
8      type: 'textarea', // required
9      required: true,
10    },
11  ],
12}

Custom Components

Field

Server Component

1import type React from 'react'
2import { TextareaField } from '@payloadcms/ui'
3import type { TextareaFieldServerComponent } from 'payload'
4
5export const CustomTextareaFieldServer: TextareaFieldServerComponent = ({
6  clientField,
7  path,
8  schemaPath,
9  permissions,
10}) => {
11  return (
12    <TextareaField
13      field={clientField}
14      path={path}
15      schemaPath={schemaPath}
16      permissions={permissions}
17    />
18  )
19}

Client Component

1'use client'
2import React from 'react'
3import { TextareaField } from '@payloadcms/ui'
4import type { TextareaFieldClientComponent } from 'payload'
5
6export const CustomTextareaFieldClient: TextareaFieldClientComponent = (props) => {
7  return <TextareaField {...props} />
8}

Label

Server Component

1import React from 'react'
2import { FieldLabel } from '@payloadcms/ui'
3import type { TextareaFieldLabelServerComponent } from 'payload'
4
5export const CustomTextareaFieldLabelServer: TextareaFieldLabelServerComponent = ({
6  clientField,
7  path,
8}) => {
9  return (
10    <FieldLabel
11      label={clientField?.label || clientField?.name}
12      path={path}
13      required={clientField?.required}
14    />
15  )
16}

Client Component

1'use client'
2import React from 'react'
3import { FieldLabel } from '@payloadcms/ui'
4import type { TextareaFieldLabelClientComponent } from 'payload'
5
6export const CustomTextareaFieldLabelClient: TextareaFieldLabelClientComponent = ({
7  field,
8  path,
9}) => {
10  return (
11    <FieldLabel
12      label={field?.label || field?.name}
13      path={path}
14      required={field?.required}
15    />
16  )
17}

See what others are building with Payload.

"Payload has transformed the way our clients manage content. It's an indispensable tool for any modern agency."

Deploy your entire stack in one place with Payload Cloud.

Microsoft chose Payload to tell the world about AI.

Textarea Field

Config Options

Admin Options

Example

Custom Components

Field

Server Component

Client Component

Label

Server Component

Client Component

UI Field