Boolean schema

Learn how to define schemas for boolean values.

Boolean schemas describe true or false values such as on/off or yes/no switches.

Boolean input

The input for a boolean schema is a toggle button that has two labels, one for true and another for false values.

Examples

Below are some examples of boolean schemas:

123
{
  "type": "boolean"
}

Properties

The following properties are available for boolean schemas:

type
string

The type of the schema. Always boolean for boolean schemas.

label(optional)
Labels

A map of labels for the boolean values.

true
string

The label for representing true, up to 60 characters.

false
string

The label for representing false, up to 60 characters.

Default:"True" and "False"
default(optional)
boolean

The value to be preselected on the user interface.

Default:false