Skip to content

Commit 4e2fb9a

Browse files
authored
Add missing types to component properties (#222)
1 parent 321e0ec commit 4e2fb9a

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

plugin/components.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Key | Description
105105
`title` | required, the property title, it is used by the component Inspector in the CMS backend.
106106
`description` | required, the property description, it is used by the component Inspector in the CMS backend.
107107
`default` | optional, the default property value to use when the component is added to a page or layout in the CMS backend.
108-
`type` | optional, specifies the property type. The type defines the way how the property is displayed in the Inspector. Currently supported types are `string`, `checkbox`, `dropdown` and `set`. Default value: `string`.
108+
`type` | optional, specifies the property type. The type defines the way how the property is displayed in the Inspector. Currently supported types are `string`, `text`, `stringList`, `autocomplete`, `checkbox`, `dropdown`, `dictionary`, `object`, `objectList` and `set`. Default value: `string`.
109109
`validationPattern` | optional Regular Expression to use when a user enters the property value in the Inspector. The validation can be used only with `string` properties.
110110
`validationMessage` | optional error message to display if the validation fails.
111111
`required` | optional, forces field to be filled. Uses validationMessage when left empty.
@@ -115,6 +115,8 @@ Key | Description
115115
`group` | an optional group name. Groups create sections in the Inspector simplifying the user experience. Use a same group name in multiple properties to combine them.
116116
`showExternalParam` | specifies visibility of the External Parameter editor for the property in the Inspector. Default value: `true`.
117117

118+
> **NOTE:** You can find a more detailed description of the different types on the “[data inspector types](../ui/controls/inspector##data-schema-configuration)” page.
119+
118120
Inside the component you can read the property value with the `property` method:
119121

120122
```php

0 commit comments

Comments
 (0)