TextFieldInput

Defined in: packages/core/src/fields/text/types.ts:78

Configuration input for a text() field.

Text fields store short, single-line string values — titles, slugs, URLs, email addresses, status labels, etc. All properties are optional; unset properties fall back to the defaults listed below.

Defaults applied by text():

{
  type:     "text",
  label:    "",       // inferred from the field key by defineCollection
  required: false,    // field is optional by default
  admin: {
    hidden:        false,   // visible in the admin form
    readOnly:      false,   // editable by default
    position:      "main",  // placed in the main content column, not the sidebar
    width:         "100%",  // spans the full form width, not half
    cellAlignment: "left",  // text aligned left in the data table column
  }
}

Example

// Minimal — label is inferred from the key ("Title")
title: text()

// Required slug with length validation and a database index
slug: text({ required: true, min: 3, max: 100, index: "by_slug" })

// Author name with a placeholder hint shown in the admin form
authorName: text({
  required: true,
  admin: { width: "50%", placeholder: "e.g. Jane Smith" }
})

// Pre-filled default for a URL field
canonicalUrl: text({ defaultValue: "https://example.com" })

See

BaseFieldInput for shared properties (label, description, required, admin, index)

Extends

BaseFieldInput<TCollectionSlug, TFieldKey, TFieldMeta>

Type Parameters

TCollectionSlug

TCollectionSlug extends VexResourceSlug = VexResourceSlug

TFieldKey

TFieldKey extends string = never

TFieldMeta

TFieldMeta extends object = { }

Properties

admin?

optional admin?: TextFieldAdminInput<TCollectionSlug>

Defined in: packages/core/src/fields/text/types.ts:84

Admin UI configuration for this field.

Overrides

BaseFieldInput.admin

defaultValue?

optional defaultValue?: string

Defined in: packages/core/src/fields/text/types.ts:90

Pre-filled value shown in the admin form when creating a new field. Does not apply to database values

Overrides

BaseFieldInput.defaultValue

description?

optional description?: string

Defined in: packages/core/src/fields/baseTypes.ts:516

Semantic description of the field. Used in three places:

Helper text rendered below the field input in the admin form UI.
As the Zod .meta({ description }) value for form validation.
As the JSDoc comment on the generated document interface property.

To write a separate JSDoc comment, use interfaceDescription in addition.

Inherited from

BaseFieldInput.description

index?

optional index?: FieldIndexConfigInput<TCollectionSlug, TFieldKey>

Defined in: packages/core/src/fields/baseTypes.ts:545

Create a database index on this field. The string value becomes the index name in Convex.

Example

slug: { type: "text", index: "by_slug", required: true }
// Generates: .index("by_slug", ["slug"])

author: { type: "relationship", index: { name: "by_author_status", additionalFields: ["status"] } }
// Generates: .index("by_author_status", ["author", "status"])