Boolean

The boolean type renders a checkbox. Use it for on/off flags like published state, visibility toggles, or feature flags.

Definition

import type { BooleanField } from '@aphexcms/cms-core';

{
  name: 'published',
  type: 'boolean',
  title: 'Published',
  description: 'Make this document publicly visible.',
  initialValue: false
}

Property	Type	Required	Description
`name`	`string`	Yes	Field identifier.
`type`	`'boolean'`	Yes	Must be `'boolean'`.
`title`	`string`	Yes	Label shown next to the checkbox.
`description`	`string`	No	Help text shown below the label.
`initialValue`	`boolean \| () => boolean \| Promise<boolean>`	No	Default value.
`validation`	`(Rule) => Rule`	No	Validation rules.

{
  name: 'featured',
  type: 'boolean',
  title: 'Featured',
  description: 'Show this item in the featured section.',
  initialValue: false
}

{
  name: 'confirmed',
  type: 'boolean',
  title: 'Confirmed',
  validation: (Rule) => Rule.required()
}

Available rules: required(), custom(fn), error(msg), warning(msg), info(msg)