Skip to main content Skip to complementary content

Number property definition

Information noteSTABLE.

This API is reliable and breaking changes are unlikely.

Fields

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

type

This field is mandatory and should always be "number" for a number property type definition.

component

Used for defining how the property is visualized in the property panel. Used to override the default component that comes with the type setting.

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.

min

Used for defining the minimum value of the property.

max

Used for defining the maximum value of the property.

Examples

Defining a custom property of number type can look like below.

Example: Add custom number property to Appearance accordion

Information noteCustomization of properties always start with items:.
	return {
		type: "items",
		component: "accordion",
		items: {
			settings: {
				uses: "settings",
				items: {
					MyNumProp: {
						type: "number",
						label: "Maximum",
						ref: "myproperties.max",
						defaultValue: "10.5"
					}
				}
			}
This is what it looks like in the property panel

An interface titled "MyNewExtension" with the subtitle "Appearance". Under "Appearance", there are two hide and show buttons called "General" and "Maximum". Under "Maxium there is a text box containing "10.5" , titled "Maximum".

You can also define a new accordion item as a number property.

Example: Add custom number property as a new accordion item

	return {
		type: "items",
		component: "accordion",
		items: {
			MyAccordion: {
				type: "number",
				label: "Maximum value",
				ref: "myproperties.max",
				defaultValue: "10",
				max: "20"
			}
This is what it looks like in the property panel

An interface titled "MyNewExtension" with the subtitle "Maximum value". Under "Maximum value", there is a text box containing "10" with the title "Maximum value".

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!