Index
Edit

Boolean

A boolean, true or false.

Properties

typestring

Required. Value must be set to boolean.

titlestring

Human readable label for the field.

namestring

Required. The field name. This will be the key in the data record.

hiddenboolean

If set to true, this field will be hidden in the Content Studio.

readOnlyboolean

If set to true, this field will not be editable in the content studio.

descriptionstring

Short description to editors how the field is to be used.

Options

layoutstring

Either switch (default) or checkbox

This let's you control the visual appearance of the input. By default the input for boolean fields will display as a switch, but you can also make it appear as a checkbox

Validation

For more usage information see the full validation documentation.

required()

Ensures that this field exists.

custom(fn)

Creates a custom validation rule.

Schema
{
  title: 'Has the movie been released?',
  name: 'released',
  type: 'boolean'
}
JSON output
{
  "_type": "movie",
  "released": true,
  ...
}

New documents are created without schema-defined fields. This means that a boolean field in your schema will not immediately result in documents containing the boolean key. The key must be assigned a value for it to appear in a document. Make sure your front-end code treats a missing boolean value as false.

Pro-tip

In GROQ you can handle missing booleans and false values equally like this *[_type == 'story' && featured != true] which would match stories where featured is false or missing (or to be fair, any other value that is not true).

Previous: NumberNext: Array