Boolean

A true or false value

Specification

nested

Available types:

Type

Specification

array

Provides an array of nested parameters that are shown when the value of the parameter is true (the checkbox is checked).

string

Provides the 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.

Example

Basic Boolean

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

[
	{
		"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.

[
	{
		"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 is true.

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

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.

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

PreviousArray NextBuffer

Last updated 16 days ago