Skip to content
VexCMS

ADMIN_FIELDS

const ADMIN_FIELDS: object

Defined in: packages/core/src/fields/constants.ts:11

Convex schema metadata for each supported field type, keyed by field type name.

Type Declaration

Section titled “Type Declaration”

array

Section titled “array”

readonly array: object

array.defaultValue

Section titled “array.defaultValue”

readonly defaultValue: readonly [] = []

array.inputMasks

Section titled “array.inputMasks”

readonly inputMasks: false = false

array.interfaceType

Section titled “array.interfaceType”

readonly interfaceType: "unknown[]" = "unknown[]"

array.kind

Section titled “array.kind”

readonly kind: "data" = "data"

array.type

Section titled “array.type”

readonly type: "array" = "array"

array.validator

Section titled “array.validator”

readonly validator: “v.array(\nv.any()\n)” = “v.array(\nv.any()\n)“

blocks

Section titled “blocks”

readonly blocks: object

blocks.defaultValue

Section titled “blocks.defaultValue”

readonly defaultValue: readonly [] = []

blocks.inputMasks

Section titled “blocks.inputMasks”

readonly inputMasks: false = false

blocks.interfaceType

Section titled “blocks.interfaceType”

readonly interfaceType: "Record<string, any>[]" = "Record<string, any>[]"

blocks.kind

Section titled “blocks.kind”

readonly kind: "data" = "data"

blocks.type

Section titled “blocks.type”

readonly type: "blocks" = "blocks"

blocks.validator

Section titled “blocks.validator”

readonly validator: "v.array(v.any())" = "v.array(v.any())"

checkbox

Section titled “checkbox”

readonly checkbox: object

checkbox.defaultValue

Section titled “checkbox.defaultValue”

readonly defaultValue: false = false

checkbox.inputMasks

Section titled “checkbox.inputMasks”

readonly inputMasks: false = false

checkbox.interfaceType

Section titled “checkbox.interfaceType”

readonly interfaceType: "boolean" = "boolean"

checkbox.kind

Section titled “checkbox.kind”

readonly kind: "data" = "data"

checkbox.type

Section titled “checkbox.type”

readonly type: "checkbox" = "checkbox"

checkbox.validator

Section titled “checkbox.validator”

readonly validator: "v.boolean()" = "v.boolean()"

collapsible

Section titled “collapsible”

readonly collapsible: object

collapsible.defaultValue

Section titled “collapsible.defaultValue”

readonly defaultValue: undefined = undefined

collapsible.inputMasks

Section titled “collapsible.inputMasks”

readonly inputMasks: false = false

collapsible.interfaceType

Section titled “collapsible.interfaceType”

readonly interfaceType: "never" = "never"

collapsible.kind

Section titled “collapsible.kind”

readonly kind: "ui" = "ui"

collapsible.type

Section titled “collapsible.type”

readonly type: "collapsible" = "collapsible"

collapsible.validator

Section titled “collapsible.validator”

readonly validator: "never" = "never"

color

Section titled “color”

readonly color: object

color.defaultValue

Section titled “color.defaultValue”

readonly defaultValue: "" = ""

color.inputMasks

Section titled “color.inputMasks”

readonly inputMasks: false = false

color.interfaceType

Section titled “color.interfaceType”

readonly interfaceType: "string" = "string"

color.kind

Section titled “color.kind”

readonly kind: "data" = "data"

color.type

Section titled “color.type”

readonly type: "color" = "color"

color.validator

Section titled “color.validator”

readonly validator: "v.string()" = "v.string()"

commitTs

Section titled “commitTs”

readonly commitTs: object

commitTs.defaultValue

Section titled “commitTs.defaultValue”

readonly defaultValue: undefined = undefined

commitTs.inputMasks

Section titled “commitTs.inputMasks”

readonly inputMasks: false = false

commitTs.interfaceType

Section titled “commitTs.interfaceType”

readonly interfaceType: "number" = "number"

commitTs.kind

Section titled “commitTs.kind”

readonly kind: "data" = "data"

commitTs.type

Section titled “commitTs.type”

readonly type: "commitTs" = "commitTs"

commitTs.validator

Section titled “commitTs.validator”

readonly validator: "v.commitTs()" = "v.commitTs()"

date

Section titled “date”

readonly date: object

date.defaultValue

Section titled “date.defaultValue”

readonly defaultValue: undefined = undefined

date.inputMasks

Section titled “date.inputMasks”

readonly inputMasks: false = false

date.interfaceType

Section titled “date.interfaceType”

readonly interfaceType: "number" = "number"

date.kind

Section titled “date.kind”

readonly kind: "data" = "data"

date.type

Section titled “date.type”

readonly type: "date" = "date"

date.validator

Section titled “date.validator”

readonly validator: "v.number()" = "v.number()"

email

Section titled “email”

readonly email: object

email.defaultValue

Section titled “email.defaultValue”

readonly defaultValue: "" = ""

email.inputMasks

Section titled “email.inputMasks”

readonly inputMasks: true = true

email.interfaceType

Section titled “email.interfaceType”

readonly interfaceType: "string" = "string"

email.kind

Section titled “email.kind”

readonly kind: "data" = "data"

email.type

Section titled “email.type”

readonly type: "email" = "email"

email.validator

Section titled “email.validator”

readonly validator: "v.string()" = "v.string()"

group

Section titled “group”

readonly group: object

group.defaultValue

Section titled “group.defaultValue”

readonly defaultValue: Record<string, any>

group.inputMasks

Section titled “group.inputMasks”

readonly inputMasks: false = false

group.interfaceType

Section titled “group.interfaceType”

readonly interfaceType: "Record<string, any>" = "Record<string, any>"

group.kind

Section titled “group.kind”

readonly kind: "data" = "data"

group.type

Section titled “group.type”

readonly type: "group" = "group"

group.validator

Section titled “group.validator”

readonly validator: "v.object({})" = "v.object({})"

json

Section titled “json”

readonly json: object

json.defaultValue

Section titled “json.defaultValue”

readonly defaultValue: undefined = undefined

json.inputMasks

Section titled “json.inputMasks”

readonly inputMasks: false = false

json.interfaceType

Section titled “json.interfaceType”

readonly interfaceType: "unknown" = "unknown"

json.kind

Section titled “json.kind”

readonly kind: "data" = "data"

json.type

Section titled “json.type”

readonly type: "json" = "json"

json.validator

Section titled “json.validator”

readonly validator: "v.any()" = "v.any()"

number

Section titled “number”

readonly number: object

number.defaultValue

Section titled “number.defaultValue”

readonly defaultValue: 0 = 0

number.inputMasks

Section titled “number.inputMasks”

readonly inputMasks: true = true

number.interfaceType

Section titled “number.interfaceType”

readonly interfaceType: "number" = "number"

number.kind

Section titled “number.kind”

readonly kind: "data" = "data"

number.type

Section titled “number.type”

readonly type: "number" = "number"

number.validator

Section titled “number.validator”

readonly validator: "v.number()" = "v.number()"

relationship

Section titled “relationship”

readonly relationship: object

relationship.defaultValue

Section titled “relationship.defaultValue”

readonly defaultValue: string[]

relationship.inputMasks

Section titled “relationship.inputMasks”

readonly inputMasks: false = false

relationship.interfaceType

Section titled “relationship.interfaceType”

readonly interfaceType: "Id<CollectionSlug>[]" = "Id<CollectionSlug>[]"

relationship.kind

Section titled “relationship.kind”

readonly kind: "data" = "data"

relationship.type

Section titled “relationship.type”

readonly type: "relationship" = "relationship"

relationship.validator

Section titled “relationship.validator”

readonly validator: “v.array(\nv.string()\n)” = “v.array(\nv.string()\n)“

richtext

Section titled “richtext”

readonly richtext: object

richtext.defaultValue

Section titled “richtext.defaultValue”

readonly defaultValue: readonly [] = []

richtext.inputMasks

Section titled “richtext.inputMasks”

readonly inputMasks: false = false

richtext.interfaceType

Section titled “richtext.interfaceType”

readonly interfaceType: "RichTextDocument" = "RichTextDocument"

richtext.kind

Section titled “richtext.kind”

readonly kind: "data" = "data"

richtext.type

Section titled “richtext.type”

readonly type: "richtext" = "richtext"

richtext.validator

Section titled “richtext.validator”

readonly validator: “v.array(\nv.any()\n)” = “v.array(\nv.any()\n)“

row

Section titled “row”

readonly row: object

row.defaultValue

Section titled “row.defaultValue”

readonly defaultValue: undefined = undefined

row.inputMasks

Section titled “row.inputMasks”

readonly inputMasks: false = false

row.interfaceType

Section titled “row.interfaceType”

readonly interfaceType: "never" = "never"

row.kind

Section titled “row.kind”

readonly kind: "ui" = "ui"

row.type

Section titled “row.type”

readonly type: "row" = "row"

row.validator

Section titled “row.validator”

readonly validator: "never" = "never"

select

Section titled “select”

readonly select: object

select.defaultValue

Section titled “select.defaultValue”

readonly defaultValue: string[]

select.inputMasks

Section titled “select.inputMasks”

readonly inputMasks: false = false

select.interfaceType

Section titled “select.interfaceType”

readonly interfaceType: "string[]" = "string[]"

select.kind

Section titled “select.kind”

readonly kind: "data" = "data"

select.type

Section titled “select.type”

readonly type: "select" = "select"

select.validator

Section titled “select.validator”

readonly validator: “v.array(\nv.string()\n)” = “v.array(\nv.string()\n)“

tabs

Section titled “tabs”

readonly tabs: object

tabs.defaultValue

Section titled “tabs.defaultValue”

readonly defaultValue: undefined = undefined

tabs.inputMasks

Section titled “tabs.inputMasks”

readonly inputMasks: false = false

tabs.interfaceType

Section titled “tabs.interfaceType”

readonly interfaceType: "never" = "never"

tabs.kind

Section titled “tabs.kind”

readonly kind: "ui" = "ui"

tabs.type

Section titled “tabs.type”

readonly type: "tabs" = "tabs"

tabs.validator

Section titled “tabs.validator”

readonly validator: "never" = "never"

text

Section titled “text”

readonly text: object

text.defaultValue

Section titled “text.defaultValue”

readonly defaultValue: "" = ""

text.inputMasks

Section titled “text.inputMasks”

readonly inputMasks: true = true

text.interfaceType

Section titled “text.interfaceType”

readonly interfaceType: "string" = "string"

text.kind

Section titled “text.kind”

readonly kind: "data" = "data"

text.type

Section titled “text.type”

readonly type: "text" = "text"

text.validator

Section titled “text.validator”

readonly validator: "v.string()" = "v.string()"

textarea

Section titled “textarea”

readonly textarea: object

textarea.defaultValue

Section titled “textarea.defaultValue”

readonly defaultValue: "" = ""

textarea.inputMasks

Section titled “textarea.inputMasks”

readonly inputMasks: false = false

textarea.interfaceType

Section titled “textarea.interfaceType”

readonly interfaceType: "string" = "string"

textarea.kind

Section titled “textarea.kind”

readonly kind: "data" = "data"

textarea.type

Section titled “textarea.type”

readonly type: "textarea" = "textarea"

textarea.validator

Section titled “textarea.validator”

readonly validator: "v.string()" = "v.string()"

ui

Section titled “ui”

readonly ui: object

ui.defaultValue

Section titled “ui.defaultValue”

readonly defaultValue: undefined = undefined

ui.inputMasks

Section titled “ui.inputMasks”

readonly inputMasks: false = false

ui.interfaceType

Section titled “ui.interfaceType”

readonly interfaceType: "never" = "never"

ui.kind

Section titled “ui.kind”

readonly kind: "ui" = "ui"

ui.type

Section titled “ui.type”

readonly type: "ui" = "ui"

ui.validator

Section titled “ui.validator”

readonly validator: "never" = "never"

upload

Section titled “upload”

readonly upload: object

upload.defaultValue

Section titled “upload.defaultValue”

readonly defaultValue: undefined = undefined

upload.inputMasks

Section titled “upload.inputMasks”

readonly inputMasks: false = false

upload.interfaceType

Section titled “upload.interfaceType”

readonly interfaceType: "Id<MediaCollectionSlug>[]" = "Id<MediaCollectionSlug>[]"

upload.kind

Section titled “upload.kind”

readonly kind: "data" = "data"

upload.type

Section titled “upload.type”

readonly type: "upload" = "upload"

upload.validator

Section titled “upload.validator”

readonly validator: “v.array(\nv.string()\n)” = “v.array(\nv.string()\n)“

url

Section titled “url”

readonly url: object

url.defaultValue

Section titled “url.defaultValue”

readonly defaultValue: "" = ""

url.inputMasks

Section titled “url.inputMasks”

readonly inputMasks: true = true

url.interfaceType

Section titled “url.interfaceType”

readonly interfaceType: "string" = "string"

url.kind

Section titled “url.kind”

readonly kind: "data" = "data"

url.type

Section titled “url.type”

readonly type: "url" = "url"

url.validator

Section titled “url.validator”

readonly validator: "v.string()" = "v.string()"