DateField
Defined in: packages/core/src/fields/date/types.ts:116
Resolved configuration for a date() field, after all defaults are applied.
This is the type that framework adapters and field components receive —
fieldDef in InputComponentProps<DateField> and CellComponentProps<DateField>
is this type.
- DateFieldInput for the user-facing input type
- date 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/date/types.ts:123
Resolved admin UI configuration with all defaults applied.
Overrides
Section titled “Overrides”defaultValue
Section titled “defaultValue”defaultValue:
number|undefined
Defined in: packages/core/src/fields/date/types.ts:125
Pre-filled Unix timestamp (milliseconds) shown in the admin form when creating a new document.
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/date/types.ts:119
Display label shown in the admin form. Always set — inferred from the field key if not provided.
Overrides
Section titled “Overrides”
optionalmax?:number
Defined in: packages/core/src/fields/date/types.ts:129
Maximum allowed Unix timestamp (milliseconds).
meta:
TFieldMeta
Defined in: packages/core/src/fields/baseTypes.ts:259
Inherited from
Section titled “Inherited from”
optionalmin?:number
Defined in: packages/core/src/fields/date/types.ts:127
Minimum allowed Unix timestamp (milliseconds).
required
Section titled “required”required:
boolean
Defined in: packages/core/src/fields/date/types.ts:121
Whether this field is required in the database schema.
Overrides
Section titled “Overrides”time:
object
Defined in: packages/core/src/fields/date/types.ts:135
Resolved date/time picker display configuration — all keys always present after defaults are applied.
hidden
Section titled “hidden”hidden:
boolean
Whether the time-of-day picker is hidden, leaving only the calendar date selector.
timePicker
Section titled “timePicker”timePicker:
object
Which time unit selectors are shown in the time picker.
timePicker.hour
Section titled “timePicker.hour”hour:
boolean
Whether the hour selector is shown.
timePicker.minute
Section titled “timePicker.minute”minute:
boolean
Whether the minute selector is shown.
timePicker.second
Section titled “timePicker.second”second:
boolean
Whether the seconds selector is shown.
use12HourFormat
Section titled “use12HourFormat”use12HourFormat:
boolean
Whether time is displayed in 12-hour AM/PM format (true) or 24-hour format (false).
DateFieldInput for the user-facing input type where each key is optional
readonlytype:"date"
Defined in: packages/core/src/fields/date/types.ts:117