EmailFieldInput

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

Configuration input for an email() field.

Email fields store single-line email address strings. All properties are optional; unset properties fall back to the defaults listed below.

Defaults applied by email():

{
  type:     "email",
  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 ("Contact Email")
contactEmail: email()

// Required with a length cap and a database index
workEmail: email({ required: true, max: 254, index: "by_work_email" })

// Custom length-error message via the [value, error] tuple
supportEmail: email({ min: [5, "That's too short to be an email."] })

// Full-text searchable (partial matches, e.g. in a relationship picker)
email: email({ searchIndex: { name: "search_email", filterFields: [] } })

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?: EmailFieldAdminInput<TCollectionSlug>

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

Admin UI configuration for this field.

Overrides

BaseFieldInput.admin

---

defaultValue?

optional defaultValue?: string

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

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:

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

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"])

Inherited from

BaseFieldInput.index

---

interfaceDescription?

optional interfaceDescription?: string

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

The JSDoc comment on the generated document interface property

Inherited from

BaseFieldInput.interfaceDescription

---

label?

optional label?: string

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

Display label for the field in the admin form.

Inherited from

BaseFieldInput.label

---

max?

optional max?: FieldLimitInput

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

Maximum character length, applied to the email string itself.

---

meta?

optional meta?: TFieldMeta

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

Inherited from

BaseFieldInput.meta

---

min?

optional min?: FieldLimitInput

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

Minimum character length, applied to the email string itself.

---

required?

optional required?: boolean

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

Whether this field is required.

Default: false

Inherited from

BaseFieldInput.required

---

searchIndex?

optional searchIndex?: FieldSearchIndex

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

Create a full-text search index on this field. The field this is defined on becomes the searchField.

See

FieldSearchIndex

Methods

validate()?

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

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

Server-only async validation with value typed as string.

Parameters

props

FieldValidateProps<TCollectionSlug, string>

Returns

void | Promise<void>

See

FieldValidate

Overrides

BaseFieldInput.validate