Text field

Use field.Text for a short, unformatted string: a title, name, reference code, or single-line summary. It produces a string in generated Go, TypeScript, REST, and OpenAPI contracts and a single-line control in the admin.

In the admin

Changing its label affects only the editor; changing title changes the stored and API path.

Smallest working example

field.Text("title", field.Required())

The document property is title. Authors see a label derived from that name unless you provide field.Label("Post title").

Validation and options

field.Text(
  "sku",
  field.Required(),
  field.MinLength(3),
  field.MaxLength(32),
  field.Unique(),
  field.Index(),
  field.Description("The identifier used by fulfilment."),
)

MinLength and MaxLength count the submitted string. Required rejects missing, null, and empty values. Unique is collection-wide and should describe a real business invariant; Index is for a field you regularly filter or sort. Default, Localized, ReadOnly, Hidden, Sidebar, Columns, conditions, labels, descriptions, placeholders, and a paired AdminComponent are also compatible.

Presentation options do not grant access. Protect sensitive strings with field access rules even when the admin hides or disables the control.

Querying and localization

Text fields support string operators such as equality, containment, and like, plus sorting and selection. Use the canonical field path (title or seo.title) in Local API and REST queries; the generated SDK exposes that path in its where type.

field.Localized() stores one value per configured content locale. Required and unique checks are evaluated per locale, and reads obey the request’s locale and fallback chain. Do not add Localized merely to translate the admin label—use LabelTranslations for interface copy.

Common mistakes

• Use Textarea for multi-line plain text and Rich text for formatted documents.
• A field rename changes stored data and generated APIs. Create a reviewed migration instead of changing the string literal casually.
• ReadOnly and Hidden affect only the admin. They do not prevent API writes.
• For an automatically generated URL identifier, use Slug rather than rebuilding slug hooks around a plain text field.

See field.Text and the shared field options.