Skip to content
Snippets Groups Projects
Commit c2ad2f64 authored by Lukas Köhler's avatar Lukas Köhler Committed by Christian Kuhn
Browse files

[DOCS] Update finisher documentation

Update the finisher documentation to accomodate changes
made within the deprecation notices:

- remove mixins from finisher backend configuration
- add note to explain "mixins" have been removed in TYPO3 v11
- add a header as well as a removeButton in Backend UI config
  to restore functionality
- add a reminder to clear all caches to help newbies to see their
  changes while testing

Releases: main
Resolves: #99691
Change-Id: Icad673f1e23f595b6ffbae9afef8d01425bd1ea2
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/77556


Reviewed-by: default avatarBjörn Jacob <bjoern.jacob@tritum.de>
Tested-by: default avatarcore-ci <typo3@b13.com>
Tested-by: default avatarChristian Kuhn <lolli@schwarzbu.ch>
Tested-by: default avatarBjörn Jacob <bjoern.jacob@tritum.de>
Reviewed-by: default avatarChristian Kuhn <lolli@schwarzbu.ch>
parent d24434ed
Branches
Tags
No related merge requests found
...@@ -556,20 +556,25 @@ following to the backend yaml setup: ...@@ -556,20 +556,25 @@ following to the backend yaml setup:
25: 25:
identifier: 'CustomFinisher' identifier: 'CustomFinisher'
editors: editors:
__inheritances:
10: 'TYPO3.CMS.Form.mixins.formElementMixins.BaseCollectionEditorsMixin'
100: 100:
# add expandable header area
identifier: header
label: "Custom Finisher" label: "Custom Finisher"
# custom field (input, required) templateName: Inspector-CollectionElementHeaderEditor
105:
# add remove button
identifier: removeButton
templateName: Inspector-RemoveElementEditor
110: 110:
# add a field defined as a TextEditor
identifier: 'customField' identifier: 'customField'
templateName: 'Inspector-TextEditor' templateName: 'Inspector-TextEditor'
label: 'Custom Field' label: 'Custom Field'
propertyPath: 'options.customField' propertyPath: 'options.customField'
propertyValidators: propertyValidators:
10: 'NotEmpty' 10: 'NotEmpty'
# email field
120: 120:
# add another TextEditor
identifier: 'email' identifier: 'email'
templateName: 'Inspector-TextEditor' templateName: 'Inspector-TextEditor'
label: 'Subscribers email' label: 'Subscribers email'
...@@ -578,7 +583,6 @@ following to the backend yaml setup: ...@@ -578,7 +583,6 @@ following to the backend yaml setup:
propertyValidators: propertyValidators:
10: 'NotEmpty' 10: 'NotEmpty'
20: 'FormElementIdentifierWithinCurlyBracesInclusive' 20: 'FormElementIdentifierWithinCurlyBracesInclusive'
finishersDefinition: finishersDefinition:
CustomFinisher: CustomFinisher:
formEditor: formEditor:
...@@ -600,8 +604,13 @@ following to the backend yaml setup: ...@@ -600,8 +604,13 @@ following to the backend yaml setup:
label: 'Subscribers email' label: 'Subscribers email'
config: config:
type: 'text' type: 'text'
Keep in mind that ``mixins`` **have been removed in TYPO3 v11** (see `#89742 <https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/10.2/Deprecation-89742-FormMixins.html>`__).
Therefore, the header area as well as the remove button of the finisher have to be added manually
(as shown in the example above).
Make sure the setup file is registered in the backend: Make sure the setup file is registered in the backend and that you have cleared all caches in order
to get all of your changes applied.
.. code-block:: typoscript .. code-block:: typoscript
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment