---
title: Text Field
label: Text
order: 180
desc: Text field types simply save a string to the database and provide the Admin panel with a text input. Learn how to use Text fields, see examples and options.
keywords: text, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
---

<Banner>
  The Text field type is one of the most commonly used fields. It saves a string to the database and
  provides the Admin panel with a simple text input.
</Banner>

<LightDarkImage
  srcLight="https://payloadcms.com/images/docs/fields/text.png"
  srcDark="https://payloadcms.com/images/docs/fields/text-dark.png"
  alt="Shows a text field and read-only text field in the Payload admin panel"
  caption="Admin panel screenshot of a Text field and read-only Text field"
/>

## Config

| Option                 | Description                                                                                                                                                                 |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`name`** \*          | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                      |
| **`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](/docs/fields/overview#validation)                                |
| **`index`**            | Build an [index](/docs/database/overview) 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](/docs/authentication/config), include its data in the user JWT.                               |
| **`hooks`**            | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                  |
| **`access`**           | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                     |
| **`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](/docs/fields/overview#default-values)                                                                        |
| **`localized`**        | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                             |
| **`required`**         | Require this field to have a value.                                                                                                                                         |
| **`admin`**            | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                   |
| **`custom`**           | Extension point for adding custom data (e.g. for plugins)                                                                                                                   |
| **`hasMany`**          | Makes this field an ordered array of text instead of just a single text.                                                                                                    |
| **`minRows`**          | Minimum number of texts in the array, if `hasMany` is set to true.                                                                                                          |
| **`maxRows`**          | Maximum number of texts in the array, if `hasMany` is set to true.                                                                                                          |
| **`typescriptSchema`** | Override field type generation with providing a JSON schema                                                                                                                 |

_\* An asterisk denotes that a property is required._

## Admin config

In addition to the default [field admin config](/docs/fields/overview#admin-config), the Text field type allows for the following `admin` properties:

**`placeholder`**

Set this property to define a placeholder string in the text input.

**`autoComplete`**

Set this property to a string that will be used for browser autocomplete.

**`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`

```ts
import { CollectionConfig } from 'payload/types'

export const ExampleCollection: CollectionConfig = {
  slug: 'example-collection',
  fields: [
    {
      name: 'pageTitle', // required
      type: 'text', // required
      required: true,
    },
  ],
}
```