Checkbox

The <sdpi-checkbox> component provides a styled wrapper of <input type="checkbox">.

Example

Property Inspector HTML

<sdpi-item label="Checkbox">
    <sdpi-checkbox setting="is_okay" label="Is everything okay?"></sdpi-checkbox>
</sdpi-item>

Result

value

The value of <sdpi-checkbox> is represented as a boolean.

{
    "is_okay": true
}

Configuration

The component supports the following configuration.

Name	Type	Description
default	boolean	The default value; shown when the persisted value is undefined.
disabled	boolean	Determines whether the input is disabled.
label	string	Optional label text shown to the right of the checkbox.
value	boolean	The value of the component (comparable to checked), and the persisted setting.

Persistence

The value of the component can be automatically persisted to the Stream Deck with the following configuration.

Name	Type	Description
global	boolean	When present, the value will be persisted to the global settings.
setting	string	The path of the property where the value should be persisted in the settings.

setting

The setting represents the path of a property. If required, this path can denote a nested property within the settings, e.g. if the setting were foo.bar.prop, the value would be saved to:

{
    "foo": {
        "bar": {
            "prop": <value>
        }
    }
}