SelectFieldInput

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

Configuration input for a select() field.

Select fields store an array of chosen option values — status labels, categories, tags, or any enumerable set. All properties are optional; unset properties fall back to the defaults listed below.

Defaults applied by select():

{
  type:         "select",
  label:        "",    // inferred from the field key by defineCollection
  required:     false, // field is optional by default
  defaultValue: [],    // empty selection
  options:      [],    // no options configured
  hasMany:      false, // single-select 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",  // aligned left in the data table column
  }
}

Example

// Single-select status
tier: select({
  required: true,
  options: [
    { label: "Free", value: "free" },
    { label: "Pro", value: "pro" },
  ],
})

// Multi-select tags with badge colours
tags: select({
  hasMany: true,
  options: [
    { label: "News", value: "news", badgeColor: "#3b82f6" },
    { label: "Tutorial", value: "tutorial", badgeColor: "#10b981" },
  ],
})

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

Defined in: packages/core/src/fields/select/types.ts:104

Admin UI configuration for this field.

Overrides

BaseFieldInput.admin

---

defaultValue?

optional defaultValue?: string[]

Defined in: packages/core/src/fields/select/types.ts:110

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

---

hasMany?

optional hasMany?: boolean

Defined in: packages/core/src/fields/select/types.ts:116

---

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

---

meta?

optional meta?: TFieldMeta

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

Inherited from

BaseFieldInput.meta

---

optionInterfaceName?

optional optionInterfaceName?: string

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

---

options?

optional options?: object[]

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

badgeColor?

optional badgeColor?: string

label

label: string

value

value: string

---

required?

optional required?: boolean

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

Whether this field is required.

Default: false

Inherited from

BaseFieldInput.required

Methods

validate()?

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

Defined in: packages/core/src/fields/select/types.ts:119

Server-only async validation with value typed as string[].

Parameters

props

FieldValidateProps<TCollectionSlug, string[]>

Returns

void | Promise<void>

See

FieldValidate

Overrides

BaseFieldInput.validate