Check box property definition

Note: STABLE.
This API is reliable and breaking changes are unlikely.

Fields

The check box definition property template can be used to add a custom property of check box type. When defining a check box property, the following fields can be used:

type

This field is mandatory and should always be "boolean" for a check box property type definition.

label

Used for defining the label that is displayed in the property panel.

ref

Name or ID used to reference a property.

defaultValue

Used for defining the default value of your custom property.

Examples

Defining a custom property of check box type can look like below.

Example: Add custom check box property to Appearance accordion

Note: Customization of properties always start with items:.
	return {
		type: "items",
		component: "accordion",
		items: {
		settings: {
				uses: "settings",
				items: {
					MyCheckProp: {
						type: "boolean",
						label: "Show me",
						ref: "myproperties.show",
						defaultValue: true
					}
				}
			}
This is what it looks like in the property panel

You can also define a new accordion item as a check-box property.

Example: Add custom check-box property as a new accordion item

	return {
		type: "items",
		component: "accordion",
		items: {
			MyAccordion: {
				type: "boolean",
				label: "Show me",
				ref: "myproperties.show",
				defaultValue: true
			}
This is what it looks like in the property panel

Did this information help you?

Thanks for letting us know. Is there anything you'd like to tell us about this topic?

Can you tell us why it did not help you and how we can improve it?