Checkbox Field

The Checkbox field stores a boolean value.

import type { Field } from 'frogbot'

export const Featured: Field = {
  name: 'featured',
  type: 'checkbox',
  defaultValue: false,
}

Config options

Option	Type	Default	Description
`name`	`string`	Required	Property name used in stored records and APIs. See field names.
`type`	`'checkbox'`	Required	Selects the Checkbox field.
`label`	`string \| Record<string, string> \| (({ i18n, t }) => string) \| false`	Generated from `name`	Label shown in the admin panel. Use an object keyed by language code for translations, or `false` to hide the label.
`required`	`boolean`	`false`	Requires a boolean value.
`unique`	`boolean`	`false`	Creates a unique database index for the field path. See indexes.
`index`	`boolean`	`false`	Creates a database index for faster queries. `unique` already creates one.
`localized`	`boolean`	`false`	Stores one value per configured locale. Ignored without localization or inside a localized parent.
`defaultValue`	`boolean` or `({ locale, req, user }) => value`	`false` when `required` is `true`	Value used when the field is missing. See default values.
`validate`	`Validate`	Built-in validator	Replaces the built-in validator. See validation.
`hooks`	`{ beforeValidate, beforeChange, afterChange, afterRead, beforeDuplicate }`	—	Arrays of `FieldHook` functions for each phase. See field hooks.
`access`	`{ create, read, update }`	Allowed	`FieldAccess` functions for each operation. See field access control.
`hidden`	`boolean`	`false`	Removes the field from API responses and the admin panel while keeping stored data.
`saveToJWT`	`boolean \| string`	`false`	In an auth-enabled collection, copies the value into the user’s token. A string sets the token key. See token data.
`virtual`	`boolean \| string`	`false`	`true` skips database storage; a string reads a value through a relationship path. Virtual fields are read-only in the admin panel unless `admin.readOnly` is `false`. See virtual fields.
`disableDuplicate`	`boolean`	`false`	Leaves the value out when a document is duplicated, so the copy uses `defaultValue`.
`admin`	`object`	—	Standard field admin options.
`custom`	`Record<string, any>`	—	Server-only metadata for your own code and plugins. Use `admin.custom` for data the browser also needs.
`jsonSchema`	`Array<({ jsonSchema }) => JSONSchema4>`	—	Functions that modify the JSON Schema used by type generation.

Example

import type { CollectionConfig } from 'frogbot'

export const Features: CollectionConfig = {
  slug: 'features',
  fields: [
    {
      name: 'enableCoolStuff',
      type: 'checkbox',
      label: 'Enable cool stuff',
      defaultValue: false,
    },
  ],
}

Custom components

Field

Server component

import { CheckboxField } from '@frogbotai/ui/admin'
import type { CheckboxFieldServerProps } from 'frogbot'

export const CustomCheckboxServer = (props: CheckboxFieldServerProps) => (
  <CheckboxField
    field={props.clientField}
    path={props.path}
    permissions={props.permissions}
    schemaPath={props.schemaPath}
  />
)

Client component

'use client'

import { CheckboxField } from '@frogbotai/ui/admin'
import type { CheckboxFieldClientProps } from 'frogbot'

export const CustomCheckboxClient = (props: CheckboxFieldClientProps) => <CheckboxField {...props} />

Label

Server component

import { FieldLabel } from '@frogbotai/ui/admin'
import type { CheckboxFieldLabelServerProps } from 'frogbot'

export const CustomCheckboxLabelServer = ({ clientField, path }: CheckboxFieldLabelServerProps) => (
  <FieldLabel
    label={clientField.label || clientField.name}
    path={path}
    required={clientField.required}
  />
)

Client component

'use client'

import { FieldLabel } from '@frogbotai/ui/admin'
import type { CheckboxFieldLabelClientProps } from 'frogbot'

export const CustomCheckboxLabelClient = ({ field, path }: CheckboxFieldLabelClientProps) => (
  <FieldLabel label={field.label || field.name} path={path} required={field.required} />
)

Start here

Basics

Managing Data

Features

Ecosystem

Deployment

Config options

Example

Custom components

Field

Server component

Client component

Label

Server component

Client component

​Config options

​Example

​Custom components

​Field

​Server component

​Client component

​Label

​Server component

​Client component

Config options

Example

Custom components

Field

Server component

Client component

Label

Server component

Client component