NumberFieldInput

Defined in: packages/core/src/fields/number/types.ts:79

Configuration input for a number() field.

Number fields store numeric values — prices, quantities, ratings, ages, counts, etc. All properties are optional; unset properties fall back to the defaults listed below.

Defaults applied by number():

{
  type:     "number",
  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",  // value aligned left in the data table column
  }
}

Example

// Minimal — label is inferred from the key ("Price")
price: number()

// Required quantity with a minimum of 1 and a database index
quantity: number({ required: true, min: 1, index: "by_quantity" })

// Rating capped between 0 and 5 with custom error messages
rating: number({
  min: [0, "Rating cannot be negative"],
  max: [5, "Rating cannot exceed 5"],
  admin: { width: "50%" },
})

// Pre-filled default for a score field
score: number({ defaultValue: 100 })

See

• NumberField for the resolved type after defaults are applied
• number 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?: NumberFieldAdminInput<TCollectionSlug>

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

Admin UI configuration for this field.

Overrides

BaseFieldInput.admin

---

defaultValue?

optional defaultValue?: number

Defined in: packages/core/src/fields/number/types.ts:90

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

---

max?

optional max?: FieldLimitInput

Defined in: packages/core/src/fields/number/types.ts:94

Maximum allowed numeric value.

See

FieldLimitInput

---

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/number/types.ts:92

Minimum allowed numeric value.

See

FieldLimitInput

---

required?

optional required?: boolean

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

Whether this field is required.

Default: false

Inherited from

BaseFieldInput.required

---

step?

optional step?: number

Defined in: packages/core/src/fields/number/types.ts:100

Step increment for the number input’s native spinner/validation (the HTML step attribute). Purely a UI affordance — submitted values are never rounded or rejected against it.

Methods

validate()?

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

Defined in: packages/core/src/fields/number/types.ts:102

Server-only async validation with value typed as number.

Parameters

props

FieldValidateProps<TCollectionSlug, number>

Returns

void | Promise<void>

See

FieldValidate

Overrides

BaseFieldInput.validate