Boolean inputs

A Boolean input lets your team add true or false values to your data files or front matter.

There are two types of Boolean input:

• Checkbox
• Switch

Boolean inputs are simple. Beyond configuring the type (Checkbox or Switch) and the general configuration options available for all inputs, there are no more configuration keys.

Checkbox#

The Checkbox Boolean input provides an editing interface for true or false values. True values have a checked box, while false values have an unchecked box.

You can configure a Checkbox input using the type key with the value checkbox. Define the type key under your input key name within _inputs. For more information, please read our documentation on configuring your inputs.

_inputs:
  blog_published:
    type: checkbox

{
  "_inputs": {
    "blog_published": {
      "type": "checkbox"
    }
  }
}

Once configured, the Checkbox Boolean input will appear in the Data Editor or the Visual or Content Editor sidebar when you add it to a data file or the front matter of a markup file.

---
blog_published: true
---

Blog content goes here.

Switch#

The Switch Boolean input provides an editing interface for true or false values. True values show the switch to the right with the text "ON", while false values show the switch to the left with the text "OFF".

You can configure a Switch input using the type key with the value switch. Define the type key under your input key name within _inputs. For more information, please read our documentation on configuring your inputs.

_inputs:
  featured:
    type: switch

{
  "_inputs": {
    "featured": {
      "type": "switch"
    }
  }
}

Once configured, the Switch Boolean input will appear in the Data Editor or sidebar of the Visual or Content Editor when you add it to a data file or the front matter of a markup file.

featured: false

Unconfigured Boolean inputs#

In some cases, CloudCannon can still detect a Boolean input even if you have not configured it.

CloudCannon will interpret any unconfigured input with a true or false value as a Checkbox Boolean input. CloudCannon cannot create a Switch input without configuration.

---
public: true
---

Content goes here.

This behavior is convenient if you have simple inputs or do not want to configure inputs. It is also beneficial for new websites on CloudCannon where you have yet to create any CloudCannon-specific configuration.

Valid values#

Here are some examples of valid values for the key is_true. These work for both Checkbox and Switch inputs.