TextField
Defined in: packages/core/src/fields/text/types.ts:104
Resolved configuration for a text() field, after all defaults are applied.
This is the type that framework adapters and field components receive —
fieldDef in InputComponentProps<TextField> and CellComponentProps<TextField>
is this type.
- TextFieldInput for the user-facing input type
- text for the config function that produces this type
Extends
Section titled “Extends”BaseField<TFieldMeta>
Type Parameters
Section titled “Type Parameters”TFieldMeta
Section titled “TFieldMeta”TFieldMeta extends object = { }
Properties
Section titled “Properties”admin:
FieldAdminConfig
Defined in: packages/core/src/fields/text/types.ts:111
Resolved admin UI configuration with all defaults applied.
Overrides
Section titled “Overrides”defaultValue
Section titled “defaultValue”defaultValue:
string
Defined in: packages/core/src/fields/text/types.ts:113
Pre-filled value shown in the admin form when creating a new field.
Overrides
Section titled “Overrides”description?
Section titled “description?”
optionaldescription?:string
Defined in: packages/core/src/fields/baseTypes.ts:252
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
Section titled “Inherited from”index?
Section titled “index?”
optionalindex?:string
Defined in: packages/core/src/fields/baseTypes.ts:256
Convex index name for this field.
Inherited from
Section titled “Inherited from”interfaceDescription?
Section titled “interfaceDescription?”
optionalinterfaceDescription?:string
Defined in: packages/core/src/fields/baseTypes.ts:254
The JSDoc comment on the generated document interface property
Inherited from
Section titled “Inherited from”BaseField.interfaceDescription
interfaceType
Section titled “interfaceType”interfaceType:
string
Defined in: packages/core/src/fields/baseTypes.ts:258
TypeScript type string written to generated document interfaces (e.g. "string", "number", "string[]").
Inherited from
Section titled “Inherited from”label:
string
Defined in: packages/core/src/fields/text/types.ts:107
Display label shown in the admin form. Always set — inferred from the field key if not provided.
Overrides
Section titled “Overrides”
optionalmax?:object
Defined in: packages/core/src/fields/text/types.ts:122
Maximum allowed character length config.
error?
Section titled “error?”
optionalerror?:string
Maximum allowed character length error message.
value:
number
Maximum allowed character length value.
meta:
TFieldMeta
Defined in: packages/core/src/fields/baseTypes.ts:259
Inherited from
Section titled “Inherited from”
optionalmin?:object
Defined in: packages/core/src/fields/text/types.ts:115
Minimum allowed character length config.
error?
Section titled “error?”
optionalerror?:string
Minimum allowed character length error message.
value:
number
Minimum allowed character length value.
required
Section titled “required”required:
boolean
Defined in: packages/core/src/fields/text/types.ts:109
Whether this field is required in the database schema.
Overrides
Section titled “Overrides”searchIndex?
Section titled “searchIndex?”
optionalsearchIndex?:object
Defined in: packages/core/src/fields/text/types.ts:129
Full-text search index configuration for this field.
filterFields
Section titled “filterFields”filterFields:
string[]
Fields to filter search results by.
name:
string
Search index name — must be unique within the collection.
readonlytype:"text"
Defined in: packages/core/src/fields/text/types.ts:105