[PropertyGridEditor]¶
Introduction¶
Shows a grid which allows you to add (and remove) multiple rows and fill values for each row.
Properties¶
templateName¶
- Data type
- string
- Needed by
- Backend (form editor)
- Mandatory
- Yes
- Related options
- value
- Inspector-PropertyGridEditor
- Good to know
- Description
-
The inline HTML template which is used for this inspector editor. Must be equal to an existing array key within
prototypes.<prototypeIdentifier>.formEditor.formEditorPartials
and must be started with 'Inspector-' by convention.
identifier¶
- Option path
- prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.editors.*.identifier
- Data type
- string
- Needed by
- Backend (form editor)
- Mandatory
- Yes
- Default value
- Depends (see concrete element configuration)
- Good to know
- Description
- Identifies the current
inspector editor
within the current form element. The identifier is a text of your choice but must be unique within the optionpathprototypes.prototypeIdentifier.formElementsDefinition.formelementtypeidentifier.formEditor.editors
.
label¶
- Option path
- prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.editors.*.label
- Data type
- string
- Needed by
- Backend (form editor)
- Mandatory
- Yes
- Default value
- Depends (see concrete element configuration)
- Good to know
- Description
- The label for this
inspector editor
which is shown within theinspector component
.
propertyPath¶
- Option path
- prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.editors.*.propertyPath
- Data type
- string
- Needed by
- Backend (form editor)
- Mandatory
- Yes
- Default value
- Depends (see concrete element configuration)
- Good to know
- Description
- The path to the property of the form element which should be written by this
inspector editor
.
isSortable¶
- Data type
- bool
- Needed by
- Backend (form editor)
- Mandatory
- Yes
- Good to know
- Description
- If set to 'false' the rows are not sortable.
enableAddRow¶
- Data type
- bool
- Needed by
- Backend (form editor)
- Mandatory
- Yes
- Good to know
- Description
- If set to 'false' the "add new row" button is disabled.
enableDeleteRow¶
- Data type
- bool
- Needed by
- Backend (form editor)
- Mandatory
- Yes
- Good to know
- Description
- If set to 'false' the "delete row" button is disabled.
multiSelection¶
- Data type
- bool
- Needed by
- Backend (form editor)
- Mandatory
- Yes
- Good to know
- Description
- If set to 'false' only one row can be marked as preselected.
removeLastAvailableRowFlashMessageTitle¶
- Data type
- string
- Needed by
- Backend (form editor)
- Mandatory
- Yes
- Good to know
- Description
- There must be at least one existing row within this
inspector editor
. If the last existing row is tried to be removed a flash message is shown. This property defines the title for the flash message.
removeLastAvailableRowFlashMessageMessage¶
- Data type
- string
- Needed by
- Backend (form editor)
- Mandatory
- Yes
- Good to know
- Description
- There must be at least one existing row within this
inspector editor
. If the last existing row is tried to be removed a flash message is shown. This property defines the text for the flash message.
shouldShowPreselectedValueColumn¶
- Data type
- string
- Needed by
- Backend (form editor)
- Mandatory
- Yes
- Good to know
- Description
- If set to 'false' the column which is used to mark a row as preselected will be disabled.