Checkbox Inspector Type
Inspector Type
The checkbox inspector type is represented with a checkbox in the interface. This property doesn't have any special parameters. The default parameter, if specified, should contain a boolean value or string values true, false, 1, 0.
public function defineProperties()
{
return [
'enabled' => [
'title' => 'Enabled',
'type' => 'checkbox',
'default' => true
]
];
}
The generated output is 0 (unchecked) or 1 (checked), for example:
"enabled": 1
The following configuration values are commonly used.
| Property | Description |
|---|---|
| title | title for the property. |
| description | a brief description of the property, optional. |
| default | specifies a default as true or false, optional. |