Boolean

Boolean is a true of false value.

The list of common settings for parameters is available here.

Specification

nested

• Available types:

Type	Specification
array	Provides an array of nested parameters which are shown when the value of the parameter is true (the checkbox is checked).
string	Provides URL address of an RPC to load list of nested parameters.
object	Provides a detailed specification of nested parameters.

editable (deprecated)

• Type: Boolean

• Default: false

• If set to true , the user can map (or manually edit) the value of the parameter.

Examples

Basic Boolean

A basic boolean offers three options: true, false and undefined.

Appearance

Example of Boolean

Source

[
	{
		"type": "boolean",
		"label": "My Boolean",
		"name": "myBoolean"
	}
]

Checkbox Style

You can turn the radio buttons into a checkbox by adding a "required": true property. Additionally, you can set the default state by setting the default property.

Appearance

Example of Checkbox

Source

[
	{
		"type": "boolean",
		"label": "Enable this feature?",
		"name": "enable",
		"required": true
	},
	{
		"type": "boolean",
		"label": "Subscribe?",
		"name": "subscribe",
		"required": true,
		"default": true
	}
]

Nested Parameters

By adding nested fields, you can add fields that will be shown to the user if this field’s value will true.

Appearance 1

Boolean Set to False

Appearence 2

Boolean Set to True

Source

[
 {
    "name": "myBoolean",
    "type": "boolean",
    "label": "My Boolean",
    "nested": [
        {
            "name": "nestedField1",
            "type": "text",
            "label": "Nested Field 1"
        },
        {
            "name": "nestedField2",
            "type": "text",
            "label": "Nested Field 2"
        }
    ]
  }
]

If you prefer a simple checkbox, add "required" : true to the parameter description.

Editable (deprecated)

Since Apps platform version 2, all booleans have set mappable(editable) to true by default.

You can allow mapping to the field by setting editable to true.

Appearance

Example of Editable

Source

[
	{
		"type": "boolean",
		"label": "Editable boolean",
		"name": "myBoolean",
		"editable": true
	}
]