EmailField

Defined in: packages/core/src/fields/email/types.ts:111

Resolved configuration for an email() field, after all defaults are applied.

This is the type that framework adapters and field components receive — fieldDef in FieldComponentProps<EmailField> and CellComponentProps<EmailField> is this type.

See

• EmailFieldInput for the user-facing input type
• email for the config function that produces this type

Extends

• BaseField<TCollectionSlug, TFieldMeta>

Type Parameters

TCollectionSlug

TCollectionSlug extends VexResourceSlug = VexResourceSlug

TFieldMeta

TFieldMeta extends object = { }

Properties

admin

admin: EmailFieldAdminConfig<TCollectionSlug>

Defined in: packages/core/src/fields/email/types.ts:117

Resolved admin UI configuration with all defaults applied.

Overrides

BaseField.admin

---

defaultValue?

optional defaultValue?: string

Defined in: packages/core/src/fields/email/types.ts:122

Pre-filled value shown in the admin form when creating a new document. undefined means no default is applied — the input starts empty.

Overrides

BaseField.defaultValue

---

description?

optional description?: string

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

Semantic description of the field. Used in three places:

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

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

Inherited from

BaseField.description

---

index?

optional index?: ResolvedFieldIndexConfigInput

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

Convex index name for this field, or the object form for a compound index.

Inherited from

BaseField.index

---

interfaceDescription?

optional interfaceDescription?: string

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

The JSDoc comment on the generated document interface property

Inherited from

BaseField.interfaceDescription

---

interfaceType

interfaceType: string

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

TypeScript type string written to generated document interfaces (e.g. "string", "number", "string[]").

Inherited from

BaseField.interfaceType

---

label

label: string

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

Display label shown in the admin form. Always set — inferred from the field key if not provided.

Inherited from

BaseField.label

---

max?

optional max?: FieldLimit

Defined in: packages/core/src/fields/email/types.ts:126

Resolved maximum character length, with a value-aware default error message.

---

meta

meta: TFieldMeta

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

Inherited from

BaseField.meta

---

min?

optional min?: FieldLimit

Defined in: packages/core/src/fields/email/types.ts:124

Resolved minimum character length, with a value-aware default error message.

---

required

required: boolean

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

Whether this field is required in the database schema.

Inherited from

BaseField.required

---

searchIndex?

optional searchIndex?: FieldSearchIndex

Defined in: packages/core/src/fields/email/types.ts:128

Full-text search index configuration for this field.

See

FieldSearchIndex

---

type

readonly type: "email"

Defined in: packages/core/src/fields/email/types.ts:115

Methods

validate()?

optional validate(props): void | Promise<void>

Defined in: packages/core/src/fields/email/types.ts:130

Server-only async validation with value typed as string.

Parameters

props

FieldValidateProps<TCollectionSlug, string>

Returns

void | Promise<void>

See

FieldValidate

Overrides

BaseField.validate