CheckboxFieldInput

Defined in: packages/core/src/fields/checkbox/types.ts:45

Configuration input for a checkbox() field.

Checkbox fields store boolean values — feature flags, opt-in toggles, published states, and similar on/off settings. All properties are optional; unset properties fall back to the defaults listed below.

Defaults applied by checkbox():

{
  type:         "checkbox",
  label:        "",     // inferred from the field key by defineCollection
  required:     false,  // field is optional by default
  defaultValue: false,  // unchecked when creating a new document
  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",  // value aligned left in the data table column
  }
}

Example

// Minimal — label inferred from the key ("Published")
published: checkbox()

// Checked by default when creating a new document
featured: checkbox({ defaultValue: true, admin: { width: "50%" } })

// Indexed flag for fast admin queries
archived: checkbox({ index: "by_archived" })

See

• CheckboxField for the resolved type after defaults are applied
• checkbox for the config function that applies defaults
• BaseFieldInput for shared properties (label, description, required, admin, index, searchIndex)

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?: FieldAdminConfigInput<TCollectionSlug, ComponentHKT>

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

Admin UI configuration for this field.

Inherited from

BaseFieldInput.admin

---

defaultValue?

optional defaultValue?: boolean

Defined in: packages/core/src/fields/checkbox/types.ts:54

Pre-filled value shown in the admin form when creating a new document. Does not affect database values — only the form’s initial state.

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

---

meta?

optional meta?: TFieldMeta

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

Inherited from

BaseFieldInput.meta

---

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/checkbox/types.ts:56

Server-only async validation with value typed as boolean.

Parameters

props

FieldValidateProps<TCollectionSlug, boolean>

Returns

void | Promise<void>

See

FieldValidate

Overrides

BaseFieldInput.validate