diff --git a/typo3/sysext/form/Documentation/ApiReference/AbstractRenderable/getRootForm.rst b/typo3/sysext/form/Documentation/ApiReference/AbstractRenderable/getRootForm.rst new file mode 100644 index 0000000000000000000000000000000000000000..be1a280171640a5df686442e2e1a122ce22926c8 --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/AbstractRenderable/getRootForm.rst @@ -0,0 +1,10 @@ +getRootForm() +''''''''''''' + +Get the root form the element belongs to. + +Signature: + +.. code-block:: php + + public function getRootForm(): FormDefinition diff --git a/typo3/sysext/form/Documentation/ApiReference/AbstractRenderable/setIdentifier.rst b/typo3/sysext/form/Documentation/ApiReference/AbstractRenderable/setIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..5e17071b61ac7cf62f5ead1a70e0c4f305f0aa2a --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/AbstractRenderable/setIdentifier.rst @@ -0,0 +1,10 @@ +setIdentifier() +''''''''''''''' + +Set the identifier of the form element. + +Signature: + +.. code-block:: php + + public function setIdentifier(string $identifier); diff --git a/typo3/sysext/form/Documentation/ApiReference/AbstractRenderable/setLabel.rst b/typo3/sysext/form/Documentation/ApiReference/AbstractRenderable/setLabel.rst new file mode 100644 index 0000000000000000000000000000000000000000..63fd6d10deab07b64e89582d20493ade6228b5b0 --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/AbstractRenderable/setLabel.rst @@ -0,0 +1,10 @@ +setLabel() +'''''''''' + +Set the label for the form element. + +Signature: + +.. code-block:: php + + public function setLabel(string $label); diff --git a/typo3/sysext/form/Documentation/ApiReference/AbstractRenderable/setOptions.rst b/typo3/sysext/form/Documentation/ApiReference/AbstractRenderable/setOptions.rst new file mode 100644 index 0000000000000000000000000000000000000000..c2c2c9a9814490ce1a98ff28cc225cdba935753f --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/AbstractRenderable/setOptions.rst @@ -0,0 +1,11 @@ +setOptions() +'''''''''''' + +Set multiple properties of this object at once. +Every property which has a corresponding set* method can be set using the passed $options array. + +Signature: + +.. code-block:: php + + public function setOptions(array $options); diff --git a/typo3/sysext/form/Documentation/ApiReference/AbstractSection/addElement.rst b/typo3/sysext/form/Documentation/ApiReference/AbstractSection/addElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..178397dd6b760e27f69c6f39255b03c8609f6dfd --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/AbstractSection/addElement.rst @@ -0,0 +1,11 @@ +addElement() +'''''''''''' + +Add a new form element at the end. +Instead of this method, you should use ``createElement`` instead. + +Signature: + +.. code-block:: php + + public function addElement(FormElementInterface $formElement); diff --git a/typo3/sysext/form/Documentation/ApiReference/AbstractSection/getElements.rst b/typo3/sysext/form/Documentation/ApiReference/AbstractSection/getElements.rst new file mode 100644 index 0000000000000000000000000000000000000000..c8ac607195073722dfaee1e50882acbf37c249d0 --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/AbstractSection/getElements.rst @@ -0,0 +1,10 @@ +getElements() +''''''''''''' + +Get the child form elements. + +Signature: + +.. code-block:: php + + public function getElements(): array; diff --git a/typo3/sysext/form/Documentation/ApiReference/AbstractSection/getElementsRecursively.rst b/typo3/sysext/form/Documentation/ApiReference/AbstractSection/getElementsRecursively.rst new file mode 100644 index 0000000000000000000000000000000000000000..c3af97e435dde5ac670abe2ca150bf90fd94ffd9 --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/AbstractSection/getElementsRecursively.rst @@ -0,0 +1,10 @@ +getElementsRecursively() +'''''''''''''''''''''''' + +Returns all RenderableInterface instances of this composite renderable recursively. + +Signature: + +.. code-block:: php + + public function getElementsRecursively(): array; diff --git a/typo3/sysext/form/Documentation/ApiReference/AbstractSection/moveElementAfter.rst b/typo3/sysext/form/Documentation/ApiReference/AbstractSection/moveElementAfter.rst new file mode 100644 index 0000000000000000000000000000000000000000..2c8cb924eba4dbd7730ffd4f3b2f10399bc641f4 --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/AbstractSection/moveElementAfter.rst @@ -0,0 +1,11 @@ +moveElementAfter() +'''''''''''''''''' + +Move FormElement $elementToMove after $referenceElement. +Both $elementToMove and $referenceElement must be direct descendants of this Section/Page. + +Signature: + +.. code-block:: php + + public function moveElementAfter(FormElementInterface $elementToMove, FormElementInterface $referenceElement); diff --git a/typo3/sysext/form/Documentation/ApiReference/AbstractSection/moveElementBefore.rst b/typo3/sysext/form/Documentation/ApiReference/AbstractSection/moveElementBefore.rst new file mode 100644 index 0000000000000000000000000000000000000000..ee7ad5dacd6b021ae5fa0aaf591d565328a8a863 --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/AbstractSection/moveElementBefore.rst @@ -0,0 +1,11 @@ +moveElementBefore() +''''''''''''''''''' + +Move FormElement $elementToMove before $referenceElement. +Both $elementToMove and $referenceElement must be direct descendants of this Section/Page. + +Signature: + +.. code-block:: php + + public function moveElementBefore(FormElementInterface $elementToMove, FormElementInterface $referenceElement); diff --git a/typo3/sysext/form/Documentation/ApiReference/AbstractSection/removeElement.rst b/typo3/sysext/form/Documentation/ApiReference/AbstractSection/removeElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..841eed7dd45c9dfcd3d7bd0eea3d0cdb2bb97cd1 --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/AbstractSection/removeElement.rst @@ -0,0 +1,10 @@ +removeElement() +''''''''''''''' + +Remove $elementToRemove from this Section/Page. + +Signature: + +.. code-block:: php + + public function removeElement(FormElementInterface $elementToRemove); diff --git a/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/addValidator.rst b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/addValidator.rst new file mode 100644 index 0000000000000000000000000000000000000000..86e58147c791c3994acab8f2ec18d963504fdb90 --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/addValidator.rst @@ -0,0 +1,10 @@ +addValidator() +'''''''''''''' + +Registers a validator for the form element. + +Signature: + +.. code-block:: php + + public function addValidator(ValidatorInterface $validator); diff --git a/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/createValidator.rst b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/createValidator.rst new file mode 100644 index 0000000000000000000000000000000000000000..fa8f027801b187d099e788ac4e63b0c7e599fd59 --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/createValidator.rst @@ -0,0 +1,10 @@ +createValidator() +''''''''''''''''' + +Create a validator for the element. + +Signature: + +.. code-block:: php + + public function createValidator(string $validatorIdentifier, array $options = []); \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/getDefaultValue.rst b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/getDefaultValue.rst new file mode 100644 index 0000000000000000000000000000000000000000..013224a3585da21d77d1960300ddfa8cdbb4aeb0 --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/getDefaultValue.rst @@ -0,0 +1,10 @@ +getDefaultValue() +''''''''''''''''' + +Get the default value with which the form element should be initialized during display. + +Signature: + +.. code-block:: php + + public function getDefaultValue(); diff --git a/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/getProperties.rst b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/getProperties.rst new file mode 100644 index 0000000000000000000000000000000000000000..24803492d4ee36f55e3211a5d6c44211489e85d8 --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/getProperties.rst @@ -0,0 +1,10 @@ +getProperties() +''''''''''''''' + +Get all element-specific configuration properties. + +Signature: + +.. code-block:: php + + public function getProperties(): array; diff --git a/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/getUniqueIdentifier.rst b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/getUniqueIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..90353bb7ae6cd16be214a1fa5d2cf01f8b1f4ace --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/getUniqueIdentifier.rst @@ -0,0 +1,39 @@ +getUniqueIdentifier() +''''''''''''''''''''' + +Returns a unique identifier of the element. While element identifiers are only unique within one form, +this identifier includes also the identifier of the form itself, and therefore making it "globally" unique. + +Signature: + +.. code-block:: php + + public function getUniqueIdentifier(): string; + +Example: + +.. code-block:: yaml + + identifier: exampleForm + label: 'Simple Contact Form' + prototype: standard + type: Form + + renderables: + - + identifier: page-1 + label: 'Contact Form' + type: Page + + renderables: + - + identifier: name + label: 'Name' + type: Text + defaultValue: '' + +.. code-block:: php + + // $formElement->getIdentifier() == 'name' + $uniqueIdentifier = $formElement->getUniqueIdentifier(); + // $uniqueIdentifier == 'exampleForm-name' diff --git a/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/initializeFormElement.rst b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/initializeFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..03eb87713abe1e311d02c9ee2bbffefdfbe6bfdd --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/initializeFormElement.rst @@ -0,0 +1,10 @@ +initializeFormElement() +''''''''''''''''''''''' + +Will be called as soon as the element is (tried to be) added to a form. + +Signature: + +.. code-block:: php + + public function initializeFormElement(); diff --git a/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/isRequired.rst b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/isRequired.rst new file mode 100644 index 0000000000000000000000000000000000000000..233fee38a9497c87dbdfb9c6f80de1962b6b7bb8 --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/isRequired.rst @@ -0,0 +1,11 @@ +isRequired() +'''''''''''' + +Whether or not the element is required. +An element is required if the ``TYPO3\CMS\Extbase\Validation\Validator\NotEmptyValidator`` is attached to the element. + +Signature: + +.. code-block:: php + + public function isRequired(): bool; diff --git a/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/setDataType.rst b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/setDataType.rst new file mode 100644 index 0000000000000000000000000000000000000000..2495c1689dc8bc06298af9839c8e8a9c50438533 --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/setDataType.rst @@ -0,0 +1,20 @@ +setDataType() +''''''''''''' + +The target data type the data should be converted through the property mapper. + +Signature: + +.. code-block:: php + + public function setDataType(string $dataType); + +Example: + +.. code-block:: php + + public function initializeFormElement() + { + $this->setDataType('TYPO3\CMS\Extbase\Domain\Model\FileReference'); + parent::initializeFormElement(); + } \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/setDefaultValue.rst b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/setDefaultValue.rst new file mode 100644 index 0000000000000000000000000000000000000000..4695d01b0a429228c7818fa22afc6f583db3edef --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/setDefaultValue.rst @@ -0,0 +1,10 @@ +setDefaultValue() +''''''''''''''''' + +Set the default value with which the form element should be initialized during display. + +Signature: + +.. code-block:: php + + public function setDefaultValue($defaultValue); diff --git a/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/setProperty.rst b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/setProperty.rst new file mode 100644 index 0000000000000000000000000000000000000000..b66dbd2972f0595a9bc0ed943af23075f4401e56 --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/setProperty.rst @@ -0,0 +1,10 @@ +setProperty() +''''''''''''' + +Set an element-specific configuration property. + +Signature: + +.. code-block:: php + + public function setProperty(string $key, $value); diff --git a/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/setRenderingOption.rst b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/setRenderingOption.rst new file mode 100644 index 0000000000000000000000000000000000000000..21798094e00adf7af757603c6acdd08e6e68820f --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/FormElementInterface/setRenderingOption.rst @@ -0,0 +1,10 @@ +setRenderingOption() +'''''''''''''''''''' + +Set a rendering option. + +Signature: + +.. code-block:: php + + public function setRenderingOption(string $key, $value); diff --git a/typo3/sysext/form/Documentation/ApiReference/Index.rst b/typo3/sysext/form/Documentation/ApiReference/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..8d49b8ffce338a0f0997c085281b50d98981db73 --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/Index.rst @@ -0,0 +1,5649 @@ +.. include:: ../Includes.txt + + +.. _apireference: + +============= +API Reference +============= + +This chapter is a complete reference of the API of the form framework. It +mainly addresses your concerns as a developer. + + +.. _apireference-frontendrendering: + +Frontend rendering +================== + + +.. _apireference-frontendrendering-fluidformrenderer: + +TYPO3\\CMS\\Form\\Domain\\Renderer\\FluidFormRenderer +----------------------------------------------------- + + +.. _apireference-frontendrendering-fluidformrenderer-options: + +Options +^^^^^^^ + +The ``FluidFormRenderer`` uses some rendering options which are of particular importance, +as they determine how the form field is resolved to a path in the file system. + +All rendering options are retrieved from the ``FormDefinition``, using the ``TYPO3\CMS\Form\Domain\Model\FormDefinition::getRenderingOptions()`` method. + + +.. _apireference-frontendrendering-fluidformrenderer-options-templaterootpaths: + +templateRootPaths ++++++++++++++++++ + +Used to define several paths for templates, which will be tried in reversed order (the paths are searched from bottom to top). +The first folder where the desired template is found, is used. If the array keys are numeric, they are first sorted and then tried in reversed order. +Within this paths, fluid will search for a file which is named like the ``<formElementTypeIdentifier>``. + +For example: + +templateRootPaths.10 = EXT:form/Resources/Private/Frontend/Templates/ +$renderable->getType() == 'Form' +Expected template file: EXT:form/Resources/Private/Frontend/Templates/Form.html + +Only the root element (``FormDefinition``) has to be a template file. All child form elements are partials. By default, the root element is called ``Form``. + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + formElementsDefinition: + Form: + renderingOptions: + templateRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Templates/' + + +.. _apireference-frontendrendering-fluidformrenderer-options-layoutrootpaths: + +layoutRootPaths ++++++++++++++++ + +Used to define several paths for layouts, which will be tried in reversed order (the paths are searched from bottom to top). +The first folder where the desired layout is found, is used. If the array keys are numeric, they are first sorted and then tried in reversed order. + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + formElementsDefinition: + Form: + renderingOptions: + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Layouts/' + + +.. _apireference-frontendrendering-fluidformrenderer-options-partialrootpaths: + +partialRootPaths +++++++++++++++++ + +Used to define several paths for partials, which will be tried in reversed order. The first folder where the desired partial is found, is used. +The keys of the array define the order. + +Within this paths, fluid will search for a file which is named like the ``<formElementTypeIdentifier>``. + +For example: + +templateRootPaths.10 = EXT:form/Resources/Private/Frontend/Partials/ +$renderable->getType() == 'Text' +Expected template file: EXT:form/Resources/Private/Frontend/Partials/Text.html + +There is a setting available to set a custom partial name. Please read the section :ref:`templateName<apireference-frontendrendering-fluidformrenderer-options-templatename>`. + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + formElementsDefinition: + Form: + renderingOptions: + partialRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Partials/' + + +.. _apireference-frontendrendering-fluidformrenderer-options-templatename: + +templateName +++++++++++++ + +By default, the renderable type will be taken as the name for the partial. + +For example: + +partialRootPaths.10 = EXT:form/Resources/Private/Frontend/Partials/ +$renderable->getType() == 'Text' +Expected partial file: EXT:form/Resources/Private/Frontend/Partials/Text.html + +Set ``templateName`` to define a custom name which should be used instead. + +For example: + +$renderable->getTemplateName() == 'Text' +$renderable->getType() = Foo +Expected partial file: EXT:form/Resources/Private/Frontend/Partials/Text.html + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + formElementsDefinition: + Foo: + renderingOptions: + templateName: 'Text' + + +.. _apireference-frontendrendering-renderviewHelper: + +"render" viewHelper +------------------- + +.. _apireference-frontendrendering-renderviewHelper-arguments: + +Argumentes +^^^^^^^^^^ + +.. _apireference-frontendrendering-renderviewHelper-factoryclass: + +factoryClass +++++++++++++ + +A class name of a ``FormFactory``. +This factory is used to create the ``TYPO3\CMS\Form\Domain\Model\FormDefinition`` which is the ``form definition`` Domain Model. +If no ``factoryClass`` argument is passed, the factory supplied by EXT:form ``TYPO3\CMS\Form\ Domain\Factory\ArrayFormFactory`` is used. +Another factory class is required if the form is to be generated programmatically. +To do this you must implement your own ``FormFactory`` in which your own form is generated programmatically and passes this class name to the ViewHelper. +This then renders the form. + +.. code-block:: html + + <formvh:render factoryClass="VENDOR\MySitePackage\Domain\Factory\CustomFormFactory" /> + + +.. _apireference-frontendrendering-renderviewHelper-persistenceidentifier: + +persistenceIdentifier ++++++++++++++++++++++ + +The ``form definition`` to be found under ``persistenceIdentifier``. +The PersistenceManager now loads the ``form definition`` which is found under ``persistenceIdentifier`` and passes this configuration to the ``factoryClass``. +In this case, the ``factoryClass`` will be given an empty configuration array (if ``overrideConfiguration`` is not specified). + +.. code-block:: html + + <formvh:render persistenceIdentifier="EXT:my_site_package/Resources/Private/Forms/SimpleContactForm.yaml" /> + + +.. _apireference-frontendrendering-renderviewHelper-overrideconfiguration: + +overrideConfiguration ++++++++++++++++++++++ + +A configuration to be superimposed can be entered here. +If a ``persistenceIdentifier`` is specified, the ``form definition`` which is found under ``persistenceIdentifier`` is loaded. +This configuration is then superimposed with ``overrideConfiguration``. This configuration is then passed to the ``factoryClass``. +If no ``persistenceIdentifier`` is specified, ``overrideConfiguration`` is passed directly to the ``factoryClass``. +This way a configuration can be given to a ``factoryClass`` implementation. + + +.. _apireference-frontendrendering-renderviewHelper-prototypename: + +prototypeName ++++++++++++++ + +The name of the prototype, on which basis the ``factoryClass`` should create the form. +If nothing is specified, the configuration (``form definition`` or ``overrideConfiguration``) is searched for the prototy name. +If no specification exists, the standard prototype ``standard`` is used. + + + +.. _apireference-frontendrendering-programmatically: + +Build forms programmatically +---------------------------- + +Implement a ``FormFactory`` and build the form. + +.. code-block:: php + + <?php + declare(strict_types=1); + namespace VENDOR\MySitePackage\Domain\Factory; + + use TYPO3\CMS\Core\Utility\GeneralUtility; + use TYPO3\CMS\Extbase\Object\ObjectManager; + use TYPO3\CMS\Extbase\Validation\Validator\NotEmptyValidator; + use TYPO3\CMS\Extbase\Validation\Validator\StringLengthValidator; + use TYPO3\CMS\Form\Domain\Configuration\ConfigurationService; + use TYPO3\CMS\Form\Domain\Factory\AbstractFormFactory; + use TYPO3\CMS\Form\Domain\Model\FormDefinition; + + class CustomFormFactory extends AbstractFormFactory + { + + /** + * Build a FormDefinition. + * This example build a FormDefinition manually, + * so $configuration and $prototypeName are unused. + * + * @param array $configuration + * @param string $prototypeName + * @return FormDefinition + */ + public function build(array $configuration, string $prototypeName = null): FormDefinition + { + $prototypeName = 'standard'; + $configurationService = GeneralUtility::makeInstance(ObjectManager::class)->get(ConfigurationService::class); + $prototypeConfiguration = $configurationService->getPrototypeConfiguration($prototypeName); + + $form = GeneralUtility::makeInstance(ObjectManager::class)->get(FormDefinition::class, 'MyCustomForm', $prototypeConfiguration); + $form->setRenderingOption('controllerAction', 'index'); + + $page1 = $form->createPage('page1'); + $name = $page1->createElement('name', 'Text'); + $name->setLabel('Name'); + $name->addValidator(GeneralUtility::makeInstance(ObjectManager::class)->get(NotEmptyValidator::class)); + + $page2 = $form->createPage('page2'); + $message = $page2->createElement('message', 'Textarea'); + $message->setLabel('Message'); + $message->addValidator(GeneralUtility::makeInstance(ObjectManager::class)->get(StringLengthValidator::class, ['minimum' => 5, 'maximum' => 20])); + + $form->createFinisher('EmailToSender', [ + 'subject' => 'Hello', + 'recipientAddress' => 'foo@example.com', + 'senderAddress' => 'bar@example.com', + ]); + + $this->triggerFormBuildingFinished($form); + return $form; + } + } + + +Use this form within your fluid template. + +.. code-block:: html + + <formvh:render factoryClass="VENDOR\MySitePackage\Domain\Factory\CustomFormFactory" /> + + +.. _apireference-frontendrendering-programmatically-commonapimethods: + +Common API Methods +^^^^^^^^^^^^^^^^^^ + + +.. _apireference-frontendrendering-programmatically-commonapimethods-createpage: + +TYPO3\\CMS\\Form\\Domain\\Model\\FormDefinition::createPage() ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +Create a page with the given $identifier and attach this page to the form. + +- Create Page object based on the given $typeName +- set defaults inside the Page object +- attach Page object to this form +- return the newly created Page object + +Signature: + +.. code-block:: php + + public function createPage(string $identifier, string $typeName = 'Page'): Page; + + +.. _apireference-frontendrendering-programmatically-commonapimethods-createfinisher: + +TYPO3\\CMS\\Form\\Domain\\Model\\FormDefinition::createFinisher() ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +Create a finisher with the given $identifier and given $options and attach this finisher to the form. + +Signature: + +.. code-block:: php + + public function createFinisher(string $finisherIdentifier, array $options = []): FinisherInterface; + + +.. _apireference-frontendrendering-programmatically-commonapimethods-page-createelement: + +TYPO3\\CMS\\Form\\Domain\\Model\\FormElements\\Page::createElement() +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +Create a form element with the given $identifier and attach it to the page. + +- Create Form Element object based on the given $typeName +- set defaults inside the Form Element (based on the parent form's field defaults) +- attach Form Element to the Page +- return the newly created Form Element object + +Signature: + +.. code-block:: php + + public function createElement(string $identifier, string $typeName): FormElementInterface; + + +.. _apireference-frontendrendering-programmatically-commonapimethods-section-createelement: + +TYPO3\\CMS\\Form\\Domain\\Model\\FormElements\\Section::createElement() ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +Create a form element with the given $identifier and attach it to the section. + +- Create Form Element object based on the given $typeName +- set defaults inside the Form Element (based on the parent form's field defaults) +- attach Form Element to the Section +- return the newly created Form Element object + +Signature: + +.. code-block:: php + + public function createElement(string $identifier, string $typeName): FormElementInterface; + + +.. _apireference-frontendrendering-programmatically-commonapimethods-abstractrenderable-createvalidator: + +TYPO3\\CMS\\Form\\Domain\\Model\\Renderable\\AbstractFormElement::createValidator() ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +Create a validator for the element. +Mainly possible for + +- TYPO3\\CMS\\Form\\Domain\\Model\\FormElements\\AdvancedPassword +- TYPO3\\CMS\\Form\\Domain\\Model\\FormElements\\GenericFormElement +- TYPO3\\CMS\\Form\\Domain\\Model\\FormElements\\DatePicker +- TYPO3\\CMS\\Form\\Domain\\Model\\FormElements\\FileUpload + +Signature: + +.. code-block:: php + + public function createValidator(string $validatorIdentifier, array $options = []); + + +.. _apireference-frontendrendering-programmatically-commonapimethods-initializeformelement: + +initializeFormElement() ++++++++++++++++++++++++ + +Will be called as soon as the element is added to a form. +Possible for + +- TYPO3\\CMS\\Form\\Domain\\Model\\FormElements\\Section +- TYPO3\\CMS\\Form\\Domain\\Model\\FormElements\\AdvancedPassword +- TYPO3\\CMS\\Form\\Domain\\Model\\FormElements\\GenericFormElement +- TYPO3\\CMS\\Form\\Domain\\Model\\FormElements\\DatePicker +- TYPO3\\CMS\\Form\\Domain\\Model\\FormElements\\FileUpload + +Signature: + +.. code-block:: php + + public function initializeFormElement(); + + +You can use this method to prefill form element data for example from database tables. +All the classes you can see above extends from the ``TYPO3\CMS\Form\Domain\Model\FormElement\AbstractFormElement``. +``AbstractFormElement`` implements this method like this + +.. code-block:: php + + public function initializeFormElement() + { + if ( + isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['initializeFormElement']) + && is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['initializeFormElement']) + ) { + foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['initializeFormElement'] as $className) { + $hookObj = GeneralUtility::makeInstance($className); + if (method_exists($hookObj, 'initializeFormElement')) { + $hookObj->initializeFormElement( + $this + ); + } + } + } + } + +If you extend you custom implementation from ``AbstractFormElement`` (and you should do this), +it enables you to override the 'initializeFormElement' method within your custom implementation class. +If you do not call the parents 'initializeFormElement' then no hook will be thrown. + +If your use case for a custom form element implementation means that you only want to initialize you form element +programmatically (e.g to get databasedata) and no other special things are to do, you might prefer the hook. +You only need a class which connects to this hook. Then detect the form element you wish to initialize. + + +.. _apireference-frontendrendering-programmatically-apimethods: + +API Methods +^^^^^^^^^^^ + + +.. _apireference-frontendrendering-programmatically-apimethods-formruntime: + +TYPO3\\CMS\\Form\\Domain\\Model\\FormRuntime +++++++++++++++++++++++++++++++++++++++++++++ + + +.. _apireference-frontendrendering-programmatically-apimethods-formruntime-overridecurrentpage: + +overrideCurrentPage() +''''''''''''''''''''' + +Override the current page taken from the request, rendering the page with index $pageIndex instead. +This is typically not needed in production code. +You might prefer the hook :ref:`afterInitializeCurrentPage <apireference-frontendrendering-runtimemanipulation-hooks-afterinitializecurrentpage>` + +Signature: + +.. code-block:: php + + public function overrideCurrentPage(int $pageIndex); + +Example: + +.. code-block:: php + + $form = $formDefinition->bind($this->request, $this->response); + $form->overrideCurrentPage($pageIndex); + + +.. _apireference-frontendrendering-programmatically-apimethods-formruntime-render: + +render() +'''''''' + +Render the form. + +Signature: + +.. code-block:: php + + public function render(); + + +.. _apireference-frontendrendering-programmatically-apimethods-formruntime-getidentifier: +.. include:: RootRenderableInterface/getIdentifier.rst + +.. _apireference-frontendrendering-programmatically-apimethods-formruntime-getrequest: + +getRequest() +'''''''''''' + +Get the request this object is bound to. +This is mostly relevant inside Finishers, where you f.e. want to redirect the user to another page. + +Signature: + +.. code-block:: php + + public function getRequest(): Request; + + +.. _apireference-frontendrendering-programmatically-apimethods-formruntime-getresponse: + +getResponse() +''''''''''''' + +Get the response this object is bound to. +This is mostly relevant inside Finishers, where you f.e. want to set response headers or output content. + +Signature: + +.. code-block:: php + + public function getResponse(): Response; + + +.. _apireference-frontendrendering-programmatically-apimethods-formruntime-getcurrentpage: + +getCurrentPage() +'''''''''''''''' + +Returns the currently selected page. + +Signature: + +.. code-block:: php + + public function getCurrentPage(): Page; + + +.. _apireference-frontendrendering-programmatically-apimethods-formruntime-getpreviouspage: + +getPreviousPage() +''''''''''''''''' + +Returns the previous page of the currently selected one or NULL if there is no previous page. + +Signature: + +.. code-block:: php + + public function getPreviousPage(); + + +.. _apireference-frontendrendering-programmatically-apimethods-formruntime-getnextpage: + +getNextPage() +''''''''''''' + +Returns the next page of the currently selected one or NULL if there is no next page. + +Signature: + +.. code-block:: php + + public function getNextPage(); + + +.. _apireference-frontendrendering-programmatically-apimethods-formruntime-gettype: +.. include:: RootRenderableInterface/getType.rst + + +.. _apireference-frontendrendering-programmatically-apimethods-formruntime-getelementvalue: + +getElementValue() +''''''''''''''''' + +Returns the value of the specified element. + +Signature: + +.. code-block:: php + + public function getElementValue(string $identifier); + + +.. _apireference-frontendrendering-programmatically-apimethods-formruntime-getpages: + +getPages() +'''''''''' + +Return the form's pages in the correct order. + +Signature: + +.. code-block:: php + + public function getPages(): array; + + +.. _apireference-frontendrendering-programmatically-apimethods-formruntime-getrenderingoptions: +.. include:: RootRenderableInterface/getRenderingOptions.rst + +.. _apireference-frontendrendering-programmatically-apimethods-formruntime-getrendererclassname: +.. include:: RootRenderableInterface/getRendererClassName.rst + + +.. _apireference-frontendrendering-programmatically-apimethods-formruntime-getlabel: +.. include:: RootRenderableInterface/getLabel.rst + +.. _apireference-frontendrendering-programmatically-apimethods-formruntime-gettemplatename: +.. include:: RenderableInterface/getTemplateName.rst + +.. _apireference-frontendrendering-programmatically-apimethods-formruntime-getformdefinition: + +getFormDefinition() +''''''''''''''''''' + +Get the underlying form definition from the runtime. + +Signature: + +.. code-block:: php + + public function getFormDefinition(): FormDefinition; + + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition: + +TYPO3\\CMS\\Form\\Domain\\Model\\FormDefinition ++++++++++++++++++++++++++++++++++++++++++++++++ + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-addpage: + +addPage() +''''''''' + +Add a new page at the end of the form. +Instead of this method, you should use ``createPage`` instead. + +Signature: + +.. code-block:: php + + public function addPage(Page $page); + + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-createpage: + +createPage() +'''''''''''' + +Create a page with the given $identifier and attach this page to the form. + +- Create Page object based on the given $typeName +- set defaults inside the Page object +- attach Page object to this form +- return the newly created Page object + +Signature: + +.. code-block:: php + + public function createPage(string $identifier, string $typeName = 'Page'): Page; + + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-getpages: + +getPages() +'''''''''' + +Return the form's pages in the correct order. + +Signature: + +.. code-block:: php + + public function getPages(): array; + + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-haspagewithindex: + +hasPageWithIndex() +'''''''''''''''''' + +Check whether a page with the given $index exists. + +Signature: + +.. code-block:: php + + public function hasPageWithIndex(int $index): bool; + + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-getpagebyindex: + +getPageByIndex() +'''''''''''''''' + +Get the page with the passed index. The first page has index zero. +If page at $index does not exist, an exception is thrown. + +Signature: + +.. code-block:: php + + public function getPageByIndex(int $index); + + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-addfinisher: + +addFinisher() +''''''''''''' + +Adds the specified finisher to the form. +Instead of this method, you should use ``createFinisher`` instead. + +Signature: + +.. code-block:: php + + public function addFinisher(FinisherInterface $finisher); + + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-createfinisher: + +createFinisher() +'''''''''''''''' + +Create a finisher with the given $identifier and given $options and attach this finisher to the form. + +Signature: + +.. code-block:: php + + public function createFinisher(string $finisherIdentifier, array $options = []): FinisherInterface; + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-getfinishers: + +getFinishers() +'''''''''''''' + +Gets all finishers of the form. + +Signature: + +.. code-block:: php + + public function getFinishers(): array; + + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-getelementbyidentifier: + +getElementByIdentifier() +'''''''''''''''''''''''' + +Get a form element by its identifier. +If identifier does not exist, returns NULL. + +Signature: + +.. code-block:: php + + public function getElementByIdentifier(string $elementIdentifier); + + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-movepageafter: + +movePageAfter() +''''''''''''''' + +Move $pageToMove after $referencePage. + +Signature: + +.. code-block:: php + + public function movePageAfter(Page $pageToMove, Page $referencePage); + + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-removepage: + +removePage() +'''''''''''' + +Remove $pageToRemove from the form. + +Signature: + +.. code-block:: php + + public function removePage(Page $pageToRemove); + + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-bind: + +bind() +'''''' + +Bind the current request and response to this form instance, effectively creating a new "instance" of the Form. + +Signature: + +.. code-block:: php + + public function bind(Request $request, Response $response): FormRuntime; + + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-getprocessingrule: + +getProcessingRule() +''''''''''''''''''' + +Get the processing rule which contains information for property mappings and validations. + +Signature: + +.. code-block:: php + + public function getProcessingRule(string $propertyPath): ProcessingRule; + + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-gettype: +.. include:: RootRenderableInterface/getType.rst + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-getidentifier: +.. include:: RootRenderableInterface/getIdentifier.rst + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-setidentifier: +.. include:: AbstractRenderable/setIdentifier.rst + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-setoptions: +.. include:: AbstractRenderable/setOptions.rst + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-addvalidator: +.. include:: FormElementInterface/addValidator.rst + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-setdatatype: +.. include:: FormElementInterface/setDataType.rst + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-getrendererclassname: +.. include:: RootRenderableInterface/getRendererClassName.rst + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-setrendererclassname: + +setRendererClassName() +'''''''''''''''''''''' + +Set the renderer class name. + +Signature: + +.. code-block:: php + + public function setRendererClassName(string $rendererClassName); + + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-getrenderingoptions: +.. include:: RootRenderableInterface/getRenderingOptions.rst + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-setrenderingoption: +.. include:: FormElementInterface/setRenderingOption.rst + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-getparentrenderable: +.. include:: RenderableInterface/getParentRenderable.rst + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-setparentrenderable: +.. include:: RenderableInterface/setParentRenderable.rst + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-getrootform: +.. include:: AbstractRenderable/getRootForm.rst + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-getlabel: +.. include:: RootRenderableInterface/getLabel.rst + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-setlabel: +.. include:: AbstractRenderable/setLabel.rst + +.. _apireference-frontendrendering-programmatically-apimethods-formdefinition-gettemplatename: +.. include:: RenderableInterface/getTemplateName.rst + + +.. _apireference-frontendrendering-programmatically-apimethods-page: + +TYPO3\\CMS\\Form\\Domain\\Model\\FormElements\\Page ++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. _apireference-frontendrendering-programmatically-apimethods-page-getelements: +.. include:: AbstractSection/getElements.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-getelementsrecursively: +.. include:: AbstractSection/getElementsRecursively.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-addelement: +.. include:: AbstractSection/addElement.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-createelement: + +createElement() +''''''''''''''' + +Create a form element with the given $identifier and attach it to the page. + +- Create Form Element object based on the given $typeName +- set defaults inside the Form Element (based on the parent form's field defaults) +- attach Form Element to the Page +- return the newly created Form Element object + +Signature: + +.. code-block:: php + + public function createElement(string $identifier, string $typeName): FormElementInterface; + + +.. _apireference-frontendrendering-programmatically-apimethods-page-moveelementbefore: +.. include:: AbstractSection/moveElementBefore.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-moveelementafter: +.. include:: AbstractSection/moveElementAfter.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-removeelement: +.. include:: AbstractSection/removeElement.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-gettype: +.. include:: RootRenderableInterface/getType.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-getidentifier: +.. include:: RootRenderableInterface/getIdentifier.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-setidentifier: +.. include:: AbstractRenderable/setIdentifier.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-setoptions: +.. include:: AbstractRenderable/setOptions.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-addvalidator: +.. include:: FormElementInterface/addValidator.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-createvalidator: +.. include:: FormElementInterface/createValidator.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-setdatatype: +.. include:: FormElementInterface/setDataType.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-getrendererclassname: +.. include:: RootRenderableInterface/getRendererClassName.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-getrenderingoptions: +.. include:: RootRenderableInterface/getRenderingOptions.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-setrenderingoption: +.. include:: FormElementInterface/setRenderingOption.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-getparentrenderable: +.. include:: RenderableInterface/getParentRenderable.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-setparentrenderable: +.. include:: RenderableInterface/setParentRenderable.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-getrootform: +.. include:: AbstractRenderable/getRootForm.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-getlabel: +.. include:: RootRenderableInterface/getLabel.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-setlabel: +.. include:: AbstractRenderable/setLabel.rst + +.. _apireference-frontendrendering-programmatically-apimethods-page-gettemplatename: +.. include:: RenderableInterface/getTemplateName.rst + + +.. _apireference-frontendrendering-programmatically-apimethods-section: + +TYPO3\\CMS\\Form\\Domain\\Model\\FormElements\\Section +++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. _apireference-frontendrendering-programmatically-apimethods-section-initializeformelement: +.. include:: FormElementInterface/initializeFormElement.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-getuniqueidentifier: +.. include:: FormElementInterface/getUniqueIdentifier.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-setproperty: +.. include:: FormElementInterface/setProperty.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-getproperties: +.. include:: FormElementInterface/getProperties.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-isrequired: +.. include:: FormElementInterface/isRequired.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-getelements: +.. include:: AbstractSection/getElements.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-getelementsrecursively: +.. include:: AbstractSection/getElementsRecursively.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-addelement: +.. include:: AbstractSection/addElement.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-createelement: + +createElement() +''''''''''''''' + +Create a form element with the given $identifier and attach it to the section. + +- Create Form Element object based on the given $typeName +- set defaults inside the Form Element (based on the parent form's field defaults) +- attach Form Element to the Section +- return the newly created Form Element object + +Signature: + +.. code-block:: php + + public function createElement(string $identifier, string $typeName): FormElementInterface; + + +.. _apireference-frontendrendering-programmatically-apimethods-section-moveelementbefore: +.. include:: AbstractSection/moveElementBefore.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-moveelementafter: +.. include:: AbstractSection/moveElementAfter.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-removeelement: +.. include:: AbstractSection/removeElement.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-gettype: +.. include:: RootRenderableInterface/getType.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-getidentifier: +.. include:: RootRenderableInterface/getIdentifier.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-setidentifier: +.. include:: AbstractRenderable/setIdentifier.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-setoptions: +.. include:: AbstractRenderable/setOptions.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-addvalidator: +.. include:: FormElementInterface/addValidator.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-createvalidator: +.. include:: FormElementInterface/createValidator.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-setdatatype: +.. include:: FormElementInterface/setDataType.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-getrendererclassname: +.. include:: RootRenderableInterface/getRendererClassName.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-getrenderingoptions: +.. include:: RootRenderableInterface/getRenderingOptions.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-setrenderingoption: +.. include:: FormElementInterface/setRenderingOption.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-getparentrenderable: +.. include:: RenderableInterface/getParentRenderable.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-setparentrenderable: +.. include:: RenderableInterface/setParentRenderable.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-getrootform: +.. include:: AbstractRenderable/getRootForm.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-getlabel: +.. include:: RootRenderableInterface/getLabel.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-setlabel: +.. include:: AbstractRenderable/setLabel.rst + +.. _apireference-frontendrendering-programmatically-apimethods-section-gettemplatename: +.. include:: RenderableInterface/getTemplateName.rst + + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement: + +TYPO3\\CMS\\Form\\Domain\\Model\\FormElements\\AbstractFormElement +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +The following classes extends from ``AbstractFormElement`` and therefore contain the following API methods. + +- TYPO3\\CMS\\Form\\Domain\\Model\\FormElements\\AdvancedPassword +- TYPO3\\CMS\\Form\\Domain\\Model\\FormElements\\GenericFormElement +- TYPO3\\CMS\\Form\\Domain\\Model\\FormElements\\DatePicker +- TYPO3\\CMS\\Form\\Domain\\Model\\FormElements\\FileUpload + + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-initializeformelement: +.. include:: FormElementInterface/initializeFormElement.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-getuniqueidentifier: +.. include:: FormElementInterface/getUniqueIdentifier.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-getdefaultvalue: +.. include:: FormElementInterface/getDefaultValue.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-setdefaultvalue: +.. include:: FormElementInterface/setDefaultValue.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-setproperty: +.. include:: FormElementInterface/setProperty.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-getproperties: +.. include:: FormElementInterface/getProperties.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-isrequired: +.. include:: FormElementInterface/isRequired.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-gettype: +.. include:: RootRenderableInterface/getType.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-getidentifier: +.. include:: RootRenderableInterface/getIdentifier.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-setidentifier: +.. include:: AbstractRenderable/setIdentifier.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-setoptions: +.. include:: AbstractRenderable/setOptions.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-addvalidator: +.. include:: FormElementInterface/addValidator.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-createvalidator: +.. include:: FormElementInterface/createValidator.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-setdatatype: +.. include:: FormElementInterface/setDataType.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-getrendererclassname: +.. include:: RootRenderableInterface/getRendererClassName.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-getrenderingoptions: +.. include:: RootRenderableInterface/getRenderingOptions.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-setrenderingoption: +.. include:: FormElementInterface/setRenderingOption.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-getparentrenderable: +.. include:: RenderableInterface/getParentRenderable.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-setparentrenderable: +.. include:: RenderableInterface/setParentRenderable.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-getrootform: +.. include:: AbstractRenderable/getRootForm.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-getlabel: +.. include:: RootRenderableInterface/getLabel.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-setlabel: +.. include:: AbstractRenderable/setLabel.rst + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformelement-gettemplatename: +.. include:: RenderableInterface/getTemplateName.rst + + +.. _apireference-frontendrendering-programmatically-apimethods-abstractfinisher: + +TYPO3\\CMS\\Form\\Domain\\Finishers\\AbstractFinisher ++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +The following classes extends from ``AbstractFinisher`` and therefore contain the following API methods. + +- TYPO3\\CMS\\Form\\Domain\\Finishers\\ClosureFinisher +- TYPO3\\CMS\\Form\\Domain\\Finishers\\ConfirmationFinisher +- TYPO3\\CMS\\Form\\Domain\\Finishers\\DeleteUploadsFinisher +- TYPO3\\CMS\\Form\\Domain\\Finishers\\EmailFinisher +- TYPO3\\CMS\\Form\\Domain\\Finishers\\FlashMessageFinisher +- TYPO3\\CMS\\Form\\Domain\\Finishers\\RedirectFinisher +- TYPO3\\CMS\\Form\\Domain\\Finishers\\SaveToDatabaseFinisher + + +.. _apireference-frontendrendering-programmatically-apimethods-abstractfinisher-execute: + +execute() +''''''''' + +Executes the finisher. ``AbstractFinisher::execute()`` call ``$this->executeInternal()`` at the end. Own finisher +implementations which extends from ``AbstractFinisher:`` must start their own logic within ``executeInternal()``. + +Signature: + +.. code-block:: php + + public function execute(FinisherContext $finisherContext); + + +.. _apireference-frontendrendering-programmatically-apimethods-abstractfinisher-setoptions: + +setOptions() +'''''''''''' + +Set the finisher options. Instead of directly accessing them, you should rather use ``parseOption()``. + +Signature: + +.. code-block:: php + + public function setOptions(array $options); + + +.. _apireference-frontendrendering-programmatically-apimethods-abstractfinisher-setoption: + +setOption() +''''''''''' + +Sets a single finisher option. + +Signature: + +.. code-block:: php + + public function setOption(string $optionName, $optionValue); + + +.. _apireference-frontendrendering-programmatically-apimethods-abstractfinisher-parseoption: + +parseOption() +''''''''''''' + +Please read :ref:`Accessing finisher options<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions>` + +Signature: + +.. code-block:: php + + protected function parseOption(string $optionName); + + +.. _apireference-frontendrendering-programmatically-apimethods-finishercontext: + +TYPO3\\CMS\\Form\\Domain\\Finishers\\FinisherContext +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. _apireference-frontendrendering-programmatically-apimethods-finishercontext-cancel: + +cancel() +'''''''' + +Cancels the finisher invocation after the current finisher. + +Signature: + +.. code-block:: php + + public function cancel(); + + +.. _apireference-frontendrendering-programmatically-apimethods-finishercontext-getformruntime: + +getFormRuntime() +'''''''''''''''' + +The Form Runtime that is associated with the current finisher. + +Signature: + +.. code-block:: php + + public function getFormRuntime(): FormRuntime; + + +.. _apireference-frontendrendering-programmatically-apimethods-finishercontext-getformvalues: + +getFormValues() +''''''''''''''' + +The values of the submitted form (after validation and property mapping). + +Signature: + +.. code-block:: php + + public function getFormValues(): array; + + +.. _apireference-frontendrendering-programmatically-apimethods-finishercontext-getcontrollercontext: + +getControllerContext() +'''''''''''''''''''''' + +Returns the current ControllerContext. + +Signature: + +.. code-block:: php + + public function getControllerContext(): ControllerContext; + + +.. _apireference-frontendrendering-programmatically-apimethods-finishercontext-getfinishervariableprovider: + +getFinisherVariableProvider() +''''''''''''''''''''''''''''' + +Returns the current FinisherVariableProvider. + +Signature: + +.. code-block:: php + + public function getFinisherVariableProvider(): FinisherVariableProvider; + + +.. _apireference-frontendrendering-programmatically-apimethods-finishervariableprovider: + +TYPO3\\CMS\\Form\\Domain\\Finishers\\FinisherVariableProvider ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +Please read :ref:`Share data between finishers<concepts-frontendrendering-codecomponents-customfinisherimplementations-finishercontext-sharedatabetweenfinishers>` + +.. _apireference-frontendrendering-programmatically-apimethods-finishervariableprovider-add: + +add() +''''' + +Add a variable to the finisher variable provider. +In case the value is already inside, it is silently overridden. + +Signature: + +.. code-block:: php + + public function add(string $finisherIdentifier, string $key, $value); + + +.. _apireference-frontendrendering-programmatically-apimethods-finishervariableprovider-get: + +get() +''''' + +Gets a variable from the finisher variable provider. + +Signature: + +.. code-block:: php + + public function get(string $finisherIdentifier, string $key, $default = null); + + +.. _apireference-frontendrendering-programmatically-apimethods-finishervariableprovider-exists: + +exists() +'''''''' + +Determine whether there is a variable stored for the given key. + +Signature: + +.. code-block:: php + + public function exists($finisherIdentifier, $key): bool; + + +.. _apireference-frontendrendering-programmatically-apimethods-finishervariableprovider-remove: + +remove() +'''''''' + +Remove a value from the finisher variable provider. + +Signature: + +.. code-block:: php + + public function remove(string $finisherIdentifier, string $key); + + +.. _apireference-frontendrendering-programmatically-apimethods-configurationservice: + +TYPO3\\CMS\\Form\\Domain\\Configuration\\ConfigurationService ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. _apireference-frontendrendering-programmatically-apimethods-configurationservice-getprototypeconfiguration: + +getPrototypeConfiguration() +''''''''''''''''''''''''''' + +Get the configuration for a given $prototypeName + +Signature: + +.. code-block:: php + + public function getPrototypeConfiguration(string $prototypeName): array; + + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformfactory: + +TYPO3\\CMS\\Form\\Domain\\Factory\\AbstractFormFactory +++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. _apireference-frontendrendering-programmatically-apimethods-abstractformfactory-triggerformbuildingfinished: + +triggerFormBuildingFinished() +''''''''''''''''''''''''''''' + +Helper to be called by every ``FormFactory`` which extends from ``AbstractFormFactory`` after +everything has been built to call the "afterBuildingFinished" hook on all form elements. + +Signature: + +.. code-block:: php + + protected function triggerFormBuildingFinished(FormDefinition $form); + + +.. _apireference-frontendrendering-programmatically-apimethods-formfactoryinterface: + +TYPO3\\CMS\\Form\\Domain\\Factory\\FormFactoryInterface ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. _apireference-frontendrendering-programmatically-apimethods-formfactoryinterface-build: + +build() +''''''' + +Build a form definition, depending on some configuration. + +Signature: + +.. code-block:: php + + public function build(array $configuration, string $prototypeName = null): FormDefinition; + + +.. _apireference-frontendrendering-programmatically-apimethods-rendererinterface: + +TYPO3\\CMS\\Form\\Domain\\Renderer\\RendererInterface ++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. _apireference-frontendrendering-programmatically-apimethods-rendererinterface-setcontrollercontext: + +setControllerContext() +'''''''''''''''''''''' + +Set the controller context which should be used + +.. code-block:: php + + public function setControllerContext(ControllerContext $controllerContext); + + +.. _apireference-frontendrendering-programmatically-apimethods-rendererinterface-render: + +render() +'''''''' + +Renders the FormDefinition. This method is expected to call the ``beforeRendering`` hook on each form element. + +.. code-block:: php + + public function render(): string; + + +.. _apireference-frontendrendering-programmatically-apimethods-rendererinterface-setformruntime: + +setFormRuntime() +'''''''''''''''' + +Set the current ``FormRuntime``. + +.. code-block:: php + + public function setFormRuntime(FormRuntime $formRuntime); + + +.. _apireference-frontendrendering-programmatically-apimethods-rendererinterface-getformruntime: + +getFormRuntime() +'''''''''''''''' + +Get the current ``FormRuntime``. + +.. code-block:: php + + public function getFormRuntime(): FormRuntime; + + + +.. _apireference-frontendrendering-runtimemanipulation: + +Runtime manipulation +-------------------- + +.. _apireference-frontendrendering-runtimemanipulation-hooks: + +Hooks +^^^^^ + + +.. _apireference-frontendrendering-runtimemanipulation-hooks-initializeformelement: + +initializeFormElement ++++++++++++++++++++++ + +You can connect to the hook and initialize a form elements without defining a custom implementaion to access the element's ``initializeFormElement`` method. +You only need a class which connects to this hook. Then detect the form element you wish to initialize. +You can use this hook to prefill form element data for example from database tables. + +This hook is invoked by the methods ``TYPO3\CMS\Form\Domain\Model\FormElements\Page::createElement()`` and ``TYPO3\CMS\Form\Domain\Model\FormElements\Section::createElement()``. +That means the hook will **not** be triggered for ``Pages``. +At this point you don't have access to submitted form element values. + + +.. _apireference-frontendrendering-runtimemanipulation-hooks-initializeformelement-connect: + +Connect to the hook +''''''''''''''''''' + +.. code-block:: php + + $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['initializeFormElement'][<useATimestampAsKeyPlease>] + = \VENDOR\YourNamespace\YourClass::class; + + +.. _apireference-frontendrendering-runtimemanipulation-hooks-initializeformelement-use: + +Use the hook +'''''''''''' + +.. code-block:: php + + /** + * @param \TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface $renderable + * @return void + */ + public function initializeFormElement(\TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface $renderable) + { + if ($renderable->getUniqueIdentifier() === 'contactForm-text-1') { + $renderable->setDefaultValue('foo'); + } + } + + +.. _apireference-frontendrendering-runtimemanipulation-hooks-beforeremovefromparentrenderable: + +beforeRemoveFromParentRenderable +++++++++++++++++++++++++++++++++ + +This hook is invoked by the methods ``TYPO3\CMS\Form\Domain\Model\FormDefinition::removePage()``, ``TYPO3\CMS\Form\Domain\Model\FormElements\Page::removeElement()`` +and ``TYPO3\CMS\Form\Domain\Model\FormElements\Section::removeElement()`` + + +.. _apireference-frontendrendering-runtimemanipulation-hooks-beforeremovefromparentrenderable-connect: + +Connect to the hook +''''''''''''''''''' + +.. code-block:: php + + $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['beforeRemoveFromParentRenderable'][<useATimestampAsKeyPlease>] + = \VENDOR\YourNamespace\YourClass::class; + + +.. _apireference-frontendrendering-runtimemanipulation-hooks-beforeremovefromparentrenderable-use: + +Use the hook +'''''''''''' + +.. code-block:: php + + /** + * @param \TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface $renderable + * @return void + */ + public function beforeRemoveFromParentRenderable(\TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface $renderable) + { + } + + +.. _apireference-frontendrendering-runtimemanipulation-hooks-afterbuildingfinished: + +afterBuildingFinished ++++++++++++++++++++++ + +This hook is called for each form element after the class ``TYPO3\CMS\Form\Domain\Factory\ArrayFormFactory`` +has built the entire form. This hook is triggered just before the +``FormRuntime`` object is generated. At this point, no run-time information +(e.g. assigned form values) is yet available. It can, for example, be used to +generate new form elements within complex forms. The ``ArrayFormFactory`` is +used by EXT:form via the ``RenderViewHelper`` to render forms using a ``form +definition`` YAML file. Each form factory implementation must deal with the +calling of this hook themselves. EXT:form itself uses this hook to initialize +the property-mapper configuration for ``FileUpload`` elements. + +.. _apireference-frontendrendering-runtimemanipulation-hooks-afterbuildingfinished-connect: + +Connect to the hook +''''''''''''''''''' + +.. code-block:: php + + $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['afterBuildingFinished'][<useATimestampAsKeyPlease>] + = \VENDOR\YourNamespace\YourClass::class; + + +.. _apireference-frontendrendering-runtimemanipulation-hooks-afterbuildingfinished-use: + +Use the hook +'''''''''''' + +.. code-block:: php + + /** + * @param \TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface $renderable + * @return void + */ + public function afterBuildingFinished(\TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface $renderable) + { + } + + +.. _apireference-frontendrendering-runtimemanipulation-hooks-afterinitializecurrentpage: + +afterInitializeCurrentPage +++++++++++++++++++++++++++ + +EXT:form automatically detects the page that should be shown and allow users +only to jump to the directly following (or previous) pages. This hook enables +you to implement a custom behavior, for example pages that are shown only when +other form elements have specific values. + + +.. _apireference-frontendrendering-runtimemanipulation-hooks-afterinitializecurrentpage-connect: + +Connect to the hook +''''''''''''''''''' + +.. code-block:: php + + $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['afterInitializeCurrentPage'][<useATimestampAsKeyPlease>] + = \VENDOR\YourNamespace\YourClass::class; + + +.. _apireference-frontendrendering-runtimemanipulation-hooks-afterinitializecurrentpage-use: + +Use the hook +'''''''''''' + +.. code-block:: php + + /** + * @param \TYPO3\CMS\Form\Domain\Runtime\FormRuntime $formRuntime + * @param \TYPO3\CMS\Form\Domain\Model\Renderable\CompositeRenderableInterface $currentPage + * @param null|\TYPO3\CMS\Form\Domain\Model\Renderable\CompositeRenderableInterface $lastPage + * @param mixed $elementValue submitted value of the element *before post processing* + * @return \TYPO3\CMS\Form\Domain\Model\Renderable\CompositeRenderableInterface + */ + public function afterInitializeCurrentPage(\TYPO3\CMS\Form\Domain\Runtime\FormRuntime $formRuntime, \TYPO3\CMS\Form\Domain\Model\Renderable\CompositeRenderableInterface $currentPage, \TYPO3\CMS\Form\Domain\Model\Renderable\CompositeRenderableInterface $lastPage = null, array $requestArguments = []): CompositeRenderableInterface + { + return $currentPage; + } + + +.. _apireference-frontendrendering-runtimemanipulation-hooks-aftersubmit: + +afterSubmit ++++++++++++ + +You can use it for example for dynamic validations which depends on other submitted form element values. +This hook is invoked by the ``FormRuntime`` for each form element **before** values are property mapped, validated and pushed within the FormRuntime's ``FormState``. +If the first page is submitted at the first time you cannot access the form element values from the first page by just calling ``$formRuntime['<someOtherFormElementIdentifier>']`` to access +the submitted form element values from the first page. In this case you can access the submitted raw data through ``$requestArguments``. +EXT:form itself uses this hook to dynamically add validation errors for ``AdvancedPassword`` form elements. + + +.. _apireference-frontendrendering-runtimemanipulation-hooks-aftersubmit-connect: + +Connect to the hook +''''''''''''''''''' + +.. code-block:: php + + $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['afterSubmit'][<useATimestampAsKeyPlease>] + = \VENDOR\YourNamespace\YourClass::class; + + +.. _apireference-frontendrendering-runtimemanipulation-hooks-aftersubmit-use: + +Use the hook +'''''''''''' + +.. code-block:: php + + /** + * @param \TYPO3\CMS\Form\Domain\Runtime\FormRuntime $formRuntime + * @param \TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface $renderable + * @param mixed $elementValue submitted value of the element *before post processing* + * @param array $requestArguments submitted raw request values + * @return void + */ + public function afterSubmit(\TYPO3\CMS\Form\Domain\Runtime\FormRuntime $formRuntime, \TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface $renderable, $elementValue, array $requestArguments = []) + { + return $elementValue; + } + + +.. _apireference-frontendrendering-runtimemanipulation-hooks-beforerendering: + +beforeRendering ++++++++++++++++ + +This is a hook that is invoked by the rendering system before the corresponding element is rendered. +Use this to access previously submitted values and/or modify the ``FormRuntime`` before an element is outputted to the browser. +This hook is called after all validations and property mappings are done. + +.. _apireference-frontendrendering-runtimemanipulation-hooks-beforerendering-connect: + +Connect to the hook +''''''''''''''''''' + +.. code-block:: php + + $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['beforeRendering'][<useATimestampAsKeyPlease>] + = \VENDOR\YourNamespace\YourClass::class; + + +.. _apireference-frontendrendering-runtimemanipulation-hooks-beforerendering-use: + +Use the hook +'''''''''''' + +.. code-block:: php + + /** + * @param \TYPO3\CMS\Form\Domain\Runtime\FormRuntime $formRuntime + * @param \TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface $renderable + * @return void + */ + public function beforeRendering(\TYPO3\CMS\Form\Domain\Runtime\FormRuntime $formRuntime, \TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface $renderable) + { + } + + +.. _apireference-finisheroptions: + +Finisher Options +================ + +.. _apireference-finisheroptions-closurefinisher: + +Closure finisher +---------------- + +This finisher can only be used in programmatically-created forms. It makes it +possible to execute one's own finisher code without having to implement/ +declare this finisher. + +Usage through code: + +.. code-block:: php + + $closureFinisher = $this->objectManager->get(ClosureFinisher::class); + $closureFinisher->setOption('closure', function($finisherContext) { + $formRuntime = $finisherContext->getFormRuntime(); + // ... + }); + $formDefinition->addFinisher($closureFinisher); + + +.. _apireference-finisheroptions-closurefinisher-options: + +Options +^^^^^^^ + +.. _apireference-finisheroptions-closurefinisher-options-closure: + +closure ++++++++ + +:aspect:`Data type` + \Closure + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + null + + +.. _apireference-finisheroptions-confirmationfinisher: + +Confirmation finisher +--------------------- + +A simple finisher that outputs a given text. + +Usage within form definition + +.. code-block:: yaml + + identifier: example-form + label: 'example' + type: Form + + finishers: + - + identifier: Confirmation + options: + message: 'Thx for using TYPO3' + ... + + +Usage through code: + +.. code-block:: php + + $formDefinition->createFinisher('Confirmation', [ + 'message' => 'foo', + ]); + +or create manually (not preferred) + +.. code-block:: php + + $confirmationFinisher = $this->objectManager->get(ConfirmationFinisher::class); + $confirmationFinisher->setOptions([ + 'message' => 'foo', + ]); + $formDefinition->addFinisher($confirmationFinisher); + + +.. _apireference-finisheroptions-confirmationfinisher-options: + +Options +^^^^^^^ + +.. _apireference-finisheroptions-confirmationfinisher-options-message: + +message ++++++++ + +:aspect:`Data type` + string + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + The form has been submitted. + + +.. _apireference-finisheroptions-deleteuploadsfinisher: + +DeleteUploads finisher +---------------------- + +This finisher remove the currently submited files. +Use this finisher e.g after the email finisher if you don't want to keep the files online. + + +Usage within form definition + +.. code-block:: yaml + + identifier: example-form + label: 'example' + type: Form + + finishers: + - + identifier: DeleteUploads + ... + + +Usage through code: + +.. code-block:: php + + $formDefinition->createFinisher('DeleteUploads'); + +or create manually (not preferred) + +.. code-block:: php + + $deleteUploadsFinisher = $this->objectManager->get(DeleteUploadsFinisher::class); + $formDefinition->addFinisher($deleteUploadsFinisher); + + +.. _apireference-finisheroptions-emailfinisher: + +Email finisher +-------------- + +This finisher sends an email to one recipient. +EXT:form uses 2 EmailFinisher declarations with the identifiers ``EmailToReceiver`` and ``EmailToSender``. + +Usage within form definition + +.. code-block:: yaml + + identifier: example-form + label: 'example' + type: Form + + finishers: + - + identifier: EmailToReceiver + options: + subject: 'Your message' + recipientAddress: your.company@example.com + recipientName: 'Your Company name' + senderAddress: 'form@example.com' + senderName: 'form submitter' + ... + + +Usage through code: + +.. code-block:: php + + $formDefinition->createFinisher('EmailToReceiver', [ + 'subject' => 'Your message', + 'recipientAddress' => 'your.company@example.com', + 'recipientName' => 'Your Company name', + 'senderAddress' => 'form@example.com', + 'senderName' => 'form submitter', + ]); + +or create manually (not preferred) + +.. code-block:: php + + $emailFinisher = $this->objectManager->get(EmailFinisher::class); + $emailFinisher->setOptions([ + 'subject' => 'Your message', + 'recipientAddress' => 'your.company@example.com', + 'recipientName' => 'Your Company name', + 'senderAddress' => 'form@example.com', + 'senderName' => 'form submitter', + ]); + $formDefinition->addFinisher($emailFinisher); + + +.. _apireference-finisheroptions-emailfinisher-options: + +Options +^^^^^^^ + +.. _apireference-finisheroptions-emailfinisher-options-subject: + +subject ++++++++ + +:aspect:`Data type` + string + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for 'EmailToReceiver' and 'EmailToSender' declarations)` + undefined + +:aspect:`Description` + Subject of the email + + +.. _apireference-finisheroptions-emailfinisher-options-recipientaddress: + +recipientAddress +++++++++++++++++ + +:aspect:`Data type` + string + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for 'EmailToReceiver' and 'EmailToSender' declarations)` + undefined + +:aspect:`Description` + Email address of the recipient (To) + + +.. _apireference-finisheroptions-emailfinisher-options-recipientname: + +recipientName ++++++++++++++ + +:aspect:`Data type` + string + +:aspect:`Mandatory` + No + +:aspect:`Default value` + empty string + +:aspect:`Description` + Human-readable name of the recipient + + +.. _apireference-finisheroptions-emailfinisher-options-senderaddress: + +senderAddress ++++++++++++++ + +:aspect:`Data type` + string + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for 'EmailToReceiver' and 'EmailToSender' declarations)` + undefined + +:aspect:`Description` + Email address of the sender/ visitor (From) + + +.. _apireference-finisheroptions-emailfinisher-options-sendername: + +senderName +++++++++++ + +:aspect:`Data type` + string + +:aspect:`Mandatory` + No + +:aspect:`Default value` + empty string + +:aspect:`Description` + Human-readable name of the sender + + +.. _apireference-finisheroptions-emailfinisher-options-replytoaddress: + +replyToAddress +++++++++++++++ + +:aspect:`Data type` + string/ array + +:aspect:`Mandatory` + No + +:aspect:`Default value (for 'EmailToReceiver' and 'EmailToSender' declarations)` + undefined + +:aspect:`Description` + Email address of to be used as reply-to email (use multiple addresses with an array) + +.. note:: + For the moment, the ``form editor`` cannot deal with multiple reply-to addresses (use multiple addresses with an array) + + +.. _apireference-finisheroptions-emailfinisher-options-carboncopyaddress: + +carbonCopyAddress ++++++++++++++++++ + +:aspect:`Data type` + string/ array + +:aspect:`Mandatory` + No + +:aspect:`Default value (for 'EmailToReceiver' and 'EmailToSender' declarations)` + undefined + +:aspect:`Description` + Email address of the copy recipient (use multiple addresses with an array) + +.. note:: + For the moment, the ``form editor`` cannot deal with multiple copy recipient addresses (use multiple addresses with an array) + + +.. _apireference-finisheroptions-emailfinisher-options-blindcarboncopyaddress: + +blindCarbonCopyAddress +++++++++++++++++++++++ + +:aspect:`Data type` + string/ array + +:aspect:`Mandatory` + No + +:aspect:`Default value (for 'EmailToReceiver' and 'EmailToSender' declarations)` + undefined + +:aspect:`Description` + Email address of the blind copy recipient (use multiple addresses with an array) + +.. note:: + For the moment, the ``form editor`` cannot deal with multiple blind copy recipient addresses (use multiple addresses with an array) + + +.. _apireference-finisheroptions-emailfinisher-options-format: + +format +++++++ + +:aspect:`Data type` + string + +:aspect:`Mandatory` + No + +:aspect:`Default value (for 'EmailToReceiver' and 'EmailToSender' declarations)` + html + +:aspect:`possible values` + html/ plaintext + +:aspect:`Description` + The format of the email. By default mails are sent as HTML. + + +.. _apireference-finisheroptions-emailfinisher-options-attachuploads: + +attachUploads ++++++++++++++ + +:aspect:`Data type` + bool + +:aspect:`Mandatory` + No + +:aspect:`Default value (for 'EmailToReceiver' and 'EmailToSender' declarations)` + true + +:aspect:`Description` + If set, all uploaded items are attached to the email. + + +.. _apireference-finisheroptions-emailfinisher-options-translation-translationfile: + +translation.translationFile ++++++++++++++++++++++++++++ + +:aspect:`Data type` + string/ array + +:aspect:`Mandatory` + No + +:aspect:`Default value (for 'EmailToReceiver' and 'EmailToSender' declarations)` + undefined + +:aspect:`Description` + If set, this translation file(s) will be used for finisher option translations. + If not set, the translation file(s) from the 'Form' element will be used. + Read :ref:`Translate finisher options<concepts-frontendrendering-translation-finishers>` for more informations. + + +.. _apireference-finisheroptions-emailfinisher-options-translation-language: + +translation.language +++++++++++++++++++++ + +:aspect:`Data type` + string + +:aspect:`Mandatory` + No + +:aspect:`Default value (for 'EmailToReceiver' and 'EmailToSender' declarations)` + undefined + +:aspect:`Description` + If not set, the finisher options are translated depending on the current frontend language (if translations exists). + This option allows you to force translations for a given sys_language isocode, e.g 'dk' or 'de'. + Read :ref:`Translate finisher options<concepts-frontendrendering-translation-finishers>` for more informations. + + +.. _apireference-finisheroptions-emailfinisher-options-templatepathandfilename: + +templatePathAndFilename ++++++++++++++++++++++++ + +:aspect:`Data type` + string + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for 'EmailToReceiver' and 'EmailToSender' declarations)` + 'EXT:form/Resources/Private/Frontend/Templates/Finishers/Email/{@format}.html' + +:aspect:`Description` + Template path and filename for the mail body. + The placeholder {\@format} will be replaced with the value from option ``format`` + + +.. _apireference-finisheroptions-emailfinisher-options-layoutrootpaths: + +layoutRootPaths ++++++++++++++++ + +:aspect:`Data type` + array + +:aspect:`Mandatory` + No + +:aspect:`Default value (for 'EmailToReceiver' and 'EmailToSender' declarations)` + undefined + +:aspect:`Description` + Fluid layout paths + + +.. _apireference-finisheroptions-emailfinisher-options-partialrootpaths: + +partialRootPaths +++++++++++++++++ + +:aspect:`Data type` + array + +:aspect:`Mandatory` + No + +:aspect:`Default value (for 'EmailToReceiver' and 'EmailToSender' declarations)` + undefined + +:aspect:`Description` + Fluid partial paths + + +.. _apireference-finisheroptions-emailfinisher-options-variables: + +variables ++++++++++ + +:aspect:`Data type` + array + +:aspect:`Mandatory` + No + +:aspect:`Default value (for 'EmailToReceiver' and 'EmailToSender' declarations)` + undefined + +:aspect:`Description` + associative array of variables which are available inside the Fluid template + + +.. _apireference-finisheroptions-flashmessagefinisher: + +FlashMessage finisher +--------------------- + +A simple finisher that adds a message to the FlashMessageContainer. + + +Usage within form definition + +.. code-block:: yaml + + identifier: example-form + label: 'example' + type: Form + + finishers: + - + identifier: FlashMessage + options: + messageBody: 'Thx for using TYPO3' + messageTitle: 'Merci' + severity: 0 + ... + + +Usage through code: + +.. code-block:: php + + $formDefinition->createFinisher('FlashMessage', [ + 'messageBody' => 'Thx for using TYPO3', + 'messageTitle' => 'Merci', + 'severity' => \TYPO3\CMS\Core\Messaging\AbstractMessage::OK, + ]); + +or create manually (not preferred) + +.. code-block:: php + + $flashMessageFinisher = $this->objectManager->get(FlashMessageFinisher::class); + $flashMessageFinisher->setOptions([ + 'messageBody' => 'Thx for using TYPO3', + 'messageTitle' => 'Merci', + 'severity' => \TYPO3\CMS\Core\Messaging\AbstractMessage::OK, + ]); + $formDefinition->addFinisher($flashMessageFinisher); + + +.. _apireference-finisheroptions-flashmessagefinisher-options: + +Options +^^^^^^^ + +.. _apireference-finisheroptions-flashmessagefinisher-options-messagebody: + +messageBody ++++++++++++ + +:aspect:`Data type` + string + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + null + +:aspect:`Description` + The flash message body + + +.. _apireference-finisheroptions-flashmessagefinisher-options-messagetitle: + +messageTitle +++++++++++++ + +:aspect:`Data type` + string + +:aspect:`Mandatory` + No + +:aspect:`Default value` + empty string + +:aspect:`Description` + The flash message title + + +.. _apireference-finisheroptions-flashmessagefinisher-options-messagearguments: + +messageArguments +++++++++++++++++ + +:aspect:`Data type` + array + +:aspect:`Mandatory` + No + +:aspect:`Default value` + empty array + +:aspect:`Description` + The flash message arguments, if needed + + +.. _apireference-finisheroptions-flashmessagefinisher-options-messagecode: + +messageCode ++++++++++++ + +:aspect:`Data type` + int + +:aspect:`Mandatory` + No + +:aspect:`Default value` + null + +:aspect:`Description` + The flash message code, if needed + + +.. _apireference-finisheroptions-flashmessagefinisher-options-severity: + +severity +++++++++ + +:aspect:`Data type` + int + +:aspect:`Mandatory` + No + +:aspect:`Default value` + \TYPO3\CMS\Core\Messaging\AbstractMessage::OK (0) + +:aspect:`Description` + The flash message severity code. + See \TYPO3\CMS\Core\Messaging\AbstractMessage constants for the codes. + + +.. _apireference-finisheroptions-redirectfinisher: + +Redirect finisher +----------------- + +A simple finisher that redirects to another page. + + +Usage within form definition + +.. code-block:: yaml + + identifier: example-form + label: 'example' + type: Form + + finishers: + - + identifier: Redirect + options: + pageUid: 1 + additionalParameters: 'param1=value1¶m2=value2' + ... + + +Usage through code: + +.. code-block:: php + + $formDefinition->createFinisher('Redirect', [ + 'pageUid' => 1, + 'additionalParameters' => 'param1=value1¶m2=value2', + ]); + +or create manually (not preferred) + +.. code-block:: php + + $redirectFinisher = $this->objectManager->get(RedirectFinisher::class); + $redirectFinisher->setOptions([ + 'pageUid' => 1, + 'additionalParameters' => 'param1=value1¶m2=value2', + ]); + $formDefinition->addFinisher($redirectFinisher); + + +.. _apireference-finisheroptions-redirectfinisher-options: + +Options +^^^^^^^ + +.. _apireference-finisheroptions-redirectfinisher-options-pageuid: + +pageUid ++++++++ + +:aspect:`Data type` + int + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + 1 + +:aspect:`Description` + Redirect to this page uid + + +.. _apireference-finisheroptions-redirectfinisher-options-additionalparameters: + +additionalParameters +++++++++++++++++++++ + +:aspect:`Data type` + string + +:aspect:`Mandatory` + No + +:aspect:`Default value` + empty string + +:aspect:`Description` + Additional parameters which should be used on the target page + + +.. _apireference-finisheroptions-redirectfinisher-options-delay: + +delay ++++++ + +:aspect:`Data type` + int + +:aspect:`Mandatory` + No + +:aspect:`Default value` + 0 + +:aspect:`Description` + The redirect delay in seconds. + + +.. _apireference-finisheroptions-redirectfinisher-options-statuscode: + +statusCode +++++++++++ + +:aspect:`Data type` + int + +:aspect:`Mandatory` + No + +:aspect:`Default value` + 303 + +:aspect:`Description` + The HTTP status code for the redirect. Default is "303 See Other". + + +.. _apireference-finisheroptions-savetodatabasefinisher: + +SaveToDatabase finisher +----------------------- + +This finisher saves the data from a submitted form into a database table. + + +Usage within form definition + +.. code-block:: yaml + + identifier: example-form + label: 'example' + type: Form + + finishers: + - + identifier: SaveToDatabase + options: + table: 'fe_users' + mode: update + whereClause: + uid: 1 + databaseColumnMappings: + pid: + value: 1 + elements: + textfield-identifier-1: + mapOnDatabaseColumn: 'first_name' + textfield-identifier-2: + mapOnDatabaseColumn: 'last_name' + textfield-identifier-3: + mapOnDatabaseColumn: 'username' + advancedpassword-1: + mapOnDatabaseColumn: 'password' + skipIfValueIsEmpty: true + ... + + +Usage through code: + +.. code-block:: php + + $formDefinition->createFinisher('SaveToDatabase', [ + 'table' => 'fe_users', + 'mode' => 'update', + 'whereClause' => [ + 'uid' => 1, + ], + 'databaseColumnMappings' => [ + 'pid' => ['value' => 1], + ], + 'elements' => [ + 'textfield-identifier-1' => ['mapOnDatabaseColumn' => 'first_name'], + 'textfield-identifier-2' => ['mapOnDatabaseColumn' => 'last_name'], + 'textfield-identifier-3' => ['mapOnDatabaseColumn' => 'username'], + 'advancedpassword-1' => [ + 'mapOnDatabaseColumn' => 'password', + 'skipIfValueIsEmpty' => true, + ], + ], + ]); + +or create manually (not preferred) + +.. code-block:: php + + $saveToDatabaseFinisher = $this->objectManager->get(SaveToDatabaseFinisher::class); + $saveToDatabaseFinisher->setOptions([ + 'table' => 'fe_users', + 'mode' => 'update', + 'whereClause' => [ + 'uid' => 1, + ], + 'databaseColumnMappings' => [ + 'pid' => ['value' => 1], + ], + 'elements' => [ + 'textfield-identifier-1' => ['mapOnDatabaseColumn' => 'first_name'], + 'textfield-identifier-2' => ['mapOnDatabaseColumn' => 'last_name'], + 'textfield-identifier-3' => ['mapOnDatabaseColumn' => 'username'], + 'advancedpassword-1' => [ + 'mapOnDatabaseColumn' => 'password', + 'skipIfValueIsEmpty' => true, + ], + ], + ]); + $formDefinition->addFinisher($saveToDatabaseFinisher); + +You can write options as an array to perform multiple database operations. + +Usage within form definition + +.. code-block:: yaml + + identifier: example-form + label: 'example' + type: Form + + finishers: + - + identifier: SaveToDatabase + options: + 1: + table: 'my_table' + mode: insert + databaseColumnMappings: + some_column: + value: 'cool' + 2: + table: 'my_other_table' + mode: update + whereClause: + pid: 1 + databaseColumnMappings: + some_other_column: + value: '{SaveToDatabase.insertedUids.1}' + ... + + +Usage through code: + +.. code-block:: php + + $formDefinition->createFinisher('SaveToDatabase', [ + 1 => [ + 'table' => 'my_table', + 'mode' => 'insert', + 'databaseColumnMappings' => [ + 'some_column' => ['value' => 'cool'], + ], + ], + 2 => [ + 'table' => 'my_other_table', + 'mode' => 'update', + 'whereClause' => [ + 'pid' => 1, + ], + 'databaseColumnMappings' => [ + 'some_other_column' => ['value' => '{SaveToDatabase.insertedUids.1}'], + ], + ], + ]); + +or create manually (not preferred) + +.. code-block:: php + + $saveToDatabaseFinisher = $this->objectManager->get(SaveToDatabaseFinisher::class); + $saveToDatabaseFinisher->setOptions([ + 1 => [ + 'table' => 'my_table', + 'mode' => 'insert', + 'databaseColumnMappings' => [ + 'some_column' => ['value' => 'cool'], + ], + ], + 2 => [ + 'table' => 'my_other_table', + 'mode' => 'update', + 'whereClause' => [ + 'pid' => 1, + ], + 'databaseColumnMappings' => [ + 'some_other_column' => ['value' => '{SaveToDatabase.insertedUids.1}'], + ], + ], + ]); + $formDefinition->addFinisher($saveToDatabaseFinisher); + + +This perform 2 database operations. +One insert and one update. +You can access the inserted uids through '{SaveToDatabase.insertedUids.<theArrayKeyNumberWithinOptions>}' +If you perform a insert operation, the value of the inserted database row will be stored within the FinisherVariableProvider. +<theArrayKeyNumberWithinOptions> references to the numeric options.* key. + + +.. _apireference-finisheroptions-savetodatabasefinisher-options: + +Options +^^^^^^^ + +.. _apireference-finisheroptions-savetodatabasefinisher-options-table: + +table ++++++ + +:aspect:`Data type` + string + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + null + +:aspect:`Description` + Insert or update values into this table. + + +.. _apireference-finisheroptions-savetodatabasefinisher-options-mode: + +mode +++++ + +:aspect:`Data type` + string + +:aspect:`Mandatory` + No + +:aspect:`Default value` + 'insert' + +:aspect:`Possible values` + insert/ update + +:aspect:`Description` + ``insert`` will create a new database row with the values from the submitted form and/or some predefined values. @see options.elements and options.databaseFieldMappings + + ``update`` will update a given database row with the values from the submitted form and/or some predefined values. 'options.whereClause' is then required. + + +.. _apireference-finisheroptions-savetodatabasefinisher-options-whereclause: + +whereClause ++++++++++++ + +:aspect:`Data type` + array + +:aspect:`Mandatory` + Yes, if mode = update + +:aspect:`Default value` + empty array + +:aspect:`Description` + This where clause will be used for a database update action + + +.. _apireference-finisheroptions-savetodatabasefinisher-options-elements: + +elements +++++++++ + +:aspect:`Data type` + array + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + empty array + +:aspect:`Description` + Use ``options.elements`` to map form element values to existing database columns. + Each key within ``options.elements`` has to match with a form element identifier. + The value for each key within ``options.elements`` is an array with additional informations. + + +.. _apireference-finisheroptions-savetodatabasefinisher-options-elements-<formelementidentifier>-mapondatabasecolumn: + +elements.<formElementIdentifier>.mapOnDatabaseColumn +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +:aspect:`Data type` + string + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + undefined + +:aspect:`Description` + The value from the submitted form element with the identifier ``<formElementIdentifier>`` will be written into this database column. + + +.. _apireference-finisheroptions-savetodatabasefinisher-options-elements-<formelementidentifier>-skipifvalueisempty: + +elements.<formElementIdentifier>.skipIfValueIsEmpty ++++++++++++++++++++++++++++++++++++++++++++++++++++ + +:aspect:`Data type` + bool + +:aspect:`Mandatory` + No + +:aspect:`Default value` + false + +:aspect:`Description` + Set this to true if the database column should not be written if the value from the submitted form element with the identifier + ``<formElementIdentifier>`` is empty (think about password fields etc.) + + +.. _apireference-finisheroptions-savetodatabasefinisher-options-elements-<formelementidentifier>-savefileidentifierinsteadofuid: + +elements.<formElementIdentifier>.saveFileIdentifierInsteadOfUid ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +:aspect:`Data type` + bool + +:aspect:`Mandatory` + No + +:aspect:`Default value` + false + +:aspect:`Description` + Set this to true if the database column should not be written if the value from the submitted form element with the identifier + ``<formElementIdentifier>`` is empty (think about password fields etc.) + + This setting only rules for form elements which creates a FAL object like ``FileUpload`` or ``ImageUpload``. + By default, the uid of the FAL object will be written into the database column. Set this to true if you want to store the + FAL identifier (1:/user_uploads/some_uploaded_pic.jpg) instead. + + +.. _apireference-finisheroptions-savetodatabasefinisher-options-databasecolumnmappings: + +databaseColumnMappings +++++++++++++++++++++++ + +:aspect:`Data type` + array + +:aspect:`Mandatory` + No + +:aspect:`Default value` + empty array + +:aspect:`Description` + Use this to map database columns to static values. + Each key within ``options.databaseColumnMappings`` has to match with an existing database column. + The value for each key within ``options.databaseColumnMappings`` is an array with additional informations. + + This mapping is done *before* the ``options.element`` mapping. + This means if you map a database column to a value through ``options.databaseColumnMappings`` and map a submitted + form element value to the same database column through ``options.element``, the submitted form element value + will override the value you set within ``options.databaseColumnMappings``. + + +.. _apireference-finisheroptions-savetodatabasefinisher-options-databasecolumnmappings.<databasecolumnname>.value: + +databaseColumnMappings.<databaseColumnName>.value ++++++++++++++++++++++++++++++++++++++++++++++++++ + +:aspect:`Data type` + string + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + undefined + +:aspect:`Description` + The value which will be written to the database column. + You can also use the :ref:`FormRuntime accessor feature<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` to access every getable property from the ``FormRuntime`` + In short: use something like ``{<formElementIdentifier>}`` to get the value from the submitted form element with the identifier ``<formElementIdentifier>``. + + If you use the FormRuntime accessor feature within ``options.databaseColumnMappings``, the functionality is nearly identical + to the ``options.elements`` configuration variant. + + +.. _apireference-finisheroptions-savetodatabasefinisher-options-databasecolumnmappings.<databasecolumnname>.skipifvalueisempty: + +databaseColumnMappings.<databaseColumnName>.skipIfValueIsEmpty +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +:aspect:`Data type` + bool + +:aspect:`Mandatory` + No + +:aspect:`Default value` + false + +:aspect:`Description` + Set this to true if the database column should not be written if the value from ``options.databaseColumnMappings.<databaseColumnName>.value`` is empty. + + + +.. _apireference-formeditor: + +Form editor +=========== + + +.. _apireference-formeditor-hooks: + +Hooks +----- + +EXT:form implements various hooks so that forms can be manipulated while being +created or saved. + + +.. _apireference-formeditor-hooks-beforeformcreate: + +beforeFormCreate +^^^^^^^^^^^^^^^^ + +The form manager calls the 'beforeFormCreate' hook. + + +.. _apireference-formeditor-hooks-beforeformcreate-connect: + +Connect to the hook ++++++++++++++++++++ + +.. code-block:: php + + $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['beforeFormCreate'][<useATimestampAsKeyPlease>] + = \VENDOR\YourNamespace\YourClass::class; + + +.. _apireference-formeditor-hooks-beforeformcreate-use: + +Use the hook +++++++++++++ + +.. code-block:: php + + /** + * @param string $formPersistenceIdentifier + * @param array $formDefinition + * @return array + */ + public function beforeFormCreate(string $formPersistenceIdentifier, array $formDefinition): array + { + return $formDefinition; + } + + +.. _apireference-formeditor-hooks-beforeformduplicate: + +beforeFormDuplicate +^^^^^^^^^^^^^^^^^^^ + +The form manager call the 'beforeFormDuplicate' hook. + + +.. _apireference-formeditor-hooks-beforeformduplicate-connect: + +Connect to the hook ++++++++++++++++++++ + +.. code-block:: php + + $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['beforeFormDuplicate'][<useATimestampAsKeyPlease>] + = \VENDOR\YourNamespace\YourClass::class; + + +.. _apireference-formeditor-hooks-beforeformduplicate-use: + +Use the hook +++++++++++++ + +.. code-block:: php + + /** + * @param string $formPersistenceIdentifier + * @param array $formDefinition + * @return array + */ + public function beforeFormDuplicate(string $formPersistenceIdentifier, array $formDefinition): array + { + return $formDefinition; + } + + +.. _apireference-formeditor-hooks-beforeformdelete: + +beforeFormDelete +^^^^^^^^^^^^^^^^ + +The form manager call the 'beforeFormDelete' hook. + + +.. _apireference-formeditor-hooks-beforeformdelete-connect: + +Connect to the hook ++++++++++++++++++++ + +.. code-block:: php + + $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['beforeFormDelete'][<useATimestampAsKeyPlease>] + = \VENDOR\YourNamespace\YourClass::class; + + +.. _apireference-formeditor-hooks-beforeformdelete-use: + +Use the hook +++++++++++++ + +.. code-block:: php + + /** + * @param string $formPersistenceIdentifier + * @return void + */ + public function beforeFormDelete(string $formPersistenceIdentifier) + { + } + + +.. _apireference-formeditor-hooks-beforeformsave: + +beforeFormSave +^^^^^^^^^^^^^^ + +The form editor call the 'beforeFormSave' hook. + + +.. _apireference-formeditor-hooks-beforeformsave-connect: + +Connect to the hook ++++++++++++++++++++ + +.. code-block:: php + + $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['beforeFormSave'][<useATimestampAsKeyPlease>] + = \VENDOR\YourNamespace\YourClass::class; + + +.. _apireference-formeditor-hooks-beforeformsave-use: + +Use the hook +++++++++++++ + +.. code-block:: php + + /** + * @param string $formPersistenceIdentifier + * @param array $formDefinition + * @return array + */ + public function beforeFormSave(string $formPersistenceIdentifier, array $formDefinition): array + { + return $formDefinition; + } + + + +.. _apireference-formeditor-stage: + +Stage +----- + + +.. _apireference-formeditor-stage-commonabstractformelementtemplates: + +Common abstract view form element templates +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The basic idea of the ``abstract view`` is to give a quick overview of the +configuration of form elements, without having to click them in order to view +the detailed configuration in the ``Inspector``. The ``form editor`` requires +for each form element an inline HTML template and the corresponding JavaScript +code. Information matching inline HTML templates to the appropriate form +elements must be configured within :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formeditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>`. +At this point, the key identifying the form element follows a convention: +``FormElement-<formElementTypeIdentifier>``. The value for the key tells the +``form editor`` which inline HTML template should be loaded for the respective +form element. This template is then cloned via JavaScript, brought to life +using the form element configuration and shown in the ``Stage`` component. + +You can read about how particular form elements are mapped to inline HTML +templates and how the corresponding JavaScript code are executed :ref:`here <apireference-formeditor-basicjavascriptconcepts-events-view-stage-abstract-render-template-perform>`. + +The form element inline HTML templates and the corresponding JavaScript code +are configured for reuse. In this way, most form elements you create should be +able to access the components delivered in EXT:form, without requiring separate +implementations (at least we hope so). For your own implementations, study +EXT:form stage templates, which is found under ``Resources/Private/Backend/Partials/FormEditor/Stage/*``. +The corresponding JavaScript code is found under ``Resources/Public/JavaScript/Backend/FormEditor/StageComponent.js``. +The method ``_renderTemplateDispatcher()`` shows, which methods will be used to +render the respective form elements. + +Essentially, two different inline HTML templates exists that can be rendered +with two different JavaScript methods, which are described below. The other +inline HTML templates are almost all versions of these two basic variants and +show extra/ other form-element information. The same applies to the +corresponding JavaScript codes. + + +.. _apireference-formeditor-stage-commonabstractformelementtemplates-simpletemplate: + +Stage/SimpleTemplate +++++++++++++++++++++ + +This template displays the ``label`` property of the form element. Depending on +the JavaScript rendering method used, a validator icon will be shown on the +right as soon as a validator is added to the form element. In this case, the +used validator labels are likewise displayed, if the form element is selected +and/ or the cursor hovers over the form element. This template should generally +be enough for all possible, self-defined form elements. + +The ``Stage/SimpleTemplate`` can then :ref:`be rendered <apireference-formeditor-basicjavascriptconcepts-events-view-stage-abstract-render-template-perform>` +with the method ``getFormEditorApp().getViewModel().getStage().renderSimpleTemplateWithValidators()``. + + +.. _apireference-formeditor-stage-commonabstractformelementtemplates-selecttemplate: + +Stage/SelectTemplate +++++++++++++++++++++ + +This template behaves like the ``Stage/SimpleTemplate`` except that it also +shows the chosen options labels of the form elements. This is naturally only +possible for form elements that have ``properties.options.*`` values, e.g. +``MultiCheckbox``: + +.. code-block:: yaml + + type: MultiCheckbox + identifier: multicheckbox-1 + label: 'Multi checkbox' + properties: + options: + value1: label1 + value2: label2 + + +The template will now list 'label1' and 'label2'. + +You can copy this template variant for your own form element, if that form- +element template also lists array values, which, however, are not found under +``properties.options.*``. For this purpose, the 'Stage/FileUploadTemplate' is +an example. It is basically the 'Stage/SelectTemplate' template, with one +altered property. + +In the ``FileUpload`` form element, multiple property values are available +under ``properties.allowedMimeTypes.*`` as an array. + +.. code-block:: yaml + + type: FileUpload + identifier: fileupload-1 + label: 'File upload' + properties: + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - application/msexcel + - application/pdf + + +Stage/SelectTemplate + +.. code-block:: html + + <div data-identifier="multiValueContainer" data-template-property="properties.options"> + + +Stage/FileUploadTemplate + +.. code-block:: html + + <div data-identifier="multiValueContainer" data-template-property="properties.allowedMimeTypes"> + + +``data-template-property`` contains the path to the property, which is to be +read out of the form element and then shown in the template. + +The ``Stage/SelectTemplate`` can then :ref:`be rendered <apireference-formeditor-basicjavascriptconcepts-events-view-stage-abstract-render-template-perform>` +with the method ``getFormEditorApp().getViewModel().getStage().renderSelectTemplates()``. + + + +.. _apireference-formeditor-basicjavascriptconcepts: + +Basic JavaScript Concepts +------------------------- + + +.. _apireference-formeditor-basicjavascriptconcepts-events: + +Events +^^^^^^ + +EXT:form implements the ``publish/subscribe pattern`` to put the event handling +into effect. To learn more about this pattern, you should read +https://addyosmani.com/resources/essentialjsdesignpatterns/book/. +Note that the order of the subscriber is not manipulable and that information +flow between the subscribers does not exist. All events must be asynchronously +designed. + + +Publish an event: + +.. code-block:: javascript + + getPublisherSubscriber().publish('eventname', [argumentToPublish1, argumentToPublish2, ...]); + + +Subscribe to an event: + +.. code-block:: javascript + + var subscriberToken = getPublisherSubscriber().subscribe('eventname', function(topic, args) { + // args[0] = argumentToPublish1 + // args[1] = argumentToPublish2 + // ... + }); + + +Unsubscribe an event subscriber: + +.. code-block:: javascript + + getPublisherSubscriber().unsubscribe(subscriberToken); + + +EXT:form itself publishes and subscribes to the following events: + +.. _apireference-formeditor-basicjavascriptconcepts-events-ajax-beforesend: + +ajax/beforeSend ++++++++++++++++ + +Each Ajax request is called before this event is sent. EXT:form uses this event +to display the spinner icon on the save button. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * @return void + */ + getPublisherSubscriber().subscribe('ajax/beforeSend', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-ajax-complete: + +ajax/complete ++++++++++++++ + +Each Ajax request is called after the end of this event. EXT:form uses this +event to remove the spinner icon on the save button. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * @return void + */ + getPublisherSubscriber().subscribe('ajax/complete', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-core-ajax-error: + +core/ajax/error ++++++++++++++++ + +This event is called if the Ajax request, which is used to save the form or to +render the current page of the form in the ``preview view``, fails. EXT:form +uses this event to show an error message as a flash message and to show the +received error text in the ``preview view``. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = jqXHR + * args[1] = textStatus + * args[2] = errorThrown + * @return void + */ + getPublisherSubscriber().subscribe('core/ajax/error', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-core-ajax-renderformdefinitionpage-success: + +core/ajax/renderFormDefinitionPage/success +++++++++++++++++++++++++++++++++++++++++++ + +This event is called if the Ajax request that is used to render the current +page of the form in the ``preview view`` was successful. EXT:form uses this +event to display the rendered form in the ``preview view``. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = html + * args[1] = pageIndex + * @return void + */ + getPublisherSubscriber().subscribe('core/ajax/renderFormDefinitionPage/success', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-core-ajax-saveformdefinition-success: + +core/ajax/saveFormDefinition/success +++++++++++++++++++++++++++++++++++++ + +This event is called if the Ajax request that is used to save the form was +successful. EXT:form uses this event to display a success message as a flash +message. The ``form editor`` is also informed that no unsaved content currently +exists. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = html + * @return void + */ + getPublisherSubscriber().subscribe('core/ajax/saveFormDefinition/success', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-core-applicationstate-add: + +core/applicationState/add ++++++++++++++++++++++++++ + +The addition/ deletion and movement of form elements und property collection +elements (validators/ finishers) is saved in an internal stack so that the +undo/ redo function can be implemented. This event is called whenever the +current state is added to the stack. EXT:form uses this event to reset the +enabled/ disabled state of the undo/ redo buttons. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = applicationState + * args[1] = stackPointer + * args[2] = stackSize + * @return void + */ + getPublisherSubscriber().subscribe('core/applicationState/add', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-core-currentlyselectedformelementchanged: + +core/currentlySelectedFormElementChanged +++++++++++++++++++++++++++++++++++++++++ + +The method ``getFormEditorApp().setCurrentlySelectedFormElement()`` tells the +``form editor`` which form element should currently be dealt with. This method +calls this event at the end. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = formElement + * @return void + */ + getPublisherSubscriber().subscribe('core/currentlySelectedFormElementChanged', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-core-formelement-somepropertychanged: + +core/formElement/somePropertyChanged +++++++++++++++++++++++++++++++++++++ + +Each :ref:`FormElement model<apireference-formeditor-basicjavascriptconcepts-formelementmodel>` +can write properties into the ``FormElement model`` through the methods ``get`` +and ``set``. Each property path can register an event name for the publisher +through the method ``on``. This event is then always called when a property +path is written via ``set``. Read :ref:`FormElement model<concepts-formeditor-basicjavascriptconcepts-formelementmodel>` +for more information. EXT:form automatically registers for all known property +paths of a form element the event ``core/formElement/somePropertyChanged``. +This means that every property written via ``set`` calls this event. Among +other things, EXT:form uses this event for, for example, updating the label of +a form element in other components (e.g. ``Tree`` component ) when this label +is changed. Furthermore, any validation errors from form element properties +are indicated by this event in the ``Tree`` component. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = propertyPath + * args[1] = value + * args[2] = oldValue + * args[3] = formElementIdentifierPath + * @return void + */ + getPublisherSubscriber().subscribe('core/formElement/somePropertyChanged', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-collectionelement-moved: + +view/collectionElement/moved +++++++++++++++++++++++++++++ + +The method ``getFormEditorApp().getViewModel().movePropertyCollectionElement()`` +calls this event at the end. EXT:form uses this event to re-render the +``Inspector`` component as soon as a property collection element (validator/ +finisher) is moved. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = movedCollectionElementIdentifier + * args[1] = previousCollectionElementIdentifier + * args[2] = nextCollectionElementIdentifier + * args[3] = collectionName + * @return void + */ + getPublisherSubscriber().subscribe('view/collectionElement/moved', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-collectionelement-new-added: + +view/collectionElement/new/added +++++++++++++++++++++++++++++++++ + +The method ``getFormEditorApp().getViewModel().createAndAddPropertyCollectionElement()`` +calls this event at the end. EXT:form uses this event to re-render the +``Inspector`` component as soon as a property collection element (validator/ +finisher) is created and added. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = collectionElementIdentifier + * args[1] = collectionName + * args[2] = formElement + * args[3] = collectionElementConfiguration + * args[4] = referenceCollectionElementIdentifier + * @return void + */ + getPublisherSubscriber().subscribe('view/collectionElement/new/added', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-collectionelement-removed: + +view/collectionElement/removed +++++++++++++++++++++++++++++++ + +The method ``getFormEditorApp().getViewModel().removePropertyCollectionElement()`` +calls this event at the end. EXT:form uses this event to re-render the +``Inspector`` component as soon as a property collection element (validator/ +finisher) is removed. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = collectionElementIdentifier + * args[1] = collectionName + * args[2] = formElement + * @return void + */ + getPublisherSubscriber().subscribe('view/collectionElement/removed', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-formelement-inserted: + +view/formElement/inserted ++++++++++++++++++++++++++ + +The method ``getFormEditorApp().getViewModel().createAndAddFormElement()`` and +the event :ref:`view/insertElements/perform/after<apireference-formeditor-basicjavascriptconcepts-events-view-insertelements-perform-after>` +call this event at the end. EXT:form uses this event to set the current +to-be-processed form element (``getFormEditorApp().setCurrentlySelectedFormElement()``) +and to re-render the ``Tree``, ``Stage`` and ``Inspector`` components. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = newFormElement + * @return void + */ + getPublisherSubscriber().subscribe('view/formElement/inserted', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-formelement-moved: + +view/formElement/moved +++++++++++++++++++++++ + +The method ``getFormEditorApp().getViewModel().moveFormElement()`` calls this +event at the end. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = movedFormElement + * @return void + */ + getPublisherSubscriber().subscribe('view/formElement/moved', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-formelement-removed: + +view/formElement/removed +++++++++++++++++++++++++ + +The method ``getFormEditorApp().getViewModel().removeFormElement()`` calls this +event at the end. EXT:form uses this event to set the current to-be-processed +form element (``getFormEditorApp().setCurrentlySelectedFormElement()``) and to +re-render the ``Tree``, ``Stage`` and ``Inspector`` components. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = parentFormElement + * @return void + */ + getPublisherSubscriber().subscribe('view/formElement/removed', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-header-button-close-clicked: + +view/header/button/close/clicked +++++++++++++++++++++++++++++++++ + +The onClick event of the "Close" button in the ``form editor's`` header section +calls this event. EXT:form uses this event to display a warning message in case +there are unsaved changes. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * @return void + */ + getPublisherSubscriber().subscribe('view/header/button/close/clicked', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-header-button-newpage-clicked: + +view/header/button/newPage/clicked +++++++++++++++++++++++++++++++++++ + +The onClick event of the "new page" button in the ``form editor's`` header +section calls this event. EXT:form uses this event to display the "new page" +dialog box. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = targetEvent + * @return void + */ + getPublisherSubscriber().subscribe('view/header/button/newPage/clicked', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-header-button-save-clicked: + +view/header/button/save/clicked ++++++++++++++++++++++++++++++++ + +The onClick event of the "save" button in the ``form editor's`` header section +calls this event. EXT:form uses this event either to display a dialog box with +the element in question (if there are validation errors) or to save the ``form +definition`` (if there are no validation errors). + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * @return void + */ + getPublisherSubscriber().subscribe('view/header/button/save/clicked', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-header-formsettings-clicked: + +view/header/formSettings/clicked +++++++++++++++++++++++++++++++++ + +The onClick event of the "settings" button in the ``form editor's`` header +section calls this event. EXT:form uses this event to select the root form +element. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * @return void + */ + getPublisherSubscriber().subscribe('view/header/formSettings/clicked', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-insertelements-perform-after: + +view/insertElements/perform/after ++++++++++++++++++++++++++++++++++ + +This event is called from the "new element" dialog box upon selection of a form +element: + +- if "After" in the "Create new element" split button in the form-element toolbar for composite elements (e.g. fieldset) is clicked. +- if the "Create new element" button in the form-element toolbar for non-composite elements is clicked. + +EXT:form uses this event to create a new form element (``getFormEditorApp().getViewModel().createAndAddFormElement()``) +and then move (``getFormEditorApp().getViewModel().moveFormElement()``) it +below the currently selected element (sibling). At the end of this event, the +event :ref:`view/formElement/inserted<apireference-formeditor-basicjavascriptconcepts-events-view-formelement-inserted>` +is called. The event ``view/formElement/inserted`` in ``getFormEditorApp().getViewModel().createAndAddFormElement()`` +was previously deactivated. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = formElementType + * @return void + */ + getPublisherSubscriber().subscribe('view/insertElements/perform/after', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-insertelements-perform-bottom: + +view/insertElements/perform/bottom +++++++++++++++++++++++++++++++++++ + +This event is called from the "new element" dialog box upon selection of a form +element: + +- if, in the ``abstract view`` mode, the "Create new element" button at the end of the ``Stage`` component is clicked. + +EXT:form uses this event to create a new form element (``getFormEditorApp().getViewModel().createAndAddFormElement()``). +This element is always created as the last element of the currently selected +page. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = formElementType + * @return void + */ + getPublisherSubscriber().subscribe('view/insertElements/perform/bottom', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-insertelements-perform-inside: + +view/insertElements/perform/inside +++++++++++++++++++++++++++++++++++ + +This event is called from the "new element" dialog box upon selection of a form +element: + +- if "Inside" in the "Create new element" split button in the form-element toolbar for composite elements (e.g. fieldset) is clicked. + +EXT:form uses this event to create a new form element as a child element of the +currently selected element (``getFormEditorApp().getViewModel().createAndAddFormElement()``). + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = formElementType + * @return void + */ + getPublisherSubscriber().subscribe('view/insertElements/perform/inside', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-insertpages-perform: + +view/insertPages/perform +++++++++++++++++++++++++ + +This event is called from the "new element" dialog box upon selection of a page +element: + +- if the "Create new page" icon in the header section is clicked. +- if the "Create new page" button in the ``Tree`` component is clicked. + +EXT:form uses this event to create a new page after the currently selected page +(``getFormEditorApp().getViewModel().createAndAddFormElement()``). + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = formElementType + * @return void + */ + getPublisherSubscriber().subscribe('view/insertPages/perform', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-inspector-collectionelement-existing-selected: + +view/inspector/collectionElement/existing/selected +++++++++++++++++++++++++++++++++++++++++++++++++++ + +The ``inspector editors`` :ref:`ValidatorsEditor <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.finisherseditor>` +and :ref:`FinishersEditor <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.validatorseditor>` +are used to display the available validators/ finishers for a form element as a +select box. Furthermore, these ``inspector editors`` indicate that in the +``form definition``, validators/ finishers for the currently selected element +already exist. This occurs through the event ``view/inspector/collectionElement/existing/selected``. +EXT:form uses this event to render these validators/ finishers and their +tentatively configured ``inspector editors`` (``getFormEditorApp().getViewModel().renderInspectorCollectionElementEditors()``). + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = collectionElementIdentifier + * args[1] = collectionName + * @return void + */ + getPublisherSubscriber().subscribe('view/inspector/collectionElement/existing/selected', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-inspector-collectionelement-new-selected: + +view/inspector/collectionElement/new/selected ++++++++++++++++++++++++++++++++++++++++++++++ + +The ``inspector editors`` :ref:`ValidatorsEditor <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.finisherseditor>` +and :ref:`FinishersEditor <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.validatorseditor>` +are used to display the available validators/ finishers for a form element as a +select box. The onChange event of the select box then calls this event. In +addition, the ``inspector editor`` :ref:`RequiredValidatorEditor <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor>` +calls this event when a checkbox is chosen. EXT:form uses this event to add and +render the validator/ finisher of the ``form definition`` via ``getFormEditorApp().getViewModel().createAndAddPropertyCollectionElement()``. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = collectionElementIdentifier + * args[1] = collectionName + * @return void + */ + getPublisherSubscriber().subscribe('view/inspector/collectionElement/new/selected', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-inspector-collectionelement-dnd-update: + +view/inspector/collectionElements/dnd/update +++++++++++++++++++++++++++++++++++++++++++++ + +EXT:form uses the jQuery plugin 'jquery.mjs.nestedSortable' for the drag-and- +drop functionality. The 'update' event from 'jquery.mjs.nestedSortable' calls +the ``view/inspector/collectionElements/dnd/update`` event if a property +collection element in the ``Inspector`` component is sorted. EXT:form uses this +event to move the validator/ finisher in the ``form definition`` via the method +``getFormEditorApp().getViewModel().movePropertyCollectionElement()``. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = movedCollectionElementIdentifier + * args[1] = previousCollectionElementIdentifier + * args[2] = nextCollectionElementIdentifier + * args[3] = collectionName + * @return void + */ + getPublisherSubscriber().subscribe('view/inspector/collectionElements/dnd/update', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-inspector-editor-insert-perform: + +view/inspector/editor/insert/perform +++++++++++++++++++++++++++++++++++++ + +The methods ``getFormEditorApp().getViewModel().renderInspectorEditors()`` (to +render all ``inspector editors`` for a form element) and ``getFormEditorApp().getViewModel().renderInspectorCollectionElementEditors()`` +(to render the ``inspector editors`` for a validator/ finisher) call this event +at the end. Strictly speaking, the ``Inspector`` component in the method +``_renderEditorDispatcher()`` calls this event. +Each ``inspector editor`` has the property :ref:`templateName <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.templatename>`, +which gives the ``form editor`` two pieces of information. On the one hand the +``templateName`` must match with a key within the :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formeditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>`. +The ``form editor`` can consequently load a corresponding inline HTML template +for the ``inspector editor``. On the other hand, the ``Inspector`` component +must be told which JavaScript code should be executed for the +``inspector editor``. For the ``inspector editors`` delivered with EXT:form, +this occurs within the method ``_renderEditorDispatcher()``. +An existing hard-coded list of known ``inspector editors`` determines, by means +of the property ``templateName``, which corresponding JavaScript method should +be executed for the ``inspector editor``. At the end, the event +``view/inspector/editor/insert/perform`` is called. If you wish to implement +your own ``inspector editor``, you can use this event to execute in +:ref:`your own JavaScript module <concepts-formeditor-basicjavascriptconcepts-registercustomjavascriptmodules>`. +the corresponding JavaScript code, with the help of the property +``templateName``. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = editorConfiguration + * args[1] = editorHtml + * args[2] = collectionElementIdentifier + * args[3] = collectionName + * @return void + */ + getPublisherSubscriber().subscribe('view/inspector/editor/insert/perform', function(topic, args) { + }); + + +A simple example that registers a custom ``inspector editor`` called 'Inspector-MyCustomInspectorEditor' and adds it to text form elements: + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + formEditor: + dynamicRequireJsModules: + additionalViewModelModules: + - 'TYPO3/CMS/MySitePackage/Backend/FormEditor/ViewModel' + formEditorFluidConfiguration: + partialRootPaths: + 100: 'EXT:my_site_package/Resources/Private/Backend/Partials/FormEditor/' + formEditorPartials: + Inspector-MyCustomInspectorEditor: 'Inspector/MyCustomInspectorEditor' + formElementsDefinition: + Text: + formEditor: + editors: + 600: + templateName: 'Inspector-MyCustomInspectorEditor' + ... + + +.. code-block:: javascript + :emphasize-lines: 107-116 + + /** + * Module: TYPO3/CMS/MySitePackage/Backend/FormEditor/ViewModel + */ + define(['jquery', + 'TYPO3/CMS/Form/Backend/FormEditor/Helper' + ], function($, Helper) { + 'use strict'; + + return (function($, Helper) { + + /** + * @private + * + * @var object + */ + var _formEditorApp = null; + + /** + * @private + * + * @return object + */ + function getFormEditorApp() { + return _formEditorApp; + }; + + /** + * @private + * + * @return object + */ + function getPublisherSubscriber() { + return getFormEditorApp().getPublisherSubscriber(); + }; + + /** + * @private + * + * @return object + */ + function getUtility() { + return getFormEditorApp().getUtility(); + }; + + /** + * @private + * + * @param object + * @return object + */ + function getHelper() { + return Helper; + }; + + /** + * @private + * + * @return object + */ + function getCurrentlySelectedFormElement() { + return getFormEditorApp().getCurrentlySelectedFormElement(); + }; + + /** + * @private + * + * @param mixed test + * @param string message + * @param int messageCode + * @return void + */ + function assert(test, message, messageCode) { + return getFormEditorApp().assert(test, message, messageCode); + }; + + /** + * @private + * + * @return void + * @throws 1491643380 + */ + function _helperSetup() { + assert('function' === $.type(Helper.bootstrap), + 'The view model helper does not implement the method "bootstrap"', + 1491643380 + ); + Helper.bootstrap(getFormEditorApp()); + }; + + /** + * @private + * + * @return void + */ + function _subscribeEvents() { + /** + * @private + * + * @param string + * @param array + * args[0] = editorConfiguration + * args[1] = editorHtml + * args[2] = collectionElementIdentifier + * args[3] = collectionName + * @return void + */ + getPublisherSubscriber().subscribe('view/inspector/editor/insert/perform', function(topic, args) { + if (args[0]['templateName'] === 'Inspector-MyCustomInspectorEditor') { + renderMyCustomInspectorEditor( + args[0], + args[1], + args[2], + args[3] + ); + } + }); + }; + + /** + * @private + * + * @param object editorConfiguration + * @param object editorHtml + * @param string collectionElementIdentifier + * @param string collectionName + * @return void + */ + function renderMyCustomInspectorEditor(editorConfiguration, editorHtml, collectionElementIdentifier, collectionName) { + // do cool stuff + }); + + /** + * @public + * + * @param object formEditorApp + * @return void + */ + function bootstrap(formEditorApp) { + _formEditorApp = formEditorApp; + _helperSetup(); + _subscribeEvents(); + }; + + /** + * Publish the public methods. + * Implements the "Revealing Module Pattern". + */ + return { + bootstrap: bootstrap + }; + })($, Helper); + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-inspector-removecollectionelement-perform: + +view/inspector/removeCollectionElement/perform +++++++++++++++++++++++++++++++++++++++++++++++ + +The ``inspector editor`` :ref:`RequiredValidatorEditor <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor>` +calls this event, if the checkbox is deselected. EXT:form uses this event to +remove the configured required validator ('NotEmpty') from the ``form +definition`` through the method ``getFormEditorApp().getViewModel().removePropertyCollectionElement()``. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = collectionElementIdentifier + * args[1] = collectionName + * args[2] = formElement + * @return void + */ + getPublisherSubscriber().subscribe('view/inspector/removeCollectionElement/perform', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-modal-close-perform: + +view/modal/close/perform +++++++++++++++++++++++++ + +If you try to close the ``form editor`` with unsaved content, a dialog box +appears, asking whether you really wish to close it. If you confirm it, this +event is called in the ``check box`` component. EXT:form uses this event to +close the ``form editor`` and return to the ``form manager``. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * @return void + */ + getPublisherSubscriber().subscribe('view/modal/close/perform', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-modal-removecollectionelement-perform: + +view/modal/removeCollectionElement/perform +++++++++++++++++++++++++++++++++++++++++++ + +If you try to remove a validator/ finisher by clicking the remove icon, a +dialog box appears, asking you to confirm this action. If confirmed, this event +is called in the ``check box`` component. EXT:form uses this event to remove +the validator/ finisher from the ``form definition`` through the method +``getFormEditorApp().getViewModel().removePropertyCollectionElement()``. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = collectionElementIdentifier + * args[1] = collectionName + * args[2] = formElement + * @return void + */ + getPublisherSubscriber().subscribe('view/modal/removeCollectionElement/perform', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-modal-removeformelement-perform: + +view/modal/removeFormElement/perform +++++++++++++++++++++++++++++++++++++ + +If you try to remove a form element by clicking the remove icon, a dialog box +appears, asking you to confirm this action. If confirmed, this event is called +in the ``check box`` component. EXT:form uses this event to remove the form +element from the ``form definition`` via the method ``getFormEditorApp().getViewModel().removeFormElement()``. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = formElement + * @return void + */ + getPublisherSubscriber().subscribe('view/modal/removeFormElement/perform', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-modal-validationerrors-element-clicked: + +view/modal/validationErrors/element/clicked ++++++++++++++++++++++++++++++++++++++++++++ + +If a form element contains a validation error and you try to save the form, a +dialog box appears, listing all form elements with validation errors. One such +form element can be clicked in this dialog box. This event is called by +clicking a form element in the dialog box. EXT:form uses this event to select +and show this form element. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = formElementIdentifierPath + * @return void + */ + getPublisherSubscriber().subscribe('view/modal/validationErrors/element/clicked', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-paginationnext-clicked: + +view/paginationNext/clicked ++++++++++++++++++++++++++++ + +This event is called if the 'pagination next' button in the ``Stage`` +component's header section is clicked. EXT:form uses this event to render the +next page of the form. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * @return void + */ + getPublisherSubscriber().subscribe('view/paginationNext/clicked', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-paginationprevious-clicked: + +view/paginationPrevious/clicked ++++++++++++++++++++++++++++++++ + +This event is called, if the 'pagination previous' button in the ``Stage`` +component's header section is clicked. EXT:form uses this event to render the +previous page of the form. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * @return void + */ + getPublisherSubscriber().subscribe('view/paginationPrevious/clicked', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-ready: + +view/ready +++++++++++ + +EXT:form makes it possible to load :ref:`your own JavaScript module <concepts-formeditor-basicjavascriptconcepts-registercustomjavascriptmodules>`. +If all modules are loaded, the view-model method ``_loadAdditionalModules`` +calls this event. EXT:form uses this event to remove the preloader icon and +finally initialize the ``form editor``. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * @return void + */ + getPublisherSubscriber().subscribe('view/ready', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-redobutton-clicked: + +view/redoButton/clicked ++++++++++++++++++++++++ + +This event is called if the redo button in the ``form editor`` header is +clicked. The addition/ deletion and movement of form elements and property +collection elements (validators/ finishers) is saved in an internal stack in +order to reset the undo/ redo functionality. EXT:form uses this event to reset +this stack to the previous state. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * @return void + */ + getPublisherSubscriber().subscribe('view/redoButton/clicked', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-stage-abstract-button-newelement-clicked: + +view/stage/abstract/button/newElement/clicked ++++++++++++++++++++++++++++++++++++++++++++++ + +This event is called if the "Create new element" button at the end of the +``Stage`` component in the ``abstract view`` mode is clicked. EXT:form uses +this event to display the "new element" dialog box. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = targetEvent + * args[1] = configuration + * @return void + */ + getPublisherSubscriber().subscribe('view/stage/abstract/button/newElement/clicked', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-stage-abstract-dnd-change: + +view/stage/abstract/dnd/change +++++++++++++++++++++++++++++++ + +EXT:form uses the jQuery plugin 'jquery.mjs.nestedSortable' for the drag-and- +drop functionality. The 'change' event from 'jquery.mjs.nestedSortable' calls +the ``view/stage/abstract/dnd/change`` event in the ``Stage`` component in the +``abstract view`` mode if form elements are sorted. EXT:form uses this event to +set various CSS classes during the drag-and-drop process. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = placeholderDomElement + * args[1] = parentFormElementIdentifierPath + * args[2] = enclosingCompositeFormElement + * @return void + */ + getPublisherSubscriber().subscribe('view/stage/abstract/dnd/change', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-stage-abstract-dnd-start: + +view/stage/abstract/dnd/start ++++++++++++++++++++++++++++++ + +EXT:form uses the jQuery plugin 'jquery.mjs.nestedSortable' for the drag-and- +drop functionality. The 'start' event from 'jquery.mjs.nestedSortable' calls +the ``view/stage/abstract/dnd/start`` event in the ``Stage`` component in the +``abstract view`` mode if form elements are sorted. EXT:form uses this event to +set various CSS classes at the start of the drag-and-drop process. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = draggedFormElementDomElement + * args[1] = draggedFormPlaceholderDomElement + * @return void + */ + getPublisherSubscriber().subscribe('view/stage/abstract/dnd/start', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-stage-abstract-dnd-stop: + +view/stage/abstract/dnd/stop +++++++++++++++++++++++++++++ + +EXT:form uses the jQuery plugin 'jquery.mjs.nestedSortable' for the drag-and- +drop functionality. The 'stop' event from 'jquery.mjs.nestedSortable' calls the +``view/stage/abstract/dnd/stop`` event in the ``Stage`` component in the +``abstract view`` mode if form elements are sorted. EXT:form uses this event to +to re-render the ``Tree``, ``Stage`` and ``Inspector`` components at the end of +the drag-and-drop process and to select the moved form element. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = draggedFormElementIdentifierPath + * @return void + */ + getPublisherSubscriber().subscribe('view/stage/abstract/dnd/stop', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-stage-abstract-dnd-update: + +view/stage/abstract/dnd/update +++++++++++++++++++++++++++++++ + +EXT:form uses the jQuery plugin 'jquery.mjs.nestedSortable' for the drag-and- +drop functionality. The 'update' event from 'jquery.mjs.nestedSortable' calls +the ``view/stage/abstract/dnd/update`` event in the ``Stage`` component in the +``abstract view`` mode if form elements are sorted. EXT:form uses this event +to move the form element in the ``form definition`` accordingly at the end of +the drag-and-drop process. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = movedDomElement + * args[1] = movedFormElementIdentifierPath + * args[2] = previousFormElementIdentifierPath + * args[3] = nextFormElementIdentifierPath + * @return void + */ + getPublisherSubscriber().subscribe('view/stage/abstract/dnd/update', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-stage-abstract-elementtoolbar-button-newelement-clicked: + +view/stage/abstract/elementToolbar/button/newElement/clicked +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +This event is called if the "Create new element" button in the form-element +toolbar or "Inside" or "After" in the split button is clicked. EXT:form uses +this event to display the "New element" dialog box. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = targetEvent + * args[1] = configuration + * @return void + */ + getPublisherSubscriber().subscribe('view/stage/abstract/elementToolbar/button/newElement/clicked', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-stage-abstract-render-postprocess: + +view/stage/abstract/render/postProcess +++++++++++++++++++++++++++++++++++++++ + +This event is called after the ``abstract view`` of the ``Stage`` component has +been rendered. EXT:form uses this event to render the undo/ redo buttons. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * @return void + */ + getPublisherSubscriber().subscribe('view/stage/abstract/render/postProcess', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-stage-abstract-render-preprocess: + +view/stage/abstract/render/preProcess ++++++++++++++++++++++++++++++++++++++ + +This event is called before the ``abstract view`` of the ``Stage`` component is +rendered. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * @return void + */ + getPublisherSubscriber().subscribe('view/stage/abstract/render/preProcess', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-stage-abstract-render-template-perform: + +view/stage/abstract/render/template/perform ++++++++++++++++++++++++++++++++++++++++++++ + +The methods ``getFormEditorApp().getViewModel().renderAbstractStageArea()`` +call this event. Strictly speaking, the ``Stage`` component in the method +``_renderTemplateDispatcher()`` calls this event. The ``form editor`` requires +for each form element an inline HTML template the corresponding JavaScript +code. Information matching inline HTML templates to the appropriate form +elements must be configured within :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formeditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>`. +At this point, the key identifying the form element follows a convention: +``FormElement-<formElementTypeIdentifier>``. The value for the key tells the +``form editor`` which inline HTML template should be loaded for the respective +form element. The ``_renderTemplateDispatcher()`` method then identifies, by +means of the form element's ``<formElementTypeIdentifier>``, the corresponding +JavaScript code to fill the inline HTML template with life. +``_renderTemplateDispatcher()`` contains a hard-coded list with the +``<formElementTypeIdentifier>`` that is brought in with the EXT:form, and it +renders the inline HTML templates accordingly. At the end, the +``view/stage/abstract/render/template/perform`` event is called. If you wish to +implement your own form element and show it in the ``form editor``, this event +can be used to execute in :ref:`your own JavaScript module <concepts-formeditor-basicjavascriptconcepts-registercustomjavascriptmodules>` +the corresponding JavaScript code, with the help of the ``<formElementTypeIdentifier>``. +This is generally enough to allow the ``Stage/SimpleTemplate`` and/ or +``Stage/SelectTemplate`` inline HTML template to be rendered for your own form +element and, in the JavaScript code, to access the ``getFormEditorApp().getViewModel().getStage().renderSimpleTemplateWithValidators()`` +and/ or ``getFormEditorApp().getViewModel().getStage().renderSelectTemplates()`` +method delivered with EXT:form. An overview over the functionality of the +formEditorPartials for the ``<formElementTypeIdentifier>`` and its JavaScript +code is found :ref:`here <apireference-formeditor-stage-commonabstractformelementtemplates>`. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = formElement + * args[1] = template + * @return void + */ + getPublisherSubscriber().subscribe('view/stage/abstract/render/template/perform', function(topic, args) { + }); + + +A simple example reusing the EXT:form inline HTML template ``Stage/SelectTemplate`` and the EXT:form JavaScript code ``renderSelectTemplates()`` +for a custom form element with ``<formElementTypeIdentifier>`` = 'GenderSelect'. +In this example, 'GenderSelect' is basically a radio button form element with some predefined options. + + +.. code-block:: yaml + :emphasize-lines: 11 + + TYPO3: + CMS: + Form: + prototypes: + standard: + formEditor: + dynamicRequireJsModules: + additionalViewModelModules: + - 'TYPO3/CMS/MySitePackage/Backend/FormEditor/ViewModel' + formEditorPartials: + FormElement-GenderSelect: 'Stage/SelectTemplate' + formElementsDefinition: + GenderSelect: + __inheritances: + 10: 'TYPO3.CMS.Form.prototypes.standard.formElementsDefinition.RadioButton' + renderingOptions: + templateFileName: 'RadioButton' + properties: + options: + f: 'Female' + m: 'Male' + u: 'Unicorn' + a: 'Alien' + formEditor: + label: 'Gender Select' + group: select + groupSorting: 9000 + predefinedDefaults: + properties: + options: + f: 'Female' + m: 'Male' + u: 'Unicorn' + a: 'Alien' + editors: + 300: null + + +.. code-block:: javascript + :emphasize-lines: 105-109 + + /** + * Module: TYPO3/CMS/MySitePackage/Backend/FormEditor/ViewModel + */ + define(['jquery', + 'TYPO3/CMS/Form/Backend/FormEditor/Helper' + ], function($, Helper) { + 'use strict'; + + return (function($, Helper) { + + /** + * @private + * + * @var object + */ + var _formEditorApp = null; + + /** + * @private + * + * @return object + */ + function getFormEditorApp() { + return _formEditorApp; + }; + + /** + * @private + * + * @return object + */ + function getPublisherSubscriber() { + return getFormEditorApp().getPublisherSubscriber(); + }; + + /** + * @private + * + * @return object + */ + function getUtility() { + return getFormEditorApp().getUtility(); + }; + + /** + * @private + * + * @param object + * @return object + */ + function getHelper() { + return Helper; + }; + + /** + * @private + * + * @return object + */ + function getCurrentlySelectedFormElement() { + return getFormEditorApp().getCurrentlySelectedFormElement(); + }; + + /** + * @private + * + * @param mixed test + * @param string message + * @param int messageCode + * @return void + */ + function assert(test, message, messageCode) { + return getFormEditorApp().assert(test, message, messageCode); + }; + + /** + * @private + * + * @return void + * @throws 1491643380 + */ + function _helperSetup() { + assert('function' === $.type(Helper.bootstrap), + 'The view model helper does not implement the method "bootstrap"', + 1491643380 + ); + Helper.bootstrap(getFormEditorApp()); + }; + + /** + * @private + * + * @return void + */ + function _subscribeEvents() { + /** + * @private + * + * @param string + * @param array + * args[0] = formElement + * args[1] = template + * @return void + */ + getPublisherSubscriber().subscribe('view/stage/abstract/render/template/perform', function(topic, args) { + if (args[0].get('type') === 'GenderSelect') { + getFormEditorApp().getViewModel().getStage().renderSelectTemplates(args[0], args[1]); + } + }); + }; + + /** + * @public + * + * @param object formEditorApp + * @return void + */ + function bootstrap(formEditorApp) { + _formEditorApp = formEditorApp; + _helperSetup(); + _subscribeEvents(); + }; + + /** + * Publish the public methods. + * Implements the "Revealing Module Pattern". + */ + return { + bootstrap: bootstrap + }; + })($, Helper); + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-stage-element-clicked: + +view/stage/element/clicked +++++++++++++++++++++++++++ + +This event is called from the ``Stage`` component when a form element is +clicked. EXT:form uses this event to select this element and to display the +form-element toolbar. In addition, the ``Tree`` and ``Inspector`` components +are re-rendered. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = formElementIdentifierPath + * @return void + */ + getPublisherSubscriber().subscribe('view/stage/element/clicked', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-stage-panel-clicked: + +view/stage/panel/clicked +++++++++++++++++++++++++ + +This event is called if the header section of the ``Stage`` component is +clicked. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * @return void + */ + getPublisherSubscriber().subscribe('view/stage/panel/clicked', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-stage-preview-render-postprocess: + +view/stage/preview/render/postProcess ++++++++++++++++++++++++++++++++++++++ + +This event is called after the ``preview view`` of the ``Stage`` component has +been rendered. EXT:form uses this event to render the undo/ redo buttons. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * @return void + */ + getPublisherSubscriber().subscribe('view/stage/preview/render/postProcess', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-structure-button-newpage-clicked: + +view/structure/button/newPage/clicked ++++++++++++++++++++++++++++++++++++++ + +This event is called from the onClick event of the ``Tree`` component's "Create +new page" button. EXT:form uses this event to display the "new page" dialog +box. + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = targetEvent + * @return void + */ + getPublisherSubscriber().subscribe('view/structure/button/newPage/clicked', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-structure-renew-postprocess: + +view/structure/renew/postProcess +++++++++++++++++++++++++++++++++ + +This event is called from the view-model after the ``Tree`` component has been +re-rendered. EXT:form uses this event to display potential validation errors +from form elements in the ``Tree`` component. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * @return void + */ + getPublisherSubscriber().subscribe('view/structure/renew/postProcess', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-structure-root-selected: + +view/structure/root/selected +++++++++++++++++++++++++++++ + +This event is called if the root form element in the ``Tree`` component is +clicked. EXT:form uses this event to re-render the ``Stage``, ``Inspector`` and +``Tree`` components. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * @return void + */ + getPublisherSubscriber().subscribe('view/structure/root/selected', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-tree-dnd-change: + +view/tree/dnd/change +++++++++++++++++++++ + +EXT:form uses the jQuery plugin 'jquery.mjs.nestedSortable' for the drag-and- +drop functionality. The 'change' event from 'jquery.mjs.nestedSortable' calls +the ``view/tree/dnd/change`` event in der ``Tree`` component if form elements +are sorted. EXT:form uses this event to set various CSS classes during the drag +-and-drop process. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = placeholderDomElement + * args[1] = parentFormElementIdentifierPath + * args[2] = enclosingCompositeFormElement + * @return void + */ + getPublisherSubscriber().subscribe('view/tree/dnd/change', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-tree-dnd-stop: + +view/tree/dnd/stop +++++++++++++++++++ + +EXT:form uses the jQuery plugin 'jquery.mjs.nestedSortable' for the drag-and- +drop functionality. The 'stop' event from 'jquery.mjs.nestedSortable' calls the +``view/tree/dnd/stop`` event in the ``Tree`` component if form elements are +sorted. EXT:form uses this event to re-render ``Tree``, ``Stage`` and +``Inspector`` components at the end of the drag-and-drop process and to select +the moved form element. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = draggedFormElementIdentifierPath + * @return void + */ + getPublisherSubscriber().subscribe('view/tree/dnd/stop', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-tree-dnd-update: + +view/tree/dnd/update +++++++++++++++++++++ + +EXT:form uses the jQuery plugin 'jquery.mjs.nestedSortable' for the drag-and- +drop functionality. The 'update' event from 'jquery.mjs.nestedSortable' calls +the ``view/tree/dnd/update`` event in der ``Tree`` component if form elements +are sorted. EXT:form uses this event to move the form element in the ``form +definition`` accordingly at the end of the drag-and-drop process. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = movedDomElement + * args[1] = movedFormElementIdentifierPath + * args[2] = previousFormElementIdentifierPath + * args[3] = nextFormElementIdentifierPath + * @return void + */ + getPublisherSubscriber().subscribe('view/tree/dnd/update', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-tree-node-clicked: + +view/tree/node/clicked +++++++++++++++++++++++ + +This event is called from the ``Tree`` component if a form element is clicked. +EXT:form uses this event to re-render the ``Stage`` and ``Inspector`` +components and select the form element. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = formElementIdentifierPath + * @return void + */ + getPublisherSubscriber().subscribe('view/tree/node/clicked', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-tree-render-listitemadded: + +view/tree/render/listItemAdded +++++++++++++++++++++++++++++++ + +This event is called by the ``Tree`` component for each form element as soon as +it is added to the tree. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * args[0] = listItem + * args[1] = formElement + * @return void + */ + getPublisherSubscriber().subscribe('view/tree/render/listItemAdded', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-undobutton-clicked: + +view/undoButton/clicked ++++++++++++++++++++++++ + +This event is called when the undo button is clicked in the ``form editor`` +header. The history of adding / deleting and moving form elements and property +collection elements (validators/ finishers) is stored in an internal stack to +implement the undo / redo functionality. EXT:form uses this event to set this +stack to the next state. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * @return void + */ + getPublisherSubscriber().subscribe('view/undoButton/clicked', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-viewmodebutton-abstract-clicked: + +view/viewModeButton/abstract/clicked +++++++++++++++++++++++++++++++++++++ + +This event is called when the abstract view button is clicked in the header +area of the ``Stage`` component. EXT:form uses this event to render the +``abstract view`` in the ``Stage`` component. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * @return void + */ + getPublisherSubscriber().subscribe('view/viewModeButton/abstract/clicked', function(topic, args) { + }); + + +.. _apireference-formeditor-basicjavascriptconcepts-events-view-viewmodebutton-preview-clicked: + +view/viewModeButton/preview/clicked ++++++++++++++++++++++++++++++++++++ + +This event is called when the preview button is clicked in the header area of +the ``Stage`` component. EXT:form uses this event to render the ``preview +view`` in the ``Stage`` component. + + +Subscribe to the event: + +.. code-block:: javascript + + /** + * @private + * + * @param string + * @param array + * @return void + */ + getPublisherSubscriber().subscribe('view/viewModeButton/preview/clicked', function(topic, args) { + }); + + + +.. _apireference-formeditor-basicjavascriptconcepts-formelementmodel: + +FormElement model +^^^^^^^^^^^^^^^^^ + + +.. _apireference-formeditor-basicjavascriptconcepts-formelementmodel-property-parentrenderable: + +Property: __parentRenderable +++++++++++++++++++++++++++++ + +__parentRenderable includes the parent element as ``FormElement model``. + + +.. _apireference-formeditor-basicjavascriptconcepts-formelementmodel-property-identifierpath: + +Property: __identifierPath +++++++++++++++++++++++++++ + +Internally, all form elements are identified by their 'identifier' property, +which must be unique for each form. The ``__identifierPath`` property contains +the path to the element (as seen from the first element), separated by a ``/``. +Using this path, you can access the element directly through an API method. + + +.. _apireference-formeditor-basicjavascriptconcepts-formelementmodel-method-get: + +Method: get() ++++++++++++++ + +Each property of the ``FormElement model`` can be accessed by the ``get()`` +method through the property path (separated by ``.``). Prerequisite for this +is that all levels up to the target property are objects. + + +Example of a ``FormElement model``: + +.. code-block:: javascript + + { + "identifier": "name", + "defaultValue": "", + "label": "Name", + "type": "Text", + "properties": { + "fluidAdditionalAttributes": { + "placeholder": "Name" + } + }, + "__parentRenderable": "example-form/page-1 (filtered)", + "__identifierPath": "example-form/page-1/name", + "validators": [ + { + "identifier": "NotEmpty" + } + ] + } + + +Access to ``properties.fluidAdditionalAttributes.placeholder``: + +.. code-block:: javascript + + // value = 'Name' + var value = getFormEditorApp().getFormElementByIdentifierPath('example-form/page-1/name').get('properties.fluidAdditionalAttributes.placeholder'); + + +Two exceptions are the two arrays of "finishers" / "validators" (``property +collections``) and the ``renderables``. + + +.. _apireference-formeditor-basicjavascriptconcepts-formelementmodel-method-get-propertycollectionproperties: + +Accessing property collection properties +'''''''''''''''''''''''''''''''''''''''' + +Property collection are identified as form elements through the property +``identifier``. Because property collection properties are in an array and +their positions in the array are potentially unknown, the ``getFormEditorApp().buildPropertyPath()`` +method exists. This can be used to access a property of a property collection +item via its ``identifier``. + + +Example of a ``FormElement model``: + +.. code-block:: javascript + + { + "identifier": "name", + "defaultValue": "", + "label": "Name", + "type": "Text", + "properties": { + "fluidAdditionalAttributes": { + "placeholder": "Name" + } + }, + "__parentRenderable": "example-form/page-1 (filtered)", + "__identifierPath": "example-form/page-1/name", + "validators": [ + { + "identifier": "StringLength" + "options": { + "minimum": "1", + "maximum": "2" + } + } + ] + } + +Access to ``options.minimum`` of the validator ``StringLength``: + +.. code-block:: javascript + + var formElement = getFormEditorApp().getFormElementByIdentifierPath('example-form/page-1/name'); + var propertyPath = getFormEditorApp().buildPropertyPath('options.minimum', 'StringLength', 'validators', formElement); + // value = 1 + var value = formElement.get(propertyPath); + + +.. _apireference-formeditor-basicjavascriptconcepts-formelementmodel-method-get-renderables: + +Accessing renderables +''''''''''''''''''''' + +Like ``property collections``, ``renderables`` (the child elements) are also in +an array and their position in the array is potentially unknown. Direct access +to child elements through the ``get()`` method is impossible. +``formElement.get('renderables')`` supplies an array with the ``FormElement +models`` of the child elements. You must then loop over this array. Access to a +specific child element should be done using ``getFormEditorApp().getFormElementByIdentifierPath()``. + + +.. _apireference-formeditor-basicjavascriptconcepts-formelementmodel-method-set: + +Method: set() ++++++++++++++ + +Any property of the ``FormElement model`` can be written using the ``set()`` +method by means of the property path (separated by ``.``). + +Example of a ``FormElement model``: + +.. code-block:: javascript + + { + "identifier": "name", + "defaultValue": "", + "label": "Name", + "type": "Text", + "properties": { + "fluidAdditionalAttributes": { + "placeholder": "Name" + } + }, + "__parentRenderable": "example-form/page-1 (filtered)", + "__identifierPath": "example-form/page-1/name", + "validators": [ + { + "identifier": "NotEmpty" + } + ] + } + + +Set the property ``properties.fluidAdditionalAttributes.placeholder``: + +.. code-block:: javascript + + getFormEditorApp().getFormElementByIdentifierPath('example-form/page-1/name').set('properties.fluidAdditionalAttributes.placeholder', 'New Placeholder'); + + +Example of the ``FormElement model`` after the ``set()`` operation: + +.. code-block:: javascript + + { + "identifier": "name", + "defaultValue": "", + "label": "Name", + "type": "Text", + "properties": { + "fluidAdditionalAttributes": { + "placeholder": "New Placeholder" + } + }, + "__parentRenderable": "example-form/page-1 (filtered)", + "__identifierPath": "example-form/page-1/name", + "validators": [ + { + "identifier": "NotEmpty" + } + ] + } + + +Two exceptions are the two arrays of "finishers" / "validators" (``property +collections``) and the ``renderables``. + + +.. _apireference-formeditor-basicjavascriptconcepts-formelementmodel-method-set-propertycollectionproperties: + +Setting property collection properties +'''''''''''''''''''''''''''''''''''''' + +In principle, the same applies here as for :ref:`get property collection properties<apireference-formeditor-basicjavascriptconcepts-formelementmodel-method-get-propertycollectionproperties>`. + +Set the property ``options.minimum`` of the validator ``StringLength``: + +.. code-block:: javascript + + var formElement = getFormEditorApp().getFormElementByIdentifierPath('example-form/page-1/name'); + var propertyPath = getFormEditorApp().buildPropertyPath('options.minimum', 'StringLength', 'validators', formElement); + formElement.set(propertyPath, '2'); + + +.. _apireference-formeditor-basicjavascriptconcepts-formelementmodel-method-set-renderables: + +Setting renderables +''''''''''''''''''' + +To add child form elements to a ``FormElement model``, the appropriate API +methods should be used: + +- getFormEditorApp().createAndAddFormElement() +- getFormEditorApp().addFormElement() +- getFormEditorApp().moveFormElement() +- getFormEditorApp().removeFormElement() + + +.. _apireference-formeditor-basicjavascriptconcepts-formelementmodel-method-unset: + +Method: unset() ++++++++++++++++ + +Any property of the ``FormElement model`` can be deleted using the method +``unset()`` by means of the property path (separated by ``.``). + +Example of a ``FormElement model``: + +.. code-block:: javascript + + { + "identifier": "name", + "defaultValue": "", + "label": "Name", + "type": "Text", + "properties": { + "fluidAdditionalAttributes": { + "placeholder": "Name" + } + }, + "__parentRenderable": "example-form/page-1 (filtered)", + "__identifierPath": "example-form/page-1/name", + "validators": [ + { + "identifier": "NotEmpty" + } + ] + } + + +Delete the property ``properties.fluidAdditionalAttributes.placeholder``: + +.. code-block:: javascript + + // value = 'Name' + var value = getFormEditorApp().getFormElementByIdentifierPath('example-form/page-1/name').unset('properties.fluidAdditionalAttributes.placeholder'); + + +Example of the ``FormElement model`` after the ``unset()`` operation: + +.. code-block:: javascript + + { + "identifier": "name", + "defaultValue": "", + "label": "Name", + "type": "Text", + "properties": { + "fluidAdditionalAttributes": {} + }, + "__parentRenderable": "example-form/page-1 (filtered)", + "__identifierPath": "example-form/page-1/name", + "validators": [ + { + "identifier": "NotEmpty" + } + ] + } + + +Two exceptions are the two arrays of "finishers" / "validators" (``property +collections``) and the ``renderables``. + + +.. _apireference-formeditor-basicjavascriptconcepts-formelementmodel-method-unset-propertycollectionproperties: + +Remove property collection properties +''''''''''''''''''''''''''''''''''''' + +In principle, the same applies here as for :ref:`get property collection properties<apireference-formeditor-basicjavascriptconcepts-formelementmodel-method-get-propertycollectionproperties>`. + +Delete the property ``options.minimum`` of the validator ``StringLength``: + +.. code-block:: javascript + + var formElement = getFormEditorApp().getFormElementByIdentifierPath('example-form/page-1/name'); + var propertyPath = getFormEditorApp().buildPropertyPath('options.minimum', 'StringLength', 'validators', formElement); + formElement.unset(propertyPath); + + +.. _apireference-formeditor-basicjavascriptconcepts-formelementmodel-method-unset-renderables: + +Remove renderables +'''''''''''''''''' + +To delete a ``FormElement model``, the corresponding API method +``getFormEditorApp().removeFormElement()`` should be used. + + +.. _apireference-formeditor-basicjavascriptconcepts-formelementmodel-method-on: + +Method: on() +++++++++++++ + +Any number of :ref:`Publisher/Subscriber<concepts-formeditor-basicjavascriptconcepts-events>` +events can be assigned to any property path of a ``FormElement model``. Each +``set()`` operation on this property path will then call these events. By +default, EXT:form registers the event :ref:`core/formElement/somePropertyChanged<apireference-formeditor-basicjavascriptconcepts-events-core-formelement-somepropertychanged>` +for each property path. + +Example: + +.. code-block:: javascript + + getFormEditorApp().getFormElementByIdentifierPath('example-form/page-1/name').on('properties.fluidAdditionalAttributes.placeholder', 'my/custom/event'); + getFormEditorApp().getFormElementByIdentifierPath('example-form/page-1/name').set('properties.fluidAdditionalAttributes.placeholder', 'New Placeholder'); + // now, the event 'my/custom/event' will be published + + +.. _apireference-formeditor-basicjavascriptconcepts-formelementmodel-method-off: + +Method: off() ++++++++++++++ + +Any event registered via :ref:`on()<apireference-formeditor-basicjavascriptconcepts-formelementmodel-method-on>` +can be removed with off(). + +Example: + +.. code-block:: javascript + + getFormEditorApp().getFormElementByIdentifierPath('example-form/page-1/name').off('properties.fluidAdditionalAttributes.placeholder', 'my/custom/event'); + + +.. _apireference-formeditor-basicjavascriptconcepts-formelementmodel-method-getobjectdata: + +Method: getObjectData() ++++++++++++++++++++++++ + +All ``FormElement model`` properties are private and cannot be manipulated +directly from the outside. They can only be accessed via ``set()`` or +``get()``. This method is used internally to obtain all data of a ``FormElement +model`` in object form so that they can be used in, for example, Ajax requests. +``getObjectData()`` returns a dereferenced object of the ``FormElement model`` +with all internal data, thus allowing read access to all data set via +``set()``. + + +.. _apireference-formeditor-basicjavascriptconcepts-formelementmodel-method-tostring: + +Method: toString() +++++++++++++++++++ + +A method that was implemented for debugging purposes. Returns the object data +supplied by ``getObjectData()`` in string form. + +.. code-block:: javascript + + console.log(formElement.toString()); + + +.. _apireference-formeditor-basicjavascriptconcepts-formelementmodel-method-clone: + +Method: clone() ++++++++++++++++ + +If necessary, a form element can be cloned. Returns a dereferenced clone of the +original ``FormElement model``. + + +.. code-block:: javascript + + var dolly = formElement.clone(); \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ApiReference/RenderableInterface/getParentRenderable.rst b/typo3/sysext/form/Documentation/ApiReference/RenderableInterface/getParentRenderable.rst new file mode 100644 index 0000000000000000000000000000000000000000..9ac1de197857d1716a01a8cad72856195e761875 --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/RenderableInterface/getParentRenderable.rst @@ -0,0 +1,10 @@ +getParentRenderable() +''''''''''''''''''''' + +Return the parent form element. + +Signature: + +.. code-block:: php + + public function getParentRenderable(); diff --git a/typo3/sysext/form/Documentation/ApiReference/RenderableInterface/getTemplateName.rst b/typo3/sysext/form/Documentation/ApiReference/RenderableInterface/getTemplateName.rst new file mode 100644 index 0000000000000000000000000000000000000000..398a605ca88048fc7ebb0faebf4d9fe77b89e241 --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/RenderableInterface/getTemplateName.rst @@ -0,0 +1,10 @@ +getTemplateName() +''''''''''''''''' + +Get the template name of the form element. + +Signature: + +.. code-block:: php + + public function getTemplateName(): string; diff --git a/typo3/sysext/form/Documentation/ApiReference/RenderableInterface/setParentRenderable.rst b/typo3/sysext/form/Documentation/ApiReference/RenderableInterface/setParentRenderable.rst new file mode 100644 index 0000000000000000000000000000000000000000..95abe871490eed889d570059858b9b5ae2090117 --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/RenderableInterface/setParentRenderable.rst @@ -0,0 +1,11 @@ +setParentRenderable() +''''''''''''''''''''' + +Set the new parent renderable. You should not call this directly. +It is automatically called by addRenderable. + +Signature: + +.. code-block:: php + + public function setParentRenderable(CompositeRenderableInterface $renderable); diff --git a/typo3/sysext/form/Documentation/ApiReference/RootRenderableInterface/getIdentifier.rst b/typo3/sysext/form/Documentation/ApiReference/RootRenderableInterface/getIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..58da909a0811ef0100927b041e1402ae5fcfc9ba --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/RootRenderableInterface/getIdentifier.rst @@ -0,0 +1,10 @@ +getIdentifier() +''''''''''''''' + +Returns the identifier of the form element. + +Signature: + +.. code-block:: php + + public function getIdentifier(): string; diff --git a/typo3/sysext/form/Documentation/ApiReference/RootRenderableInterface/getLabel.rst b/typo3/sysext/form/Documentation/ApiReference/RootRenderableInterface/getLabel.rst new file mode 100644 index 0000000000000000000000000000000000000000..7d2bf74d689dcfa0dd4fdc6c481e0e588ae1f2bf --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/RootRenderableInterface/getLabel.rst @@ -0,0 +1,10 @@ +getLabel() +'''''''''' + +Get the label of the form element. + +Signature: + +.. code-block:: php + + public function getLabel(): string; diff --git a/typo3/sysext/form/Documentation/ApiReference/RootRenderableInterface/getRendererClassName.rst b/typo3/sysext/form/Documentation/ApiReference/RootRenderableInterface/getRendererClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..9c0a969310357c89d7015f1c3cff86fac551ea62 --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/RootRenderableInterface/getRendererClassName.rst @@ -0,0 +1,10 @@ +getRendererClassName() +'''''''''''''''''''''' + +Get the renderer class name. + +Signature: + +.. code-block:: php + + public function getRendererClassName(): string; diff --git a/typo3/sysext/form/Documentation/ApiReference/RootRenderableInterface/getRenderingOptions.rst b/typo3/sysext/form/Documentation/ApiReference/RootRenderableInterface/getRenderingOptions.rst new file mode 100644 index 0000000000000000000000000000000000000000..0f1e7481754dfe691913ff4035c6c5fd57ba048b --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/RootRenderableInterface/getRenderingOptions.rst @@ -0,0 +1,10 @@ +getRenderingOptions() +''''''''''''''''''''' + +Get all rendering options of the form element. + +Signature: + +.. code-block:: php + + public function getRenderingOptions(): array; diff --git a/typo3/sysext/form/Documentation/ApiReference/RootRenderableInterface/getType.rst b/typo3/sysext/form/Documentation/ApiReference/RootRenderableInterface/getType.rst new file mode 100644 index 0000000000000000000000000000000000000000..6e540affca45cd5e65abd1ce88aa29c35faf3dd3 --- /dev/null +++ b/typo3/sysext/form/Documentation/ApiReference/RootRenderableInterface/getType.rst @@ -0,0 +1,11 @@ +getType() +''''''''' + +Abstract "type" of the form element. +For example, the type is used during the rendering process to determine the template file. + +Signature: + +.. code-block:: php + + public function getType(): string; diff --git a/typo3/sysext/form/Documentation/Concepts/Configuration/Index.rst b/typo3/sysext/form/Documentation/Concepts/Configuration/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..130375e390d247f8e368b079f092ed33f6cf41fd --- /dev/null +++ b/typo3/sysext/form/Documentation/Concepts/Configuration/Index.rst @@ -0,0 +1,478 @@ +.. include:: ../../Includes.txt + + +.. _concepts-configuration: + +Configuration +============= + + +.. _concepts-configuration-whysomuchconfiguration: + +A lot of configuration. Why? +---------------------------- + +The requirements for building forms in a declarative and programmatic way +are complex. What we have learned so far is that the program code must be +kept as generic as possible to handle the dynamics of forms, but a generic +program code means a lot of configurative overhead. + +Initially, the configuration may overwhelm you, but it also has some great +advantages. Many aspects of EXT:form can be manipulated in a purely +configurative manner without involving a developer. + +Furthermore, we wanted to avoid the configuration being done at places +whose context actually suggests something different. This pedantry, +however, leads to the situation in which certain settings have to be +defined multiple times at multiple places. This may seem nonsensical, but +it avoids unpredictable behaviour. Within the form framework, nothing +happens magically. It is all about configuration. + + +.. _concepts-configuration-whyyaml: + +Why YAML? +--------- + +Former versions of EXT:form used a subset of TypoScript to describe the +definition of a specific form and the behaviour of the included form +elements. This led to a lot of confusion from integrators because the +implemented definition language looked like TypoScript but did not behave +like TypoScript. + +Since the definition of forms and form elements must be declarative, the +EXT:form team decided to use YAML. Just through the visual appearance of +YAML, it should be clear to everyone that neither magic nor TypoScript +stdWrap functionality are possible. + + +.. _concepts-configuration-yamlregistration: + +YAML registration +----------------- + +At the moment, configuration via YAML is not natively integrated into the +core of TYPO3. You have to make a short detour by using TypoScript in order +to register your YAML configuration. Furthermore, there is a "speciality" +regarding the integration of your YAML configuration for the backend +module. + +.. hint:: + We recommend using a `site package <https://de.slideshare.net/benjaminkott/typo3-the-anatomy-of-sitepackages>`_. + This will make your life easier if you want to customise EXT:form + heavily in order to suit the customer's needs. + + +.. _concepts-configuration-yamlregistration-frontend: + +YAML registration for the frontend +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +EXT:form registers two YAML configuration files which are required for the +frontend. + +.. code-block:: typoscript + + plugin.tx_form { + settings { + yamlConfigurations { + 10 = EXT:form/Configuration/Yaml/BaseSetup.yaml + 20 = EXT:form/Configuration/Yaml/FormEngineSetup.yaml + } + } + } + +Since the keys 10 and 20 are already taken, we recommend registering your +own configuration beginning with the key ``100``. + +.. code-block:: typoscript + + plugin.tx_form { + settings { + yamlConfigurations { + 100 = EXT:my_site_package/Configuration/Yaml/CustomFormSetup.yaml + } + } + } + +.. _concepts-configuration-yamlregistration-backend: + +YAML registration for the backend +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +EXT:form registers three YAML configuration files which are required for +the backend. + +.. code-block:: typoscript + + module.tx_form { + settings { + yamlConfigurations { + 10 = EXT:form/Configuration/Yaml/BaseSetup.yaml + 20 = EXT:form/Configuration/Yaml/FormEditorSetup.yaml + 30 = EXT:form/Configuration/Yaml/FormEngineSetup.yaml + } + } + } + +Since the keys 10, 20, and 30 are already taken, we recommend registering +your own configuration beginning with the key ``100``. + +.. code-block:: typoscript + + module.tx_form { + settings { + yamlConfigurations { + 100 = EXT:my_site_package/Configuration/Yaml/CustomFormSetup.yaml + } + } + } + +.. important:: + Consider the following methods to register TypoScript for the backend. + +The backend module of EXT:form is based on Extbase. Such backend modules +can, like frontend plugins, be configured via TypoScript. The frontend +plugins are configured below ``plugin.tx_[pluginkey]``. For the +configuration of the backend ``module.tx_[pluginkey]`` is used. + +There are different ways to include the TypoScript configuration for the +backend: + +- a) use a file called `ext_typoscript_setup.txt`, +- b) use the API function ``\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addTypoScriptSetup()``, +- c) add the configuration to your existing TypoScript template. + +We recommend using methods a and b. Here is why. The file +:file:`ext_typoscript_setup.txt` can be stored within the root folder of +your own site package. It will be automatically loaded in both frontend and +backend of your TYPO3 installation. The API call (method b) does pretty +much the same. + +In both cases, the ``form editor`` will work as expected regardless the +chosen page from the page tree. If using the aforementioned method c, the +configuration would only be valid on a specific page tree, unless you add +your configuration to all trees within your installation. Nevertheless, +being on the root page (uid 0) would still be a problem. + +To sum it up: choose either method a or b, and you will be fine. + + +.. _concepts-configuration-yamlregistration-backend-ext_typoscript_setup.txt: + +YAML registration for the backend via ext_typoscript_setup.txt +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. code-block:: typoscript + + module.tx_form { + settings { + yamlConfigurations { + 100 = EXT:my_site_package/Configuration/Yaml/CustomFormSetup.yaml + } + } + } + + +.. _concepts-configuration-yamlregistration-backend-addtyposcriptsetup: + +YAML registration for the backend via addTypoScriptSetup() +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +Add the following PHP code to your :file:`ext_localconf.php` of your site +package: + +.. code-block:: php + + <?php + defined('TYPO3_MODE') or die(); + + call_user_func(function () { + if (TYPO3_MODE === 'BE') { + \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addTypoScriptSetup( + trim(' + module.tx_form { + settings { + yamlConfigurations { + 100 = EXT:my_site_package/Configuration/Yaml/CustomFormSetup.yaml + } + } + } + ') + ); + } + }); + + +.. _concepts-configuration-configurationaspects: + +Configuration aspects +--------------------- + +In EXT:form, four aspects can be configured: + +- the behaviour of the frontend rendering, +- the behaviour of the ``form editor``, +- the behaviour of the ``form manager``, and +- the behaviour of the ``form plugin``. + +Those aspects are defined in separate files which are only loaded in the +frontend/ backend when needed. This approach has two advantages: + +- increased clarity, +- increased performance, e.g. the ``form editor`` configuration is not + needed in the frontend and therefore not loaded. + +It is up to you if you want to follow this guideline or if you want to put +the whole configuration into one large file. + +There are some configurational aspects which cannot explicitly be assigned +to either the frontend or the backend. Instead, the configuration is +valid for both areas. For example, within the backend, the whole frontend +configuration is required in order to allow the form preview to work +properly. In addition, as soon as the form is rendered via the ``form +plugin``, the ``FormEngine`` configuration is needed to interpret the +overridden finisher configuration correctly. + + +.. _concepts-configuration-inheritances: + +Inheritances +------------ + +The final YAML configuration is not based on one huge file. Instead, it is +a compilation of a sequential process: + +- First of all, all registered configuration files are parsed as YAML and + are overlain according to their order. ``TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule()`` + is involved in this first step. +- After that, the ``__inheritances`` operator is applied. It is a unique + operator introduced by the form framework. +- Finally, all configuration entries with a value of ``null`` are deleted. + +Additionally, the frontend configuration can be extended/ overridden by +TypoScript: + +.. code-block:: typoscript + + plugin.tx_form { + settings { + yamlSettingsOverrides { + ... + } + } + } + +.. note:: + Your TypoScript overrides are not interpreted by the ``form editor``, + i.e. those settings are ignored. + +.. note:: + The described process is quite handy for you. As soon as you are working + with your :ref:`own configuration files <concepts-configuration-yamlregistration>`, + you only have to define the differences compared to the previously + loaded configuration files. + +For example, if you want to override the fluid templates and you therefore +register an additional configuration file via + +.. code-block:: typoscript + + plugin.tx_form { + settings { + yamlConfigurations { + # register your own additional configuration + # choose a number higher than 30 (below is reserved) + 100 = EXT:my_site_package/Configuration/Yaml/CustomFormSetup.yaml + } + } + } + +... you only have to define the following YAML setup in ``EXT:my_site_package/Configuration/Yaml/CustomFormSetup.yaml``: + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + formElementsDefinition: + Form: + renderingOptions: + templateRootPaths: + 20: 'EXT:my_site_package/Resources/Private/Frontend/Templates/' + partialRootPaths: + 20: 'EXT:my_site_package/Resources/Private/Frontend/Partials/' + layoutRootPaths: + 20: 'EXT:my_site_package/Resources/Private/Frontend/Layouts/' + +The values of your own configuration file will overrule the corresponding +values of the basic configuration file (:file:`EXT:form/Configuration/Yaml/BaseSetup.yaml`). + + +.. _concepts-configuration-inheritances-operator: + +__inheritances operator +^^^^^^^^^^^^^^^^^^^^^^^ + +The ``__inheritances`` operator is an extremely useful instrument. Using it +helps to significantly reduce the configuration effort. It behaves similar +to the ``<`` operator in TypoScript. That is, the definition of the source +object is copied to the target object. The configuration can be inherited +from several parent objects and can be overridden afterwards. Two simple +examples will show you the usage and behaviour of the ``__inheritances`` +operator. + +.. code-block:: yaml + + Form: + part01: + key01: value + key02: + key03: value + part02: + __inheritances: + 10: Form.part01 + +The configuration above results in: + +.. code-block:: yaml + + Form: + part01: + key01: value + key02: + key03: value + part02: + key01: value + key02: + key03: value + +As you can see, ``part02`` inherited all of ``part01``'s properties. + +.. code-block:: yaml + + Form: + part01: + key: value + part02: + __inheritances: + 10: Form.part01 + key: 'value override' + +The configuration above results in: + +.. code-block:: yaml + + Form: + part01: + key: value + part02: + key: 'value override' + +EXT:form heavily uses the ``__inheritances`` operator, in particular, for +the definition of form elements. The following example shows you how to use +the operator to define a new form element which behaves like the parent +element but also has its own properties. + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + formElementsDefinition: + GenderSelect: + __inheritances: + 10: 'TYPO3.CMS.Form.prototypes.standard.formElementsDefinition.RadioButton' + renderingOptions: + templateFileName: 'RadioButton' + properties: + options: + f: 'Female' + m: 'Male' + u: 'Unicorn' + a: 'Alien' + +The YAML configuration defines a new form element called ``GenderSelect``. +This element inherits its definition from the ``RadioButton`` element but +additionally ships four predefined options. Without any problems, the new +element can be used and overridden within the ``form definition``. + +.. hint:: + Currently, there is no built-in solution within the TYPO3 core to + preview the resulting/ final EXT:form YAML configuration. If you want + to check the configuration, there is a fishy way which you should never + implement on a production system. + + Open the file ``typo3/sysext/form/Classes/Mvc/Configuration/ConfigurationManager.php::getConfigurationFromYamlFile()`` + and add the following code before the ``return`` statement. + + .. code-block:: php + + \TYPO3\CMS\Extbase\Utility\DebuggerUtility::var_dump($yamlSettings, 'form configuration', 9999); + + Now open the ``Forms`` module in the backend or navigate to a page in + the frontend which contains a form. The DebuggerUtility will print the + final configuration directly to the screen. + +It will probably take some time to fully understand the awesomeness of +this operator. If you are eager to learn more about this great instrument, +check out the unit tests defined in ``EXT:form/Tests/Unit/Mvc/Configuration/InheritancesResolverServiceTest.php``. + + +.. _concepts-configuration-prototypes: + +Prototypes +---------- + +Most of the configurational aspects of the form framework are defined +in so-called ``prototypes``. By default, EXT:form defines a prototype +named ``standard``. The definition of form elements - including their +rendering in the frontend, ``form editor`` and ``form plugin`` - reside +within those prototypes. As soon as you create a new form, the specific +form definition references such a prototype. + +This allows you to do a lot of nifty stuff. Let your imagination run free. +For example: + +- based on the referenced prototype, the same form can load + + - ...varying templates + - ...varying ``form editor`` configurations + - ...varying ``form plugin`` finisher overrides + +- within the ``form manager``, depending on the selected prototype + + - ...varying ``form editor`` configurations can be loaded + - ...varying pre-configured form templates (boilerplates) can be chosen + +- different prototypes can define different/ extended form elements and + display them in the frontend/ ``form editor`` accordingly + +Check out the following use case to fully understand the concept behind +prototypes. Imagine that there are two defined prototypes: "noob" and +"poweruser". + +.. t3-field-list-table:: + :header-rows: 1 + + - :a: + :b: Prototype "noob" + :c: Prototype "poweruser" + + - :a: **Available form elements within the ``form editor``** + :b: Text, Textarea + :c: No changes. Default behaviour. + + - :a: **Available finisher within the ``form editor``** + :b: Only the email finisher is available. It offers a field for setting + the subject of the mail. All remaining fields are hidden and filled + with default values. + :c: No changes. Default behaviour. + + - :a: **Finisher overrides within the ``form plugin``** + :b: It is not possible to override the finisher configuration. + :c: No changes. Default behaviour. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/Concepts/Finishers/Index.rst b/typo3/sysext/form/Documentation/Concepts/Finishers/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..d9c689e02bea8a231ca0d97defa71cec40cf8e59 --- /dev/null +++ b/typo3/sysext/form/Documentation/Concepts/Finishers/Index.rst @@ -0,0 +1,80 @@ +.. include:: ../../Includes.txt + + +.. _concepts-finishers: + +Finishers +========= + +The form framework ships a bunch of finishers, which will be briefly +described here. For more details, please head to the API reference and check +out the section regarding :ref:`Finisher Options<apireference-finisheroptions>`. + + +.. _concepts-finishers-closurefinisher: + +Closure finisher +---------------- + +The 'Closure finisher' can only be used within forms that are created +programmatically. It allows you to execute your own finisher code without +implementing/ declaring a finisher. + + +.. _concepts-finishers-confirmationfinisher: + +Confirmation finisher +--------------------- + +The 'Confirmation finisher' is a simple finisher that outputs a given +text after the form has been submitted. + + +.. _concepts-finishers-deleteuploadsfinisher: + +DeleteUploads finisher +---------------------- + +The 'DeleteUploads finisher' removes submitted files. Use this finisher, +for example, after the email finisher if you do not want to keep the files +within your TYPO3 installation. + + +.. _concepts-finishers-emailfinisher: + +Email finisher +-------------- + +The 'Email finisher' sends an email to one recipient. EXT:form uses two +``EmailFinisher`` declarations with the identifiers ``EmailToReceiver`` and +``EmailToSender``. + + +.. _concepts-finishers-flashmessagefinisher: + +FlashMessage finisher +--------------------- + +The 'FlashMessage finisher' is a simple finisher that adds a message to the +FlashMessageContainer. + + +.. _concepts-finishers-redirectfinisher: + +Redirect finisher +----------------- + +The 'Redirect finisher' is a simple finisher that redirects to another page. +Additional link parameters can be added to the URL. + +.. note:: + This finisher stops the execution of all subsequent finishers in order to perform a redirect. + Therefore, this finisher should always be the last finisher to be executed. + +.. _concepts-finishers-savetodatabasefinisher: + +SaveToDatabase finisher +----------------------- + +The 'SaveToDatabase finisher' saves the data of a submitted form into a +database table. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/Concepts/FormConfigurationFormDefinition/Index.rst b/typo3/sysext/form/Documentation/Concepts/FormConfigurationFormDefinition/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..6e44f0bd88cc04e0d4494be32fb3ae96805caa08 --- /dev/null +++ b/typo3/sysext/form/Documentation/Concepts/FormConfigurationFormDefinition/Index.rst @@ -0,0 +1,110 @@ +.. include:: ../../Includes.txt + + +.. _concepts-formdefinition-vs-formconfiguration: + +Form configuration vs. form definition +====================================== + +So far, we have only described the configuration of the form framework. +Once again, based on prototypes, the form configuration allows you to +define: + +- which form elements, finishers, and validators are available, +- how those objects are pre-configured, +- how those objects will be displayed within the frontend and backend. + +In contrast, the **form definition** describes the specific form, including + +- all form elements and their corresponding validators, +- the order of the form elements within the form, and +- the finishers which are fired as soon as the form has been submitted. +- Furthermore, it defines the concrete values of each property of the + mentioned aspects. + +In other words, the **prototype configuration** defines the existence of a +form element of type ``Text`` globally. The **form definition** declares +that such a form element of type ``Text`` is located on page 1 at position +1 of a specific form. In addition, it carries the information that this form +element comes with the HTML attribute "placeholder" with value "Your name +here". The form definition is written by the ``form editor``. + + +Example form definition +----------------------- + +.. code-block:: yaml + + identifier: ext-form-simple-contact-form-example + label: 'Simple Contact Form' + prototype: standard + type: Form + + finishers: + - + identifier: EmailToReceiver + options: + subject: 'Your message' + recipientAddress: 'your.company@example.com' + recipientName: 'Your company name' + senderAddress: '{email}' + senderName: '{name}' + + renderables: + - + identifier: page-1 + label: 'Contact Form' + type: Page + + renderables: + - + identifier: name + label: 'Name' + type: Text + properties: + fluidAdditionalAttributes: + placeholder: 'Name' + defaultValue: '' + validators: + - + identifier: NotEmpty + - + identifier: subject + label: 'Subject' + type: Text + properties: + fluidAdditionalAttributes: + placeholder: 'Subject' + defaultValue: '' + validators: + - + identifier: NotEmpty + - + identifier: email + label: 'Email' + type: Text + properties: + fluidAdditionalAttributes: + placeholder: 'Email address' + defaultValue: '' + validators: + - + identifier: NotEmpty + - + identifier: EmailAddress + - + identifier: message + label: 'Message' + type: Textarea + properties: + fluidAdditionalAttributes: + placeholder: '' + defaultValue: '' + validators: + - + identifier: NotEmpty + + - + identifier: summarypage + label: 'Summary page' + type: SummaryPage \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/Concepts/FormEditor/Index.rst b/typo3/sysext/form/Documentation/Concepts/FormEditor/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..a7c07ae194715206ee75ad966ed858a6d5e16b88 --- /dev/null +++ b/typo3/sysext/form/Documentation/Concepts/FormEditor/Index.rst @@ -0,0 +1,541 @@ +.. include:: ../../Includes.txt + + +.. _concepts-formeditor: + +Form editor +=========== + + +.. _concepts-formeditor-general: + +What does it do? +---------------- + +The ``form editor`` is a powerful graphical user interface which allows the +backend editor to create ``form definitions`` without writing a single line +of code. Those ``form definitions`` will be used by the frontend process to +render beautiful forms. + +The ``form editor`` is a modular interface which consists of several +components: + +- Stage: central visual component of the ``form editor`` which displays the + form elements in an abstract view and a frontend preview +- Tree: displays the structure of the form as a tree +- Inspector: context specific toolbar which handles the visual display of + form element options and allows editing those +- Core: includes core functionalities of the ``form editor`` +- ViewModel: defines and steers the visual display +- Mediator: delegates events of the components +- Modals: processes modals +- FormEditor: provides API functions +- Helper: helper functions which mainly allow the manipulation of DOM + elements + +Generally speaking, the ``Modals``, ``Inspector``, and ``Stage`` components +can be adapted through configuration. Especially the ``Inspector`` component +is modular and extremely flexible. As an integrator, you can reuse so-called +``inspector editors``. Those elements are input fields of different types +which allow the backend editor to alter all of the available form element +options. + +.. figure:: ../../Images/javascript_module_interaction.png + :alt: JavaScript module interaction + + JavaScript module interaction + +There is a general ``form editor`` configuration which can be found below +the following configuration path: + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + formEditor: + +Furthermore, you are able to configure the ``form editor`` regarding its +different aspects. The configuration can be found below the following +configuration paths: + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + formElementsDefinition: + <formElementTypeIdentifier>: + formEditor: + finishersDefinition: + <finisherIdentifier> + formEditor: + validatorsDefinition: + <validatorIdentifier> + formEditor: + + +.. _concepts-formeditor-stage: + +Stage +----- + +The ``Stage`` is the central visual component of the form editor which +displays the form elements in two different modes: + +- abstract view: all form elements of a ``Page`` are presented in an + abstract way, +- frontend preview: renders the form like it will (nearly) be displayed in + the frontend ('nearly' since you have to make sure that your frontend CSS + is also loaded in the backend in order to get the exact preview). + +Per default, the frontend templates of EXT:form are based on Twitter +Bootstrap. Since the backend of TYPO3 CMS also depends on this CSS framework, +the corresponding CSS files are already loaded in the backend context. +Nevertheless, certain parts of the CSS were overridden and extended in order +to meet the specific needs of the TYPO3 backend. Thus, the frontend preview +in the backend could differ compared to the "real" frontend. + +If your frontend preview requires loading additional CSS or a CSS framework +then go ahead and configure a specific ``prototype`` accordingly. + +Beside the frontend templates, there are also templates for the abstract +view, i.e. you can customize the rendering of the abstract view for each +form element. If you have created your own form elements, in most cases you +will fall back to the already existing Fluid templates. But rembember, you +are always able to create you own Fluid templated and adapt the abstract view +till it suits your needs. + +For more information, read the following chapter: ':ref:`Common abstract view form element templates<apireference-formeditor-stage-commonabstractformelementtemplates>`'. + + +.. _concepts-formeditor-inspector: + +Inspector +--------- + +The ``Inspector`` component is situated on the right side of the ``form +editor``. It is a modular, extremely flexible, and context specific toolbar +which depends on the chosen form element. The ``Inspector`` allows editing +the form element's options with the help of so-called ``inspector editors``. +For the most parts, the interface can be easily customized by writing +YAML configuration. For each form element you can define which properties +are available and in which way they can be edited. + +In addition to the editable form element properties (like ``properties.placeholder``) +there are so-called ``property collections`` which can be written by the +``form editor`` as well. Their definition is stored on the hierarchical +level of a form element. Right now, there are the following ``property +collections``: + +- validators +- finishers + +``Property collections`` also make use of ``inspector editors`` in order to +configure them properly. Due to this, we can do a lot of cool stuff. Imagine +we have got a validator "Number range" with two validator options called +"Minimum" and "Maximum". Additionally, we have got two form elements "Age +spouse" and "Age infant". For both form elements the validator is available +but for the form element "Age child" the validator option "Minimum" is not +editable and the option "Maximum" is pre-filled with a certain value. + + +.. _concepts-formeditor-basicjavascriptconcepts: + +Basic JavaScript concepts +------------------------- + +The form framework was designed to be as extendible as possible. Sooner or +later, you want to customize the components of the ``form editor`` using +JavaScript. This is especially true if you want to create your own +``inspector editors``. In order to achieve this, you can implement your own +JavaScript modules. Those modules will include the required algorithms for +the ``inspector editors`` and the ``abstract view`` as well as your own +event listing. + + +.. _concepts-formeditor-basicjavascriptconcepts-registercustomjavascriptmodules: + +Register custom JavaScript modules +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following YAML configuration registers an additional JavaScript module. + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + formEditor: + dynamicRequireJsModules: + additionalViewModelModules: + - 'TYPO3/CMS/MySitePackage/Backend/FormEditor/ViewModel' + +According to the example shown above, the JavaScript files have to be stored +within the folder ``my_site_package/Resources/Public/JavaScript/Backend/FormEditor/ViewModel.js``. +In the TYPO3 backend JavaScript files are loaded via RequireJS which depends +on a certain convention. The name of the module starts with **TYPO3/CMS**/MySitePackage/Backend/FormEditor/ViewModel +followed by your extension key TYPO3/CMS/**MySitePackage**/Backend/FormEditor/ViewModel. +Thus, you have to ensure that the module is stored within a subfolder of ``my_site_package/Resources/Public/JavaScript/``. +The part TYPO3/CMS/MySitePackage/**Backend/FormEditor**/ViewModel tells you +that your files have to be stored in my_site_package/Resources/Public/JavaScript/**Backend/FormEditor**/. +The last section TYPO3/CMS/MySitePackage/Backend/FormEditor/**ViewModel** +states the name of the JavaScript file without the file extension (.js). + +Check out the following base template which shows you the recommended way +for setting up your own module. + +.. code-block:: javascript + + /** + * Module: TYPO3/CMS/MySitePackage/Backend/FormEditor/ViewModel + */ + define(['jquery', + 'TYPO3/CMS/Form/Backend/FormEditor/Helper' + ], function($, Helper) { + 'use strict'; + + return (function($, Helper) { + + /** + * @private + * + * @var object + */ + var _formEditorApp = null; + + /** + * @private + * + * @return object + */ + function getFormEditorApp() { + return _formEditorApp; + }; + + /** + * @private + * + * @return object + */ + function getPublisherSubscriber() { + return getFormEditorApp().getPublisherSubscriber(); + }; + + /** + * @private + * + * @return object + */ + function getUtility() { + return getFormEditorApp().getUtility(); + }; + + /** + * @private + * + * @param object + * @return object + */ + function getHelper() { + return Helper; + }; + + /** + * @private + * + * @return object + */ + function getCurrentlySelectedFormElement() { + return getFormEditorApp().getCurrentlySelectedFormElement(); + }; + + /** + * @private + * + * @param mixed test + * @param string message + * @param int messageCode + * @return void + */ + function assert(test, message, messageCode) { + return getFormEditorApp().assert(test, message, messageCode); + }; + + /** + * @private + * + * @return void + * @throws 1491643380 + */ + function _helperSetup() { + assert('function' === $.type(Helper.bootstrap), + 'The view model helper does not implement the method "bootstrap"', + 1491643380 + ); + Helper.bootstrap(getFormEditorApp()); + }; + + /** + * @private + * + * @return void + */ + function _subscribeEvents() { + getPublisherSubscriber().subscribe('some/eventName/you/want/to/handle', function(topic, args) { + myCustomCode(); + }); + }; + + /** + * @private + * + * @return void + */ + function myCustomCode() { + }; + + /** + * @public + * + * @param object formEditorApp + * @return void + */ + function bootstrap(formEditorApp) { + _formEditorApp = formEditorApp; + _helperSetup(); + _subscribeEvents(); + }; + + /** + * Publish the public methods. + * Implements the "Revealing Module Pattern". + */ + return { + bootstrap: bootstrap + }; + })($, Helper); + }); + + +.. _concepts-formeditor-basicjavascriptconcepts-events: + +Events +^^^^^^ + +The event handling of EXT:form is based on the ``Publish/Subscribe Pattern``. +To learn more about this terrific pattern, check out this website: https://addyosmani.com/resources/essentialjsdesignpatterns/book/. +Please not that the processing sequence of the subscribers cannot be +influenced. Furthermore, there is no information flow between the +subscribers. All events have to be arranged asynchronously. + +For more information, head to the API reference and read the section about +':ref:`Events<concepts-formeditor-basicjavascriptconcepts-events>`'. + + +.. _concepts-formeditor-basicjavascriptconcepts-formelementmodel: + +FormElement model +^^^^^^^^^^^^^^^^^ + +Within the JavaScript code, each form element is represented by a +`FormElement model``. This model can be seen as a copy of the ``form +definition'' enriched by some additional data. The following example shows +you a ``form definition`` and the debug output of the corresponding +``FormElement model``. + +.. code-block:: yaml + + identifier: javascript-form-element-model + label: 'JavaScript FormElement model' + type: Form + finishers: + - + identifier: EmailToReceiver + options: + subject: 'Your message: {subject}' + recipientAddress: your.company@example.com + recipientName: 'Your Company name' + senderAddress: '{email}' + senderName: '{name}' + replyToAddress: '' + carbonCopyAddress: '' + blindCarbonCopyAddress: '' + format: html + attachUploads: 'true' + translation: + language: '' + renderables: + - + identifier: page-1 + label: 'Contact Form' + type: Page + renderables: + - + identifier: name + label: Name + type: Text + properties: + fluidAdditionalAttributes: + placeholder: Name + defaultValue: '' + validators: + - + identifier: NotEmpty + + +.. code-block:: javascript + + { + "identifier": "javascript-form-element-model", + "label": "JavaScript FormElement model", + "type": "Form", + "prototypeName": "standard", + "__parentRenderable": null, + "__identifierPath": "example-form", + "finishers": [ + { + "identifier": "EmailToReceiver", + "options": { + "subject": "Your message: {subject}", + "recipientAddress": "your.company@example.com", + "recipientName": "Your Company name", + "senderAddress": "{email}", + "senderName": "{name}", + "replyToAddress": "", + "carbonCopyAddress": "", + "blindCarbonCopyAddress": "", + "format": "html", + "attachUploads": true, + "translation": { + "language": "" + } + } + } + ], + "renderables": [ + { + "identifier": "page-1", + "label": "Contact Form", + "type": "Page", + "__parentRenderable": "example-form (filtered)", + "__identifierPath": "example-form/page-1", + "renderables": [ + { + "identifier": "name", + "defaultValue": "", + "label": "Name", + "type": "Text", + "properties": { + "fluidAdditionalAttributes": { + "placeholder": "Name" + } + }, + "__parentRenderable": "example-form/page-1 (filtered)", + "__identifierPath": "example-form/page-1/name", + "validators": [ + { + "identifier": "NotEmpty" + } + ] + } + ] + } + ] + } + +For each form element which has child elements, you will find a property +called ``renderables``. Those ``renderables`` are arrays whose elements +consists of ``FormElement models`` of the particular child elements. + +As previously mentioned, the ``FormElement model`` is a conglomerate of the +data of the ``form definition`` and some additional information: + +- __parentRenderable +- __identifierPath + +The following methods can be utilized in order to access the data of a +``FormElement model``: + +- get() +- set() +- unset() +- on() +- off() +- getObjectData() +- toString() +- clone() + +For more information, head to the API reference and read the section about +the ':ref:`FormElement model<apireference-formeditor-basicjavascriptconcepts-formelementmodel>`'. + + +.. _concepts-formeditor-translation-formeditor: + +Translation of form editor +-------------------------- + +All option values which reside below the following configuration keys can be +translated: + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + formEditor: + formElementsDefinition: + <formElementTypeIdentifier>: + formEditor: + finishersDefinition: + <finisherIdentifier> + formEditor: + validatorsDefinition: + <validatorIdentifier> + formEditor: + +The translation files of the ``form editor`` are loaded as follows: + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + formEditor: + translationFile: + # translation files for the form editor + 10: 'EXT:form/Resources/Private/Language/Database.xlf' + 20: 'EXT:my_site_package/Resources/Private/Language/Database.xlf' + +The process searches for each option value within all of the defined +translation files. If a translation is found, the translated option value +will be used in preference. + +Imagine, the following is defined for an option value: + +.. code-block:: yaml + + ... + label: 'formEditor.elements.Form.editor.finishers.label' + ... + +First of all, the process searches for the translation key ``formEditor.elements.Form.editor.finishers.label`` +within the file ``20: 'EXT:my_site_package/Resources/Private/Language/Database.xlf'`` +and after it inside the file ``10: 'EXT:form/Resources/Private/Language/Database.xlf'``. +If nothing is found, the option value will be displayed unmodified. + +Due to compatibility issues, the setting ``translationFile`` is not defined +as an array in the default configuration. To load your own translation files, +you should define an array containing 'EXT:form/Resources/Private/Language/Database.xlf' +as first entry (key ``10``) followed by your own file (key ``20``) as +displayed in the example above. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/Concepts/FormFileStorages/Index.rst b/typo3/sysext/form/Documentation/Concepts/FormFileStorages/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..427d813d3cd6d665e9fdc5e9f1e71b4f2ae37c93 --- /dev/null +++ b/typo3/sysext/form/Documentation/Concepts/FormFileStorages/Index.rst @@ -0,0 +1,135 @@ +.. include:: ../../Includes.txt + + +.. _concepts-form-file-storages: + +Form/ File storages +=================== + +EXT:form stores the form definitions within the file system and thus needs +write access to this storage. By default, the filemount ``user_uploads`` is +used. It is possible to configure a different and/ or an additional +filemount, which is then utilized for storing and reading forms. + +The backend user will only see form definitions that are stored in +filemounts where the user has at least read access. The ``form editor`` and +the ``form plugin`` respect those access rights. In this way, you are able +to implement ACLs. If you have configure more than one filemount and the +backend user is able to access those, the ``form manager`` will allow the +user to choose the preferred storage in which the form will be saved. + +Even cooler, form definitions can be stored in and shipped with your custom +extensions. If configured accordingly, the backend user will be able to +embed those forms. Furthermore, you can configure that these form +definitions: + +- can be edited within the ``form editor``, +- can be deleted with the help of the ``form manager``. + +By default, the aforementioned options are turned off. We decided to do so +because having dynamic content within an extension - which is possibly +version-controlled - is usually not a good idea. Furthermore, there is no +ACL system available. + +**File uploads** will be saved within filemounts as well. They are handled +as FAL objects. The available filemounts for such uploads can be configured. +When adding/ editing a file upload element, the backend user can select the +desired upload storage. + +.. note:: + In principle, files in filemounts are publicly accessible. If the + uploaded files could contain sensitive data, you should suppress any + HTTP access to the filemount. This may, for example, be achieved by + creating a .htaccess file, assuming you are using an Apache web server. + The directive of the .htaccess file is fairly easy: + + .. code-block:: html + + Order deny,allow + Deny from all + +The following code block shows you how to configure additional filemounts +for form definitions. + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + persistenceManager: + allowedFileMounts: + # default filemount, no need to redeclare it again + # just to show you the structure + # 10: 1:/user_upload/ + # additional filemounts + 100: 1:/custom/forms/ + 110: 2:/cloudstorage/forms/ + +The following code block shows you how to allow an extension path as an +additional filemount for form definitions. + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + persistenceManager: + allowedExtensionPaths: + 10: EXT:my_site_package/Resources/Private/Forms/ + +Add the following config if you want to allow backend users to **edit** +forms stored within your own extension. + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + persistenceManager: + allowSaveToExtensionPaths: true + + +Add the following config if you want to allow backend users to **delete** +forms stored within your own extension. + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + persistenceManager: + allowDeleteFromExtensionPaths: true + +The following code blocks show you the default setup for filemounts that +are used for file (and image) uploads. + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + formElementsDefinition: + FileUpload: + formEditor: + predefinedDefaults: + properties: + saveToFileMount: '1:/user_upload/' + editors: + 400: + selectOptions: + 10: + value: '1:/user_upload/' + label: '1:/user_upload/' + properties: + saveToFileMount: '1:/user_upload/' + ImageUpload + properties: + saveToFileMount: '1:/user_upload/' + editors: + 400: + selectOptions: + 10: + value: '1:/user_upload/' + label: '1:/user_upload/' \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/Concepts/FormManager/Index.rst b/typo3/sysext/form/Documentation/Concepts/FormManager/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..04033a62b25a3bbadbbb84191e90a6f66ca69cfa --- /dev/null +++ b/typo3/sysext/form/Documentation/Concepts/FormManager/Index.rst @@ -0,0 +1,145 @@ +.. include:: ../../Includes.txt + + +.. _concepts-formmanager: + +Form manager +============ + + +.. _concepts-formmanager-general: + +What does it do? +---------------- + +The ``form manager`` can be accessed by opening the backend module 'Forms'. +It allows the editor to administer all of the existing forms stored on the +accessible filemounts. The central element of the ``form manager`` is a +table view which... + +- lists all forms +- allows users to create, edit, duplicate, and delete forms +- names the storage folder +- gives a broad overview on which pages the listed forms are used in. + +The creation and duplication of forms is supported by a so-called ``form +wizard``. The wizard guides the editor through the process and offers a +variety of settings depending on the form configuration. Those settings +include choosing filemounts, prototypes, and start templates. + +.. figure:: ../../Images/form_manager.png + :alt: The form manager + + TYPO3 Backend with opened module 'Forms' displaying the form manager. + + +.. _concepts-formmanager-starttemplate: + +Start templates +--------------- + +This is a very nifty feature. When creating a new form, the ``form manager`` +allows the backend editor to select a so-called ``Start template``. Such a +template is a predefined ``form definition`` without the property +``prototypeName`` which is normally used as a foundation of a new form. + +As an integrator, you can specify as many ``Start templates`` as you desire +for a given ``prototype``. After you have defined such a template, follow +these easy steps to use your defined ``Start templates`` as a foundation: + +- open the ``Forms`` module +- create a new form by clicking on the appropriate button +- enter the 'Form name' and click the checkbox 'Advanced settings' +- during the next steps you can select a ``Start template`` + +For each ``prototype``, you have to define a ``Start template`` in order to +enable the editor to choose one. Additionally, the same ``Start template`` +can be used for several ``prototypes``. To do so, make sure the included +form elements of the template are defined in the corresponding ``prototype``. + +For example, imagine your integrator has :ref:`configured<typo3.cms.form.formmanager.selectablePrototypesConfiguration>` +a prototype called 'routing' which contains a custom form element with the +``<formElementTypeIdentifier>`` 'locationPicker'. The element is only +defined for this prototype. The integrator has created a ``Start template`` +which carries the 'locationPicker' form element. A backend editor could now +select and use this ``Start template``, including the custom form element, +as long as the ``prototype`` is set to 'routing'. If the integrator also +adds this custom form element to another ``prototype``, the process would +crash. The custom form element is only known by the ``prototype`` 'routing'. + +The following code block shows the minimal configuration of a ``Start +template``. You need at least the root form element ('Form') and a 'Page'. + +.. code-block:: yaml + + type: 'Form' + identifier: 'blankForm' + label: '[Blank Form]' + renderables: + - + type: 'Page' + identifier: 'page-1' + label: 'Page' + +As mentioned previously, the form wizard within the ``form manager`` offers +a list of all existing, :ref:`pre-configured<typo3.cms.form.formmanager.selectableprototypesconfiguration.*.newformtemplates>` +``Start templates``. As soon as the backend editor creates a form with the +help of such a template, a new ``form definition`` is generated based on the +one of the selected ``Start template``. The ``form definition`` will be +enriched by the property ``propertyName`` defining the chosen ``prototype``. +The ``identifier`` of the root form element ('Form') is automatically set +based on the entered "Form name". Additionally, this name is used for the +property `` label`` of the 'Form' element. Finally, the ``form editor`` is +loaded and displays the newly created form. + + +.. _concepts-formmanager-translation-starttemplate: + +Translation of the form manager +------------------------------- + +All option values which reside below the following configuration keys can be +translated: + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + formManager: + +The translation files of the ``form manager`` are loaded as follows: + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + formManager: + translationFile: + # translation files for the form manager + 10: 'EXT:form/Resources/Private/Language/Database.xlf' + 20: 'EXT:my_site_package/Resources/Private/Language/Database.xlf' + +The process searches for each option value within all of the defined +translation files. If a translation is found, the translated option value +will be used in preference. + +Imagine, the following is defined for an option value: + +.. code-block:: yaml + + ... + label: 'formManager.selectablePrototypesConfiguration.standard.label' + ... + +First of all, the process searches for the translation key ``formManager.selectablePrototypesConfiguration.standard.label`` +within the file ``20: 'EXT:my_site_package/Resources/Private/Language/Database.xlf'`` +and after it inside the file ``10: 'EXT:form/Resources/Private/Language/Database.xlf'``. +If nothing is found, the option value will be displayed unmodified. + +Due to compatibility issues, the setting ``translationFile`` is not defined +as an array in the default configuration. To load your own translation files, +you should define an array containing 'EXT:form/Resources/Private/Language/Database.xlf' +as first entry (key ``10``) followed by your own file (key ``20``) as +displayed in the example above. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/Concepts/FormPlugin/Index.rst b/typo3/sysext/form/Documentation/Concepts/FormPlugin/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..050d2f086c8a3eb12fa25c6be0d48a713487dfb9 --- /dev/null +++ b/typo3/sysext/form/Documentation/Concepts/FormPlugin/Index.rst @@ -0,0 +1,87 @@ +.. include:: ../../Includes.txt + + +.. _concepts-formplugin: + +Form plugin +=========== + + +.. _concepts-formelugin-general: + +What does it do? +---------------- + +The form plugin allows you to assign a form - created with the ``form +editor`` or shipped with your extension - to a specific page. This enables +you to re-use forms throughout the whole TYPO3 installation. Furthermore, it +offers the backend editor the possibility to override certain aspects of the +form definition. At the moment, only finisher options can be overridden. The +possibilities depend on the configuration of the underlying prototype. + +Imagine, your form contains a redirect finisher. The redirect target is set +globally and valid for the whole ``form definition`` . While adding the form +to a specific page, the backend editor can define a different redirect targeting. This +setting is only valid for the page containing the plugin. + +Read more about changing the :ref:`general<typo3.cms.form.prototypes.\<prototypeidentifier>.formengine>` +and :ref:`aspect-specific form plugin configuration<typo3.cms.form.prototypes.\<prototypeIdentifier>.finishersdefinition.\<finisheridentifier>.formengine>`. + + +.. _concepts-formplugin-translation-formengine: + +Translation of form plugin +-------------------------- + +All option values which reside below the following configuration keys can be +translated: + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + finishersDefinition: + <finisherIdentifier> + formEngine: + +The translation files of the ``form plugin`` are loaded as follows: + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + formEngine: + translationFile: + # translation files for the form plugin (finisher overrides) + 10: 'EXT:form/Resources/Private/Language/Database.xlf' + 20: 'EXT:my_site_package/Resources/Private/Language/Database.xlf' + +The process searches for each option value within all of the defined +translation files. If a translation is found, the translated option value +will be used in preference. + +Imagine, the following is defined for an option value: + +.. code-block:: yaml + + ... + label: 'tt_content.finishersDefinition.EmailToReceiver.label' + ... + +First of all, the process searches for the translation key +``tt_content.finishersDefinition.EmailToReceiver.label`` within the file +20: 'EXT:my_site_package/Resources/Private/Language/Database.xlf' and after +it inside the file 10: 'EXT:form/Resources/Private/Language/Database.xlf'. +If nothing is found, the option value will be displayed unmodified. + +Due to compatibility issues, the setting ``translationFile`` is not defined +as an array in the default configuration. To load your own translation files, +you should define an array containing 'EXT:form/Resources/Private/Language/Database.xlf' +as first entry (key ``10``) followed by your own file (key ``20``) as +displayed in the example above. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/Concepts/FrontendRendering/Index.rst b/typo3/sysext/form/Documentation/Concepts/FrontendRendering/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..3ed635ffc946d6c9757e718332e3774063f48367 --- /dev/null +++ b/typo3/sysext/form/Documentation/Concepts/FrontendRendering/Index.rst @@ -0,0 +1,1104 @@ +.. include:: ../../Includes.txt + + +.. _concepts-frontendrendering: + +Frontend rendering +================== + + +.. _concepts-frontendrendering-basiccodecomponents: + +Basic code components +--------------------- + + +.. figure:: ../../Images/basic_code_components.png + :alt: Basic code components + + Basic code components + + +.. _concepts-frontendrendering-basiccodecomponents-formdefinition: + +TYPO3\\CMS\\Form\\Domain\\Model\\FormDefinition +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The class ``TYPO3\\CMS\\Form\\Domain\\Model\\FormDefinition`` encapsulates +a complete ``form definition``, with all of its + +- pages, +- form elements, +- applicable validation rules, and +- finishers, which should be executed when the form is submitted. + +The FormDefinition domain model is not modified when the form is executed. + + +.. _concepts-frontendrendering-basiccodecomponents-formdefinition-anatomy: + +The anatomy of a form ++++++++++++++++++++++ + +A ``FormDefinition`` domain model consists of multiple ``Page`` objects. +When a form is displayed, only one ``Page`` is visible at any given time. +Moreover, there is a navigation to go back and forth between those pages. A +``Page`` consists of multiple ``FormElements`` which represent the input +fields, textareas, checkboxes, etc. shown on a page. The ``FormDefinition`` +domain model, ``Page`` and ``FormElement`` objects have ``identifier`` +properties which must be unique for each given ``<formElementTypeIdentifier>``, +i.e. the ``FormDefinition`` domain model and a ``FormElement`` object may +have the same ``identifier`` but having the same identifier for two +``FormElement`` objects is disallowed. + + +.. _concepts-frontendrendering-basiccodecomponents-formdefinition-anatomy-example: + +Example +''''''' + +Basically, you can manually create a ``FormDefinition`` domain model just +by calling the API methods on it, or you can use a ``FormFactory`` to build +the form from a different representation format such as YAML. + +.. code-block:: php + + $formDefinition = $this->objectManager->get(FormDefinition::class, 'myForm'); + + $page1 = $this->objectManager->get(Page::class, 'page1'); + $formDefinition->addPage($page); + + // second argument is the <formElementTypeIdentifier> of the form element + $element1 = $this->objectManager->get(GenericFormElement::class, 'title', 'Text'); + $page1->addElement($element1); + + +.. _concepts-frontendrendering-basiccodecomponents-formdefinition-createformusingabstracttypes: + +Creating a form using abstract form element types ++++++++++++++++++++++++++++++++++++++++++++++++++ + +While you can use the ``TYPO3\CMS\Form\Domain\Model\FormDefinition::addPage()`` +or ``TYPO3\CMS\Form\Domain\Model\FormElements\Page::addElement()`` methods +and create the ``Page`` and ``FormElement`` objects manually, it is often +better to use the corresponding create* methods (``TYPO3\CMS\Form\Domain\Model\FormDefinition::createPage()`` +and ``TYPO3\CMS\Form\Domain\Model\FormElements\Page::createElement()``), as +you pass them an abstract ``<formElementTypeIdentifier>`` such as ``Text`` +or ``Page``. EXT:form will automatically resolve the implementation class +name and set default values. + +The :ref:`simple example <concepts-frontendrendering-basiccodecomponents-formdefinition-anatomy-example>` +shown above should be rewritten as follows: + +.. code-block:: php + + // we will come back to this later on + $prototypeConfiguration = []; + + $formDefinition = $this->objectManager->get(FormDefinition::class, 'myForm', $prototypeConfiguration); + $page1 = $formDefinition->createPage('page1'); + $element1 = $page1->addElement('title', 'Text'); + +You might wonder how the system knows that the element ``Text`` is +implemented by using a ``GenericFormElement``. This is configured in the +``$prototypeConfiguration``. To make the example from above actually work, +we need to add some meaningful values to ``$prototypeConfiguration``: + +.. code-block:: php + + $prototypeConfiguration = [ + 'formElementsDefinition' => [ + 'Page' => [ + 'implementationClassName' => 'TYPO3\CMS\Form\Domain\Model\FormElements\Page' + ], + 'Text' => [ + 'implementationClassName' => 'TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement' + ], + ], + ]; + +For each abstract ``<formElementTypeIdentifier>`` we have to add some +configuration. In the snippet above, we only define the ``implementation +class name``. Apart form that, it is always possible to set default values +for all configuration options of such elements, as the following example +shows: + +.. code-block:: php + + $prototypeConfiguration = [ + 'formElementsDefinition' => [ + 'Page' => [ + 'implementationClassName' => 'TYPO3\CMS\Form\Domain\Model\FormElements\Page', + 'label' => 'This is the label of the page if nothing else is specified' + ], + 'Text' => [ + 'implementationClassName' => 'TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement', + 'label' = >'Default Label', + 'defaultValue' => 'Default form element value', + 'properties' => [ + 'placeholder' => 'Text that is shown if element is empty' + ], + ], + ], + ]; + + +.. _concepts-frontendrendering-basiccodecomponents-formdefinition-preconfiguredconfiguration: + +Using pre-configured $prototypeConfiguration +++++++++++++++++++++++++++++++++++++++++++++ + +Often, it does not make sense to manually create the $prototypeConfiguration +array. Bigger parts of this array are pre-configured in the extensions's +YAML settings. The ``TYPO3\CMS\Form\Domain\Configuration\ConfigurationService`` +contains helper methods which return the ready-to-use ``$prototypeConfiguration``. + + +.. _concepts-frontendrendering-basiccodecomponents-formdefinition-rednering: + +Rendering a FormDefinition +++++++++++++++++++++++++++ + +To trigger the rendering of a ``FormDefinition`` domain model, the current +``TYPO3\CMS\Extbase\Mvc\Web\Request`` needs to be bound to the +``FormDefinition``. This binding results in a ``TYPO3\CMS\Form\Domain\Runtime\FormRuntime`` +object which contains the ``Runtime State`` of the form. Among other things, +this object includes the currently inserted values. + +.. code-block:: php + + // $currentRequest and $currentResponse need to be available + // inside a controller, you would use $this->request and $this->response; + $form = $formDefinition->bind($currentRequest, $currentResponse); + // now, you can use the $form object to get information about the currently entered values, etc. + + +.. _concepts-frontendrendering-basiccodecomponents-formruntime: + +TYPO3\\CMS\\Form\\Domain\\Runtime\\FormRuntime +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This class implements the runtime logic of a form, i.e. the class + +- decides which page is currently shown, +- determines the current values of the form +- triggers validation and property mappings. + +You generally receive an instance of this class by calling ``TYPO3\CMS\Form\Domain\Model\FormDefinition::bind()``. + + +.. _concepts-frontendrendering-basiccodecomponents-formruntime-render: + +Rendering a form +++++++++++++++++ + +Rendering a form is easy. Just call ``render()`` on the ``FormRuntime``. + +.. code-block:: php + + $form = $formDefinition->bind($request, $response); + $renderedForm = $form->render(); + + +.. _concepts-frontendrendering-basiccodecomponents-formruntime-accessingformvalues: + +Accessing form values ++++++++++++++++++++++ + +In order to get the values the user has entered into the form, you can +access the ``FormRuntime`` object like an array. If a form element with the +identifier ``firstName`` exists, you can use ``$form['firstName']`` to +retrieve its current value. You can set values the same way. + + +.. _concepts-frontendrendering-basiccodecomponents-formruntime-renderinginternals: + +Rendering internals ++++++++++++++++++++ + +The ``FormRuntime`` inquires the ``FormDefinition`` domain model regarding +the configured renderer (``TYPO3\CMS\Form\Domain\Model\FormDefinition::getRendererClassName()``) +and then triggers render() on this Renderer. + +This allows you to declaratively define how a form should be rendered. + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + formElementsDefinition: + Form: + rendererClassName: 'TYPO3\CMS\Form\Domain\Renderer\FluidFormRenderer' + + +.. _concepts-frontendrendering-basiccodecomponents-fluidformrenderer: + +TYPO3\\CMS\\Form\\Domain\\Renderer\\FluidFormRenderer +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This class is a ``TYPO3\CMS\Form\Domain\Renderer\RendererInterface`` +implementation which used to render a ``FormDefinition`` domain model. It +is the default EXT:form renderer. + +Learn more about the :ref:`FluidFormRenderer Options<apireference-frontendrendering-fluidformrenderer-options>`. + + +.. _concepts-frontendrendering-codecomponents-customformelementimplementations: + +Custom form element implementations +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +EXT:form ships a decent amount of hooks which are available at crucial +points of the life cycle of a ``FormElement``. Most of the time, own +implementations are therefore unnecessary. An own form element can be +defined by: + +- writing some configuration, and +- utilizing the standard implementation of ``TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement``. + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + formElementsDefinition: + CustomFormElementIdentifier: + implementationClassName: 'TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement' + +With the provided hooks, this ``FormElement`` can now be manipulated. + +If you insist on your own implementation, the abstract class ``TYPO3\CMS\Form\Domain\Model\FormElements\AbstractFormElement`` +offers a perfect entry point. In addition, we recommend checking-out ``TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable``. +All of your own form element implementations must be programmed to the +interface ``TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface``. +It is a good idea to derive your implementation from ``TYPO3\CMS\Form\Domain\Model\FormElements\AbstractFormElement``. + + +.. _concepts-frontendrendering-codecomponents-customfinisherimplementations: + +Custom finisher implementations +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Finishers are defined as part of a ``prototype`` within a +``finishersDefinition``. The property ``implementationClassName`` is to be +utilized to load the finisher implementation. + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + finishersDefinition: + CustomFinisher: + implementationClassName: 'VENDOR\MySitePackage\Domain\Finishers\CustomFinisher' + +If the finisher requires options, you can define those within the +``options`` property. The options will be used as default values and can +be overridden using the ``form definition``. + +Define the default value: + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + finishersDefinition: + CustomFinisher: + implementationClassName: 'VENDOR\MySitePackage\Domain\Finishers\CustomFinisher' + options: + yourCustomOption: 'Ralf' + +Override the option using the ``form definition``: + +.. code-block:: yaml + + identifier: sample-form + label: 'Simple Contact Form' + prototype: standard + type: Form + + finishers: + - + identifier: Custom + options: + yourCustomOption: 'Björn' + + renderables: + ... + +Each finisher has to be programmed to the interface ``TYPO3\CMS\Form\Domain\Finishers\FinisherInterface`` +and should extend the class ``TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher``. +In doing so, the logic of the finisher should start with the method +``executeInternal()``. + + +.. _concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions: + +Accessing finisher options +++++++++++++++++++++++++++ + +If your finisher extends ``TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher``, +you can access your finisher options with the help of the ``parseOption()`` +method. + +.. code-block:: php + + $yourCustomOption = $this->parseOption('yourCustomOption'); + +``parseOption()`` is looking for 'yourCustomOption' in your +``form definition``. If it cannot be found, the method checks + +- 1. the ``prototype`` configuration for a default value, +- 2. the finisher class itself by searching for a default value within the + ``$defaultOptions`` property. + +.. code-block:: php + + <?php + declare(strict_types=1); + namespace VENDOR\MySitePackage\Domain\Finishers; + + class CustomFinisher extends \TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher + { + + protected $defaultOptions = [ + 'yourCustomOption' => 'Olli', + ]; + + ... + +If the option cannot be found by processing this fallback chain, ``null`` is +returned. + +If the option is found, the process checks whether the option value will +access :ref:`FormRuntime values<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>`. +If the ``FormRuntime`` returns a positive result, it is checked whether the +option value :ref:`can access values of preceding finishers<concepts-frontendrendering-codecomponents-customfinisherimplementations-finishercontext-sharedatabetweenfinishers>`. +At the very end, it tries to :ref:`translate the finisher options<concepts-frontendrendering-translation-finishers>`. + + +.. _concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor: + +Accessing form runtime values +''''''''''''''''''''''''''''' + +By utilizing a specific notation, finisher options can be populated with +submitted form values (assuming you are using the ``parseOption()`` method). +You can access values of the ``FormRuntime`` and thus values of each single +form element by encapsulating the option values with ``{}``. If there is a +form element with the ``identifier`` 'subject', you can access its value +within the the finisher configuration. Check out the following example to +get the whole idea. + +.. code-block:: yaml + + identifier: simple-contact-form + label: 'Simple Contact Form' + prototype: standard + type: Form + + finishers: + - + identifier: Custom + options: + yourCustomOption: '{subject}' + + renderables: + - + identifier: subject + label: 'Subject' + type: Text + + +.. code-block:: php + + // $yourCustomOption contains the value of the form element with the + // identifier 'subject' + $yourCustomOption = $this->parseOption('yourCustomOption'); + +In addition, you can use ``{__currentTimestamp}`` as a special option value. +It will return the current UNIX timestamp. + + +.. _concepts-frontendrendering-codecomponents-customfinisherimplementations-finishercontext: + +Finisher Context +++++++++++++++++ + +The class ``TYPO3\CMS\Form\Domain\Finishers\FinisherContext`` takes care of +transferring a finisher context to each finisher. Given the finisher is +derived from ``TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher`` the +finisher context will be available via + +.. code-block:: php + + $this->finisherContext + +The method ``cancel`` prevents the execution of successive finishers: + +.. code-block:: php + + $this->finisherContext->cancel(); + +The method ``getFormValues`` returns all of the submitted form values. + +``getFormValues``. + +.. code-block:: php + + $this->finisherContext->getFormValues(); + +The method ``getFormRuntime`` returns the ``FormRuntime``. + +.. code-block:: php + + $this->finisherContext->getFormRuntime(); + + +.. _concepts-frontendrendering-codecomponents-customfinisherimplementations-finishercontext-sharedatabetweenfinishers: + +Share data between finishers +'''''''''''''''''''''''''''' + +The method ``getFinisherVariableProvider`` returns an object (``TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider``) +which allows you to store data and transfer it to other finishers. The data +can be easily accessed programmatically or within your configuration. + +.. code-block:: php + + $this->finisherContext->getFinisherVariableProvider(); + +The data is stored within the ``FinisherVariableProvider`` and is addressed +by a user-defined 'finisher identifier' and a custom option value path. The +name of the 'finisher identifier' should consist of the name of the finisher +without the potential 'Finisher' appendix. If your finisher is derived from +the class ``TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher``, the name of +this construct is stored in the following variable: + +.. code-block:: php + + $this->shortFinisherIdentifier + +For example, if the name of your finisher class is 'CustomFinisher', the +mentioned variable will contain the value 'Custom'. + +There are a bunch of methods to access and manage the finisher data: + +- Add data: + + .. code-block:: php + + $this->finisherContext->getFinisherVariableProvider()->add( + $this->shortFinisherIdentifier, + 'unique.value.identifier', + $value + ); + +- Get data: + + .. code-block:: php + + $this->finisherContext->getFinisherVariableProvider()->get( + $this->shortFinisherIdentifier, + 'unique.value.identifier', + 'default value' + ); + +- Check the existence of data: + + .. code-block:: php + + $this->finisherContext->getFinisherVariableProvider()->exists( + $this->shortFinisherIdentifier, + 'unique.value.identifier' + ); + +- Delete data: + + .. code-block:: php + + $this->finisherContext->getFinisherVariableProvider()->remove( + $this->shortFinisherIdentifier, + 'unique.value.identifier' + ); + +In this way, each finisher can access data programmatically. Moreover, it is +possible to retrieve the data via configuration, provided that a finisher +stores the values within the ``FinisherVariableProvider``. + +Assuming that a finisher called 'Custom' sets data as follows: + +.. code-block:: php + + $this->finisherContext->getFinisherVariableProvider()->add( + $this->shortFinisherIdentifier, + 'unique.value.identifier', + 'Wouter' + ); + +... you are now able to access the value 'Wouter' via ``{Custom.unique.value.identifier}`` +in any other finisher. + +.. code-block:: yaml + + identifier: sample-form + label: 'Simple Contact Form' + prototype: standard + type: Form + + finishers: + - + identifier: Custom + options: + yourCustomOption: 'Frans' + + - + identifier: SomeOtherStuff + options: + someOtherCustomOption: '{Custom.unique.value.identifier}' + + +.. _concepts-frontendrendering-codecomponents-customvalidatorimplementations: + +Custom validator implementations +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Validators belong to a certain ``prototype`` and are defined within the +``validatorsDefinition``. The property ``implementationClassName`` is used +for the validator implementation. + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + validatorsDefinition: + Custom: + implementationClassName: 'VENDOR\MySitePackage\Domain\Validation\CustomValidator' + +You can provide options for your validator using the property ``options``. +Those will be used as default values which can be overridden within a +specific ``form definition``. + +Define the default value of the option ``yourCustomOption``: + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + validatorsDefinition: + Custom: + implementationClassName: 'VENDOR\MySitePackage\Domain\Validation\CustomValidator' + options: + yourCustomOption: 'Jurian' + +Override the default value within your ``form definition``: + +.. code-block:: yaml + + identifier: sample-form + label: 'Simple Contact Form' + prototype: standard + type: Form + + renderables: + - + identifier: subject + label: 'Name' + type: Text + validators: + - + identifier: Custom + options: + yourCustomOption: 'Mathias' + +EXT:form implements Extbase validators. That said, your own validators should +extend ``TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator``. + + +.. _concepts-frontendrendering-renderviewHelper: + +"render" viewHelper +------------------- + +The ``RenderViewHelper`` is the actual starting point for form rendering and +not the typical Extbase Controller as you may know it. + +For more technical insights read more about the viewHelper's :ref:`arguments<apireference-frontendrendering-renderviewHelper-arguments>`. + + +.. _concepts-frontendrendering-fluidtemplate: + +Render through FLUIDTEMPLATE (without controller) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: typoscript + + tt_content.custom_content_element = COA_INT + tt_content.custom_content_element { + 10 = < lib.stdheader + 20 = FLUIDTEMPLATE + 20 { + file = EXT:my_site_package/Resources/Private/Templates/CustomContentElement.html + settings { + persistenceIdentifier = EXT:my_site_package/Resources/Private/Forms/MyForm.yaml + } + extbase.pluginName = Form + extbase.controllerExtensionName = Formframework + extbase.controllerName = FormFrontend + extbase.controllerActionName = perform + } + } + +``my_site_package/Resources/Private/Templates/CustomContentElement.html``: + +.. code-block:: html + + <formvh:render persistenceIdentifier="{settings.persistenceIdentifier}" /> + + +.. _concepts-frontendrendering-extbase: + +Render within your own Extbase extension +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +It is straight forward. Use the ``RenderViewHelper`` like this and you are +done: + +.. code-block:: html + + <formvh:render persistenceIdentifier="EXT:my_site_package/Resources/Private/Forms/MyForm.yaml"/> + +Point the property ``controllerAction`` to the desired action name and +provide values for the other parameters displayed below (you might need +those). + +.. code-block:: yaml + + type: Form + identifier: 'example-form' + label: 'TYPO3 is cool' + prototypeName: standard + renderingOptions: + controllerAction: perform + addQueryString: false + argumentsToBeExcludedFromQueryString: [] + additionalParams: [] + + renderables: + ... + + +.. _concepts-frontendrendering-programmatically: + +Build forms programmatically +---------------------------- + +To learn more about this topic, head to the chapter ':ref:`Build forms programmatically<apireference-frontendrendering-programmatically>`' +which is part of the API reference section. + + +.. _concepts-frontendrendering-runtimemanipulation: + +Runtime manipulation +-------------------- + +.. _concepts-frontendrendering-runtimemanipulation-hooks: + +Hooks +^^^^^ + +EXT:form implements a decent amount of hooks that allow the manipulation of +your forms during runtime. In this way, it is possible to, for example, + +- ... prefill form elements with values from your database, +- ... skip a whole page based on the value of a certain form element, +- ... mark a form element as mandatory depending of the chosen value of another + form element. + +Please check out the ':ref:`API reference section<apireference-frontendrendering-runtimemanipulation-hooks>`' +for more details. + + +.. _concepts-frontendrendering-runtimemanipulation-typoscriptoverrides: + +TypoScript overrides +^^^^^^^^^^^^^^^^^^^^ + +Each and every ``form definition`` can be overridden via TypoScript if the +``FormFrontendController`` of EXT:form is used to render the form. Normally, +this is the case if the form has been added to the page using the form +plugin or when rendering the form via :ref:`FLUIDTEMPLATE <concepts-frontendrendering-fluidtemplate>`. + +The overriding of settings with TypoScript's help takes place after the :ref:`custom finisher settings<concepts-formplugin>` +of the form plugin have been loaded. In this way, you are able to manipulate +the ``form definition`` for a single page. In doing so, the altered +``form definition`` is passed to the ``RenderViewHelper`` which then +generates the form programmatically. At this point, you can still change the +form elements using the above-mentioned concept of :ref:`hooks<concepts-frontendrendering-runtimemanipulation-hooks>`. + +.. code-block:: typoscript + + plugin.tx_form { + settings { + formDefinitionOverrides { + <formDefinitionIdentifier> { + renderables { + 0 { + renderables { + 0 { + label = TEXT + label.value = Overridden label + } + } + } + } + } + } + } + } + + +.. _concepts-frontendrendering-templates: + +Templates +--------- + +The Fluid templates of the form framework are based on Twitter Bootstrap. + + +.. _concepts-frontendrendering-templates-customtemplates: + +Custom templates +^^^^^^^^^^^^^^^^ + +If you want to use custom Fluid templates for the frontend output of the +form elements, you cannot register an additional template path using +TypoScript. Instead, the registration of new template paths has to be done +via YAML. The settings are part of the ``prototypes`` configuration. + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + formElementsDefinition: + Form: + renderingOptions: + templateRootPaths: + 100: 'EXT:my_site_package/Resources/Private/Frontend/Templates/' + partialRootPaths: + 100: 'EXT:my_site_package/Resources/Private/Frontend/Partials/' + layoutRootPaths: + 100: 'EXT:my_site_package/Resources/Private/Frontend/Layouts/' + +For each ``form definition`` - which references the prototype ``standard`` - +the form framework will additionally look for Fluid templates within the +path 'EXT:my_site_package/Resources/Private/Frontend/[*]' as set above. +Apart from the 'Form' element, the process will search for templates within +the ``partialRootPaths`` folder. The name of the partial is derived from the +property ``formElementTypeIdentifier``. For example, the template of the +form element ``Text`` must be stored within the ``partialRootPaths`` folder +named ``Text.html``. In contrast, the template of the ``Form`` element must +reside within the ``templateRootPaths`` folder. According to the introduced +logic, the template name must be ``Form.html``. + + +.. _concepts-frontendrendering-translation: + +Translation +----------- + +.. _concepts-frontendrendering-translation-formdefinition: + +Translate form definition +^^^^^^^^^^^^^^^^^^^^^^^^^ + +The translation of ``form definitions`` works differently to the translation +of the backend aspects. Currently, there is no graphical user interface +supporting the translation process. + +If the backend editor needed to translate the ``form definition`` properties +in the same way the backend aspects are translated, he/ she would see long +and unwieldy translation keys while editing a form within the ``form editor``. +In order to avoid this, rather the element properties are translated than +their values. Thus, the form framework does not look for translation keys +within the translation file. Instead, the system searches for translations +of the form element properties independent of their property values. The +property values are ignored if the process finds a proper entry within the +translation file. As a result, the property values are overridden by the +translated value. + +This approach is a compromise between two scenarios: the exclusive usage of +the ``form editor`` and/ or the manual creation of ``form definitions`` +which can afterwards (theoretically) be edited with the ``form editor``. In +addition, the described compromise allows the editor to create forms in the +default language whose form element property values are displayed as +specified in the ``form editor``. Based on this, an integrator could provide +additional language files which automatically translate the specific form. + +Additional translation files can be defined as follows: + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + formElementsDefinition: + Form: + renderingOptions: + translation: + translationFile: + # translation files for the frontend + 10: 'EXT:form/Resources/Private/Language/locallang.xlf' + 20: 'EXT:my_site_package/Resources/Private/Language/locallang.xlf' + +Due to compatibility issues, the setting ``translationFile`` is not defined +as an array in the default configuration. To load your own translation files, +you should define an array containing 'EXT:form/Resources/Private/Language/locallang.xlf' +as first entry (key ``10``) followed by your own file (key ``20``) as +displayed in the example above. The array is processed from the highest key +to the lowest, i.e. your translation file with the key ``20`` is processed +first. If the look-up process does not find a key within all of the provided +files, the property value will be displayed unmodified. + +The following properties can be translated: + +- label +- properties.[*] +- properties.options.[*] +- properties.fluidAdditionalAttributes.[*] +- renderingOptions.[*] + +The translation keys are put together based on a specific pattern. In +addition, a fallback chain that depends on the form element identifiers +exists. As a result, the following translation scenarios are possible: + +- translation of a form element property for a specific form and form + element +- translation of a form element property for a specific form element and + various forms +- translation of a form element property for an element type and various + forms, e.g. the ``Page`` element + +The look-up process searches for translation keys in all given translation +files based on the following order: + +- ``<formDefinitionIdentifier>.element.<elementIdentifier>.properties.<propertyName>`` +- ``element.<formElementIdentifier>.properties.<propertyName>`` +- ``element.<elementType>.properties.<propertyName>`` + +Form elements with option properties (``properties.options``), like the +``Select`` element, feature the following look-up process: + +- ``<formDefinitionIdentifier>.element.<elementIdentifier>.properties.options.<propertyValue>`` +- ``element.<elementIdentifier>.properties.options.<propertyValue>`` + + +Example ++++++++ + +.. code-block:: yaml + + identifier: ApplicationForm + type: Form + prototypeName: standard + label: 'Application form' + + renderables: + - + identifier: GeneralInformation + type: Page + label: 'General information' + + renderables: + - + identifier: LastName + type: Text + label: 'Last name' + properties: + placeholder: 'Please enter your last name.' + defaultValue: '' + - + identifier: Software + type: MultiSelect + label: 'Known software' + properties: + options: + value1: TYPO3 + value2: Neos + +For the form element ``LastName``, the process will look for the following +translation keys within the translation files: + +- ``ApplicationForm.element.LastName.properties.label`` +- ``element.LastName.properties.label`` +- ``element.Text.properties.label`` + +If none of the above-mentioned keys exist, 'Last name' will be displayed. + +For the form element ``Software``, the process will look for the following +translation keys within the translation files: + +- ``ApplicationForm.element.Software.properties.label`` +- ``element.Software.properties.label`` +- ``element.MultiSelect.properties.label`` + +If none of the above-mentioned keys exist, 'Known software' will be +displayed. The option properties are addressed as follows: + +- ``ApplicationForm.element.Software.properties.options.value1`` +- ``element.Software.properties.options.value1`` +- ``ApplicationForm.element.Software.properties.options.value2`` +- ``element.Software.properties.options.value2`` + +If none of the above-mentioned keys exist, 'TYPO3' will be displayed as +label for the first option and 'Neos' as label for the second option. + + +.. _concepts-frontendrendering-translation-validationerrors: + +Translation of validation messages +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The translation of validation messages is similar to the translation of +``form definitions``. The same translation files can be used. If the look-up +process does not find a key within the provided files, the appropriate +message of the Extbase framework will be displayed. EXT:form already +translates all of those validators by default. + +As mentioned above, the translation keys are put together based on a +specific pattern. Furthermore, the fallback chain exists here as well. Thus, +the following translation scenarios are possible: + +- translation of validation messages for a specific validator of a concrete + form element and form +- translation of validation messages for a specific validator of various + form elements within a concrete form +- translation of validation messages for a specific validator within various + forms + +In Extbase, the validation messages are identified with the help of +numerical codes (UNIX timestamps). For the same validator, different codes +are valid. Read more about :ref:`concrete validator configurations <typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>-concreteconfigurations>`. + +The look-up process searches for translation keys in all given translation +files based on the following order: + +- ``<formDefinitionIdentifier>.validation.<elementIdentifier>.<validationErrorCode>`` +- ``<formDefinitionIdentifier>.validation.<validationErrorCode>`` +- ``validation.<validationErrorCode>`` + + +Example ++++++++ + +.. code-block:: yaml + + identifier: ContactForm + type: Form + prototypeName: standard + label: 'Contact us' + + renderables: + - + identifier: Page1 + type: Page + label: 'Page 1' + + renderables: + - + identifier: LastName + type: Text + label: 'Last name' + properties: + fluidAdditionalAttributes: + required: required + validators: + - + identifier: NotEmpty + +Amongst others, the ``NotEmpty`` validator sends 1221560910 as ``<validationErrorCode>``. +If a user submits this form without providing a value for the field "Last +name", the ``NotEmpty`` validator fails. Now, the look-up process searches +for the following translation keys for the ``NotEmpty`` validator combined +with the form element ``LastName``: + +- ContactForm.validation.LastName.1221560910 +- ContactForm.validation.1221560910 +- validation.1221560910 + +As mentioned above, if there is no corresponding translation key available, +the default message of the Extbase framework will be shown. + + +.. _concepts-frontendrendering-translation-finishers: + +Translation of finisher options +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The translation of finisher options is similar to the translation of +``form definitions``. The same translation files can be used. If the look-up +process does not find a key within all provided files, the property value +will be displayed unmodified. + +As mentioned above, the translation keys are put together based on a +specific pattern. Furthermore, the fallback chain exists here as well. Thus, +the following translation scenarios are possible: + +- translation of finisher options for a specific finisher of a concrete form +- translation of finisher options for a specific finisher of various forms + +The look-up process searches for translation keys in all given translation +files based on the following order: + +- ``<formDefinitionIdentifier>.finisher.<finisherIdentifier>.<optionName>`` +- ``finisher.<finisherIdentifier>.<optionName>`` + + +Example ++++++++ + +.. code-block:: yaml + + identifier: ContactForm + type: Form + prototypeName: standard + label: 'Contact us' + + finishers: + - + identifier: Confirmation + options: + message: 'Thank you for your inquiry.' + + renderables: + ... + +The look-up process searches for the following translation keys for the +``<finisherIdentifier>`` 'Confirmation' and the option 'message': + +- ``ContactForm.finisher.Confirmation.message`` +- ``finisher.Confirmation.message`` + +If no translation key exists, the message 'Thank you for your inquiry.' will +be shown. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/Concepts/Index.rst b/typo3/sysext/form/Documentation/Concepts/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..4ade1662745e7ddc97b633ba8e343b0b4a1b098e --- /dev/null +++ b/typo3/sysext/form/Documentation/Concepts/Index.rst @@ -0,0 +1,24 @@ +.. include:: ../Includes.txt + + +.. _concepts: + +======== +Concepts +======== + +Within this chapter, you will learn the basic concepts of the form framework. +It addresses your concerns as backend editor and integrator. Some of the +chapters also cover topics for developers. + +.. toctree:: + + TargetGroupsAndMainPrinciples/Index + Configuration/Index + FormConfigurationFormDefinition/Index + FormFileStorages/Index + FrontendRendering/Index + Finishers/Index + FormManager/Index + FormEditor/Index + FormPlugin/Index \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/Concepts/TargetGroupsAndMainPrinciples/Index.rst b/typo3/sysext/form/Documentation/Concepts/TargetGroupsAndMainPrinciples/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..649e9032f591ccde499251d6f3885b85a1bedd2c --- /dev/null +++ b/typo3/sysext/form/Documentation/Concepts/TargetGroupsAndMainPrinciples/Index.rst @@ -0,0 +1,48 @@ +.. include:: ../../Includes.txt + + +.. _concepts-introduction: + +Target groups and main principles +================================= + +As :ref:`mentioned earlier<what-does-it-do>`, the ``form`` extension can be +seen as a framework which allows editors, integrators, and developers to +create and manage all kind of forms. For this task, different interfaces +and techniques are available. + +Conceptually, EXT:form always tries to consider the ``form editor`` first. +The requirements for the ``form editor`` differ between the defined target +groups. On the one hand, as an integrator, you may want to manage HTML +class attributes. On the other hand, as a developer you may want to use the +``form editor`` as a kick starter for complex ``form definitions``, and you +may want to edit all possible (technical) properties you can think of. + +The form extension tries to find a compromise for such cases. Since the +``form editor`` is mainly used by backend editors, only simple, +nontechnical properties are displayed and editable. However, EXT:form +allows you to easily extend the ``form editor`` by writing some YAML +configurations. + +If this is not enough for your specific project, EXT:form provides a way to +integrate your own JavaScript code by utilizing the JavaScript API. Thus, +it should be possible to meet all your requirements. + +Your forms can be created and defined globally in the ``form module`` and/ +or loaded from extensions. Within the ``Mail form`` content element, one of +those forms can be referenced. + +Furthermore, certain aspects of a form can be overridden in the plugin. This +concept allows you to reuse the same form on different pages with the same, +or a different, configuration. + +The following explanations will show you that there are many ways to +manipulate the form framework in different contexts. + +Those explanations are partly contradictory, depending on your use case. It +is up to you how you want to use the form framework. Be creative and share +your solution with the TYPO3 community! + +This chapter attempts to describe the basics of the form framework. Check +out the reference and the example sections to get a deeper understanding of +the framework. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/Index.rst b/typo3/sysext/form/Documentation/ConfigurationReference/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..43740fabd5ae249407d9ab23d994cc05d8dd4471 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/Index.rst @@ -0,0 +1,18 @@ +.. include:: ../Includes.txt + + +.. _configurationreference: + +======================= +Configuration Reference +======================= + +This chapter is a complete reference of the possible configuration settings. +It addresses your concerns as and integrator and developer. + +.. toctree:: + + persistenceManager/Index + prototypes/Index + formManager/Index + configuration/Index diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/configuration/Index.rst b/typo3/sysext/form/Documentation/ConfigurationReference/configuration/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..263ac1d0552dae69de20037215b7948bef25cd3b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/configuration/Index.rst @@ -0,0 +1,2785 @@ +.. include:: ../../Includes.txt + + +.. _configurationreference-fullconfiguration: + +========================== +Full default configuration +========================== + + +.. code-block:: yaml + + persistenceManager: + allowedFileMounts: + 10: '1:/user_upload/' + allowSaveToExtensionPaths: false + allowDeleteFromExtensionPaths: false + prototypes: + standard: + formElementsDefinition: + Form: + formEditor: + predefinedDefaults: + renderingOptions: + submitButtonLabel: 'formEditor.elements.Form.editor.submitButtonLabel.value' + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.BaseFormElementMixin.editor.label.label + propertyPath: label + 300: + identifier: 'submitButtonLabel' + templateName: 'Inspector-TextEditor' + label: 'formEditor.elements.Form.editor.submitButtonLabel.label' + propertyPath: 'renderingOptions.submitButtonLabel' + 900: + identifier: finishers + templateName: Inspector-FinishersEditor + label: formEditor.elements.Form.editor.finishers.label + selectOptions: + 10: + value: '' + label: formEditor.elements.Form.editor.finishers.EmptyValue.label + 20: + value: EmailToSender + label: formEditor.elements.Form.editor.finishers.EmailToSender.label + 30: + value: EmailToReceiver + label: formEditor.elements.Form.editor.finishers.EmailToReceiver.label + 40: + value: Redirect + label: formEditor.elements.Form.editor.finishers.Redirect.label + 50: + value: DeleteUploads + label: formEditor.elements.Form.editor.finishers.DeleteUploads.label + _isCompositeFormElement: false + _isTopLevelFormElement: true + saveSuccessFlashMessageTitle: formEditor.elements.Form.saveSuccessFlashMessageTitle + saveSuccessFlashMessageMessage: formEditor.elements.Form.saveSuccessFlashMessageMessage + modalValidationErrorsDialogTitle: formEditor.modals.validationErrors.dialogTitle + modalValidationErrorsConfirmButton: formEditor.modals.validationErrors.confirmButton + modalInsertElementsDialogTitle: formEditor.modals.insertElements.dialogTitle + modalInsertPagesDialogTitle: formEditor.modals.newPages.dialogTitle + modalCloseDialogMessage: formEditor.modals.close.dialogMessage + modalCloseDialogTitle: formEditor.modals.close.dialogTitle + modalCloseConfirmButton: formEditor.modals.close.confirmButton + modalCloseCancleButton: formEditor.modals.close.cancleButton + modalRemoveElementDialogTitle: formEditor.modals.removeElement.dialogTitle + modalRemoveElementDialogMessage: formEditor.modals.removeElement.dialogMessage + modalRemoveElementConfirmButton: formEditor.modals.removeElement.confirmButton + modalRemoveElementCancleButton: formEditor.modals.removeElement.cancleButton + modalRemoveElementLastAvailablePageFlashMessageTitle: formEditor.modals.removeElement.lastAvailablePageFlashMessageTitle + modalRemoveElementLastAvailablePageFlashMessageMessage: formEditor.modals.removeElement.lastAvailablePageFlashMessageMessage + inspectorEditorFormElementSelectorNoElements: formEditor.inspector.editor.formelement_selector.no_elements + paginationTitle: formEditor.pagination.title + iconIdentifier: content-elements-mailform + propertyCollections: + finishers: + 10: + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.header.label + 200: + identifier: subject + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.subject.label + propertyPath: options.subject + enableFormelementSelectionButton: true + propertyValidators: + 10: NotEmpty + 20: FormElementIdentifierWithinCurlyBracesInclusive + 300: + identifier: recipientAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.recipientAddress.label + propertyPath: options.recipientAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmail + 20: FormElementIdentifierWithinCurlyBracesExclusive + 400: + identifier: recipientName + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.recipientName.label + propertyPath: options.recipientName + enableFormelementSelectionButton: true + propertyValidators: + 10: FormElementIdentifierWithinCurlyBracesInclusive + 500: + identifier: senderAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.senderAddress.label + propertyPath: options.senderAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmail + 20: FormElementIdentifierWithinCurlyBracesExclusive + 600: + identifier: senderName + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.senderName.label + propertyPath: options.senderName + enableFormelementSelectionButton: true + propertyValidators: + 10: FormElementIdentifierWithinCurlyBracesInclusive + 700: + identifier: replyToAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.replyToAddress.label + propertyPath: options.replyToAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + 800: + identifier: carbonCopyAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.carbonCopyAddress.label + propertyPath: options.carbonCopyAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + 900: + identifier: blindCarbonCopyAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.blindCarbonCopyAddress.label + propertyPath: options.blindCarbonCopyAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + 1000: + identifier: format + templateName: Inspector-SingleSelectEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.format.label + propertyPath: options.format + selectOptions: + 10: + value: plaintext + label: formEditor.elements.Form.finisher.EmailToSender.editor.format.1 + 20: + value: html + label: formEditor.elements.Form.finisher.EmailToSender.editor.format.2 + 1100: + identifier: attachUploads + templateName: Inspector-CheckboxEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.attachUploads.label + propertyPath: options.attachUploads + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + identifier: EmailToSender + 20: + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.header.label + 200: + identifier: subject + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.subject.label + propertyPath: options.subject + enableFormelementSelectionButton: true + propertyValidators: + 10: NotEmpty + 20: FormElementIdentifierWithinCurlyBracesInclusive + 300: + identifier: recipientAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.recipientAddress.label + propertyPath: options.recipientAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmail + 20: FormElementIdentifierWithinCurlyBracesExclusive + 400: + identifier: recipientName + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.recipientName.label + propertyPath: options.recipientName + enableFormelementSelectionButton: true + propertyValidators: + 10: FormElementIdentifierWithinCurlyBracesInclusive + 500: + identifier: senderAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.senderAddress.label + propertyPath: options.senderAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmail + 20: FormElementIdentifierWithinCurlyBracesExclusive + 600: + identifier: senderName + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.senderName.label + propertyPath: options.senderName + enableFormelementSelectionButton: true + propertyValidators: + 10: FormElementIdentifierWithinCurlyBracesInclusive + 700: + identifier: replyToAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.replyToAddress.label + propertyPath: options.replyToAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + 800: + identifier: carbonCopyAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.carbonCopyAddress.label + propertyPath: options.carbonCopyAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + 900: + identifier: blindCarbonCopyAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.blindCarbonCopyAddress.label + propertyPath: options.blindCarbonCopyAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + 1000: + identifier: format + templateName: Inspector-SingleSelectEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.format.label + propertyPath: options.format + selectOptions: + 10: + value: plaintext + label: formEditor.elements.Form.finisher.EmailToSender.editor.format.1 + 20: + value: html + label: formEditor.elements.Form.finisher.EmailToSender.editor.format.2 + 1100: + identifier: attachUploads + templateName: Inspector-CheckboxEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.attachUploads.label + propertyPath: options.attachUploads + 1200: + identifier: language + templateName: Inspector-SingleSelectEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.language.label + propertyPath: options.translation.language + selectOptions: + 10: + value: default + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.language.1 + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + identifier: EmailToReceiver + 30: + identifier: Redirect + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.Redirect.editor.header.label + 200: + identifier: pageUid + templateName: Inspector-Typo3WinBrowserEditor + label: formEditor.elements.Form.finisher.Redirect.editor.pageUid.label + buttonLabel: formEditor.elements.Form.finisher.Redirect.editor.pageUid.buttonLabel + browsableType: pages + propertyPath: options.pageUid + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: additionalParameters + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.Redirect.editor.additionalParameters.label + propertyPath: options.additionalParameters + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 40: + identifier: DeleteUploads + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.DeleteUploads.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 50: + identifier: Confirmation + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.Confirmation.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 60: + identifier: Closure + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.Closure.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 70: + identifier: FlashMessage + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.FlashMessage.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 80: + identifier: SaveToDatabase + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.SaveToDatabase.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + rendererClassName: TYPO3\CMS\Form\Domain\Renderer\FluidFormRenderer + renderingOptions: + translation: + translationFile: 'EXT:form/Resources/Private/Language/locallang.xlf' + templateRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Templates/' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Partials/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Layouts/' + addQueryString: false + argumentsToBeExcludedFromQueryString: { } + additionalParams: { } + controllerAction: perform + httpMethod: post + httpEnctype: multipart/form-data + _isCompositeFormElement: false + _isTopLevelFormElement: true + honeypot: + enable: true + formElementToUse: Honeypot + submitButtonLabel: Submit + skipUnknownElements: true + Page: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.Page.editor.label.label + propertyPath: label + 300: + identifier: 'previousButtonLabel' + templateName: 'Inspector-TextEditor' + label: 'formEditor.elements.Page.editor.previousButtonLabel.label' + propertyPath: 'renderingOptions.previousButtonLabel' + 400: + identifier: 'nextButtonLabel' + templateName: 'Inspector-TextEditor' + label: 'formEditor.elements.Page.editor.nextButtonLabel.label' + propertyPath: 'renderingOptions.nextButtonLabel' + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + renderingOptions: + previousButtonLabel: 'formEditor.elements.Page.editor.previousButtonLabel.value' + nextButtonLabel: 'formEditor.elements.Page.editor.nextButtonLabel.value' + label: formEditor.elements.Page.label + group: page + groupSorting: 100 + _isTopLevelFormElement: true + _isCompositeFormElement: true + iconIdentifier: t3-form-icon-page + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\Page + renderingOptions: + _isTopLevelFormElement: true + _isCompositeFormElement: true + nextButtonLabel: 'next Page' + previousButtonLabel: 'previous Page' + SummaryPage: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.SummaryPage.editor.label.label + propertyPath: label + 300: + identifier: 'previousButtonLabel' + templateName: 'Inspector-TextEditor' + label: 'formEditor.elements.SummaryPage.editor.previousButtonLabel.label' + propertyPath: 'renderingOptions.previousButtonLabel' + 400: + identifier: 'nextButtonLabel' + templateName: 'Inspector-TextEditor' + label: 'formEditor.elements.SummaryPage.editor.nextButtonLabel.label' + propertyPath: 'renderingOptions.nextButtonLabel' + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + renderingOptions: + previousButtonLabel: 'formEditor.elements.SummaryPage.editor.previousButtonLabel.value' + nextButtonLabel: 'formEditor.elements.SummaryPage.editor.nextButtonLabel.value' + label: formEditor.elements.SummaryPage.label + group: page + groupSorting: 200 + _isTopLevelFormElement: true + _isCompositeFormElement: false + iconIdentifier: t3-form-icon-summary-page + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\Page + renderingOptions: + _isTopLevelFormElement: true + _isCompositeFormElement: false + nextButtonLabel: 'next Page' + previousButtonLabel: 'previous Page' + Fieldset: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.Fieldset.editor.label.label + propertyPath: label + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: { } + label: formEditor.elements.Fieldset.label + group: container + groupSorting: 100 + _isCompositeFormElement: true + iconIdentifier: t3-form-icon-fieldset + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\Section + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + renderingOptions: + _isCompositeFormElement: true + GridContainer: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.GridContainer.editor.label.label + propertyPath: label + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: { } + label: formEditor.elements.GridContainer.label + group: container + groupSorting: 200 + _isCompositeFormElement: true + _isGridContainerFormElement: true + iconIdentifier: t3-form-icon-gridcontainer + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GridContainer + properties: + containerClassAttribute: input + elementClassAttribute: container + elementErrorClassAttribute: error + gridColumnClassAutoConfiguration: + gridSize: 12 + viewPorts: + xs: + classPattern: 'col-xs-{@numbersOfColumnsToUse}' + sm: + classPattern: 'col-sm-{@numbersOfColumnsToUse}' + md: + classPattern: 'col-md-{@numbersOfColumnsToUse}' + lg: + classPattern: 'col-lg-{@numbersOfColumnsToUse}' + renderingOptions: + _isCompositeFormElement: true + _isGridContainerFormElement: true + GridRow: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.GridRow.editor.label.label + propertyPath: label + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: { } + label: formEditor.elements.GridRow.label + group: container + groupSorting: 300 + _isCompositeFormElement: true + _isGridRowFormElement: true + iconIdentifier: t3-form-icon-gridrow + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GridRow + properties: + containerClassAttribute: input + elementClassAttribute: row + elementErrorClassAttribute: error + gridColumnClassAutoConfiguration: + gridSize: 12 + viewPorts: + xs: + classPattern: 'col-xs-{@numbersOfColumnsToUse}' + sm: + classPattern: 'col-sm-{@numbersOfColumnsToUse}' + md: + classPattern: 'col-md-{@numbersOfColumnsToUse}' + lg: + classPattern: 'col-lg-{@numbersOfColumnsToUse}' + renderingOptions: + _isCompositeFormElement: true + _isGridRowFormElement: true + Text: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 400: + identifier: placeholder + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.placeholder.label + propertyPath: properties.fluidAdditionalAttributes.placeholder + compatibilityPropertyPath: properties.placeholder + doNotSetIfPropertyValueIsEmpty: true + 500: + identifier: defaultValue + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.defaultValue.label + propertyPath: defaultValue + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.TextMixin.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.TextMixin.editor.validators.EmptyValue.label + 20: + value: Alphanumeric + label: formEditor.elements.TextMixin.editor.validators.Alphanumeric.label + 30: + value: Text + label: formEditor.elements.TextMixin.editor.validators.Text.label + 40: + value: StringLength + label: formEditor.elements.TextMixin.editor.validators.StringLength.label + 50: + value: EmailAddress + label: formEditor.elements.TextMixin.editor.validators.EmailAddress.label + 60: + value: Integer + label: formEditor.elements.TextMixin.editor.validators.Integer.label + 70: + value: Float + label: formEditor.elements.TextMixin.editor.validators.Float.label + 80: + value: NumberRange + label: formEditor.elements.TextMixin.editor.validators.NumberRange.label + 90: + value: RegularExpression + label: formEditor.elements.TextMixin.editor.validators.RegularExpression.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + defaultValue: '' + propertyCollections: + validators: + 10: + identifier: Alphanumeric + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Alphanumeric.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 20: + identifier: Text + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Text.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 30: + identifier: StringLength + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.StringLength.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.minlength + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.maxlength + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 40: + identifier: EmailAddress + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.EmailAddress.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 50: + identifier: Integer + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Integer.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 60: + identifier: Float + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Float.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 70: + identifier: NumberRange + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.NumberRange.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 80: + identifier: RegularExpression + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.header.label + 200: + identifier: regex + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.label + fieldExplanationText: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.fieldExplanationText + propertyPath: options.regularExpression + propertyValidators: + 10: NotEmpty + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + label: formEditor.elements.Text.label + group: input + groupSorting: 100 + iconIdentifier: t3-form-icon-text + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + Password: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 400: + identifier: placeholder + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.placeholder.label + propertyPath: properties.fluidAdditionalAttributes.placeholder + compatibilityPropertyPath: properties.placeholder + doNotSetIfPropertyValueIsEmpty: true + 500: + identifier: defaultValue + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.defaultValue.label + propertyPath: defaultValue + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.TextMixin.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.TextMixin.editor.validators.EmptyValue.label + 20: + value: Alphanumeric + label: formEditor.elements.TextMixin.editor.validators.Alphanumeric.label + 30: + value: Text + label: formEditor.elements.TextMixin.editor.validators.Text.label + 40: + value: StringLength + label: formEditor.elements.TextMixin.editor.validators.StringLength.label + 50: + value: EmailAddress + label: formEditor.elements.TextMixin.editor.validators.EmailAddress.label + 60: + value: Integer + label: formEditor.elements.TextMixin.editor.validators.Integer.label + 70: + value: Float + label: formEditor.elements.TextMixin.editor.validators.Float.label + 80: + value: NumberRange + label: formEditor.elements.TextMixin.editor.validators.NumberRange.label + 90: + value: RegularExpression + label: formEditor.elements.TextMixin.editor.validators.RegularExpression.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + defaultValue: '' + propertyCollections: + validators: + 10: + identifier: Alphanumeric + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Alphanumeric.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 20: + identifier: Text + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Text.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 30: + identifier: StringLength + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.StringLength.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.minlength + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.maxlength + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 40: + identifier: EmailAddress + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.EmailAddress.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 50: + identifier: Integer + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Integer.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 60: + identifier: Float + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Float.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 70: + identifier: NumberRange + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.NumberRange.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 80: + identifier: RegularExpression + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.header.label + 200: + identifier: regex + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.label + fieldExplanationText: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.fieldExplanationText + propertyPath: options.regularExpression + propertyValidators: + 10: NotEmpty + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + label: formEditor.elements.Password.label + group: input + groupSorting: 300 + iconIdentifier: t3-form-icon-password + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + AdvancedPassword: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 300: + identifier: confirmationLabel + templateName: Inspector-TextEditor + label: formEditor.elements.AdvancedPassword.editor.confirmationLabel.label + propertyPath: properties.confirmationLabel + 400: + identifier: placeholder + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.placeholder.label + propertyPath: properties.fluidAdditionalAttributes.placeholder + compatibilityPropertyPath: properties.placeholder + doNotSetIfPropertyValueIsEmpty: true + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.TextMixin.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.TextMixin.editor.validators.EmptyValue.label + 20: + value: Alphanumeric + label: formEditor.elements.TextMixin.editor.validators.Alphanumeric.label + 30: + value: Text + label: formEditor.elements.TextMixin.editor.validators.Text.label + 40: + value: StringLength + label: formEditor.elements.TextMixin.editor.validators.StringLength.label + 50: + value: EmailAddress + label: formEditor.elements.TextMixin.editor.validators.EmailAddress.label + 60: + value: Integer + label: formEditor.elements.TextMixin.editor.validators.Integer.label + 70: + value: Float + label: formEditor.elements.TextMixin.editor.validators.Float.label + 80: + value: NumberRange + label: formEditor.elements.TextMixin.editor.validators.NumberRange.label + 90: + value: RegularExpression + label: formEditor.elements.TextMixin.editor.validators.RegularExpression.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + properties: + confirmationLabel: formEditor.element.AdvancedPassword.editor.confirmationLabel.predefinedDefaults + propertyCollections: + validators: + 10: + identifier: Alphanumeric + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Alphanumeric.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 20: + identifier: Text + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Text.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 30: + identifier: StringLength + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.StringLength.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.minlength + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.maxlength + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 40: + identifier: EmailAddress + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.EmailAddress.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 50: + identifier: Integer + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Integer.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 60: + identifier: Float + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Float.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 70: + identifier: NumberRange + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.NumberRange.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 80: + identifier: RegularExpression + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.header.label + 200: + identifier: regex + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.label + fieldExplanationText: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.fieldExplanationText + propertyPath: options.regularExpression + propertyValidators: + 10: NotEmpty + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + label: formEditor.elements.AdvancedPassword.label + group: custom + groupSorting: 500 + iconIdentifier: t3-form-icon-advanced-password + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\AdvancedPassword + properties: + containerClassAttribute: input + elementClassAttribute: input-medium + elementErrorClassAttribute: error + confirmationLabel: '' + confirmationClassAttribute: input-medium + Textarea: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 400: + identifier: placeholder + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.placeholder.label + propertyPath: properties.fluidAdditionalAttributes.placeholder + compatibilityPropertyPath: properties.placeholder + doNotSetIfPropertyValueIsEmpty: true + 500: + identifier: defaultValue + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.defaultValue.label + propertyPath: defaultValue + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.TextMixin.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.TextMixin.editor.validators.EmptyValue.label + 20: + value: Alphanumeric + label: formEditor.elements.TextMixin.editor.validators.Alphanumeric.label + 30: + value: Text + label: formEditor.elements.TextMixin.editor.validators.Text.label + 40: + value: StringLength + label: formEditor.elements.TextMixin.editor.validators.StringLength.label + 60: + value: Integer + label: formEditor.elements.TextMixin.editor.validators.Integer.label + 70: + value: Float + label: formEditor.elements.TextMixin.editor.validators.Float.label + 80: + value: NumberRange + label: formEditor.elements.TextMixin.editor.validators.NumberRange.label + 90: + value: RegularExpression + label: formEditor.elements.TextMixin.editor.validators.RegularExpression.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + defaultValue: '' + propertyCollections: + validators: + 10: + identifier: Alphanumeric + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Alphanumeric.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 20: + identifier: Text + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Text.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 30: + identifier: StringLength + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.StringLength.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.minlength + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.maxlength + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 40: + identifier: EmailAddress + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.EmailAddress.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 50: + identifier: Integer + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Integer.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 60: + identifier: Float + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Float.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 70: + identifier: NumberRange + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.NumberRange.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 80: + identifier: RegularExpression + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.header.label + 200: + identifier: regex + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.label + fieldExplanationText: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.fieldExplanationText + propertyPath: options.regularExpression + propertyValidators: + 10: NotEmpty + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + label: formEditor.elements.Textarea.label + group: input + groupSorting: 200 + iconIdentifier: t3-form-icon-textarea + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + properties: + containerClassAttribute: input + elementClassAttribute: xxlarge + elementErrorClassAttribute: error + Honeypot: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + renderAsHiddenField: false + styleAttribute: 'position:absolute; margin:0 0 0 -999em;' + Hidden: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 300: + identifier: defaultValue + templateName: Inspector-TextEditor + label: formEditor.elements.Hidden.editor.defaultValue.label + propertyPath: defaultValue + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + defaultValue: '' + label: formEditor.elements.Hidden.label + group: custom + groupSorting: 300 + iconIdentifier: t3-form-icon-hidden + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + Checkbox: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: { } + label: formEditor.elements.Checkbox.label + group: select + groupSorting: 100 + iconIdentifier: t3-form-icon-checkbox + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + properties: + containerClassAttribute: 'input checkbox' + elementClassAttribute: add-on + elementErrorClassAttribute: error + value: 1 + MultiCheckbox: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 300: + identifier: options + templateName: Inspector-PropertyGridEditor + label: formEditor.elements.SelectionMixin.editor.options.label + propertyPath: properties.options + isSortable: true + enableAddRow: true + enableDeleteRow: true + removeLastAvailableRowFlashMessageTitle: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageTitle + removeLastAvailableRowFlashMessageMessage: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageMessage + shouldShowPreselectedValueColumn: multiple + multiSelection: true + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.MultiSelectionMixin.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.MultiSelectionMixin.editor.validators.EmptyValue.label + 20: + value: Count + label: formEditor.elements.MultiSelectionMixin.editor.validators.Count.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + properties: + options: { } + propertyCollections: + validators: + 10: + identifier: Count + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.MultiSelectionMixin.validators.Count.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + label: formEditor.elements.MultiCheckbox.label + group: select + groupSorting: 400 + iconIdentifier: t3-form-icon-multi-checkbox + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + properties: + containerClassAttribute: 'input checkbox' + elementClassAttribute: '' + elementErrorClassAttribute: error + MultiSelect: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 250: + identifier: inactiveOption + templateName: Inspector-TextEditor + label: formEditor.elements.SelectionMixin.editor.inactiveOption.label + propertyPath: properties.prependOptionLabel + fieldExplanationText: formEditor.elements.SelectionMixin.editor.inactiveOption.fieldExplanationText + doNotSetIfPropertyValueIsEmpty: true + 300: + identifier: options + templateName: Inspector-PropertyGridEditor + label: formEditor.elements.SelectionMixin.editor.options.label + propertyPath: properties.options + isSortable: true + enableAddRow: true + enableDeleteRow: true + removeLastAvailableRowFlashMessageTitle: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageTitle + removeLastAvailableRowFlashMessageMessage: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageMessage + shouldShowPreselectedValueColumn: multiple + multiSelection: true + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.MultiSelectionMixin.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.MultiSelectionMixin.editor.validators.EmptyValue.label + 20: + value: Count + label: formEditor.elements.MultiSelectionMixin.editor.validators.Count.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + properties: + options: { } + propertyCollections: + validators: + 10: + identifier: Count + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.MultiSelectionMixin.validators.Count.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + label: formEditor.elements.MultiSelect.label + group: select + groupSorting: 500 + iconIdentifier: t3-form-icon-multi-select + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + properties: + containerClassAttribute: input + elementClassAttribute: xlarge + elementErrorClassAttribute: error + RadioButton: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 300: + identifier: options + templateName: Inspector-PropertyGridEditor + label: formEditor.elements.SelectionMixin.editor.options.label + propertyPath: properties.options + isSortable: true + enableAddRow: true + enableDeleteRow: true + removeLastAvailableRowFlashMessageTitle: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageTitle + removeLastAvailableRowFlashMessageMessage: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageMessage + shouldShowPreselectedValueColumn: single + multiSelection: false + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + properties: + options: { } + label: formEditor.elements.RadioButton.label + group: select + groupSorting: 300 + iconIdentifier: t3-form-icon-radio-button + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + properties: + containerClassAttribute: input + elementClassAttribute: xlarge + elementErrorClassAttribute: error + SingleSelect: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 250: + identifier: inactiveOption + templateName: Inspector-TextEditor + label: formEditor.elements.SelectionMixin.editor.inactiveOption.label + propertyPath: properties.prependOptionLabel + fieldExplanationText: formEditor.elements.SelectionMixin.editor.inactiveOption.fieldExplanationText + doNotSetIfPropertyValueIsEmpty: true + 300: + identifier: options + templateName: Inspector-PropertyGridEditor + label: formEditor.elements.SelectionMixin.editor.options.label + propertyPath: properties.options + isSortable: true + enableAddRow: true + enableDeleteRow: true + removeLastAvailableRowFlashMessageTitle: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageTitle + removeLastAvailableRowFlashMessageMessage: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageMessage + shouldShowPreselectedValueColumn: single + multiSelection: false + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + properties: + options: { } + label: formEditor.elements.SingleSelect.label + group: select + groupSorting: 200 + iconIdentifier: t3-form-icon-single-select + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + DatePicker: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 300: + identifier: dateFormat + templateName: Inspector-TextEditor + label: formEditor.elements.DatePicker.editor.dateFormat.label + propertyPath: properties.dateFormat + 400: + identifier: enableDatePicker + templateName: Inspector-CheckboxEditor + label: formEditor.elements.DatePicker.editor.enableDatePicker.label + propertyPath: properties.enableDatePicker + 500: + identifier: displayTimeSelector + templateName: Inspector-CheckboxEditor + label: formEditor.elements.DatePicker.editor.displayTimeSelector.label + propertyPath: properties.displayTimeSelector + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.DatePicker.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.DatePicker.editor.validators.EmptyValue.label + 20: + value: DateTime + label: formEditor.elements.DatePicker.editor.validators.DateTime.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + properties: + dateFormat: Y-m-d + enableDatePicker: true + displayTimeSelector: false + label: formEditor.elements.DatePicker.label + group: custom + groupSorting: 200 + iconIdentifier: t3-form-icon-date-picker + propertyCollections: + validators: + 10: + identifier: DateTime + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.DatePicker.validators.DateTime.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\DatePicker + properties: + containerClassAttribute: input + elementClassAttribute: 'small form-control' + elementErrorClassAttribute: error + timeSelectorClassAttribute: mini + timeSelectorHourLabel: '' + timeSelectorMinuteLabel: '' + dateFormat: Y-m-d + enableDatePicker: true + displayTimeSelector: false + StaticText: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.ReadOnlyFormElement.editor.label.label + propertyPath: label + 300: + identifier: staticText + templateName: Inspector-TextareaEditor + label: formEditor.elements.StaticText.editor.staticText.label + propertyPath: properties.text + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + properties: + text: '' + label: formEditor.elements.StaticText.label + group: custom + groupSorting: 600 + iconIdentifier: t3-form-icon-static-text + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + properties: + text: '' + ContentElement: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 300: + identifier: contentElement + templateName: Inspector-Typo3WinBrowserEditor + label: formEditor.elements.ContentElement.editor.contentElement.label + buttonLabel: formEditor.elements.ContentElement.editor.contentElement.buttonLabel + browsableType: tt_content + propertyPath: properties.contentElementUid + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + properties: + contentElementUid: '' + label: formEditor.elements.ContentElement.label + group: custom + groupSorting: 700 + iconIdentifier: t3-form-icon-content-element + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + properties: + contentElementUid: '' + FileUpload: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 300: + identifier: allowedMimeTypes + templateName: Inspector-MultiSelectEditor + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.label + propertyPath: properties.allowedMimeTypes + selectOptions: + 10: + value: application/msword + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.doc + 20: + value: application/vnd.openxmlformats-officedocument.wordprocessingml.document + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.docx + 30: + value: application/msexcel + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.xls + 40: + value: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.xlsx + 50: + value: application/pdf + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.pdf + 60: + value: application/vnd.oasis.opendocument.text + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.odt + 70: + value: application/vnd.oasis.opendocument.spreadsheet-template + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.ods + 400: + identifier: saveToFileMount + templateName: Inspector-SingleSelectEditor + label: formEditor.elements.FileUploadMixin.editor.saveToFileMount.label + propertyPath: properties.saveToFileMount + selectOptions: + 10: + value: '1:/user_upload/' + label: '1:/user_upload/' + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + properties: + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - application/pdf + label: formEditor.elements.FileUpload.label + group: custom + groupSorting: 100 + iconIdentifier: t3-form-icon-file-upload + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\FileUpload + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - application/msword + - application/vnd.openxmlformats-officedocument.wordprocessingml.document + - application/vnd.oasis.opendocument.text + - application/pdf + ImageUpload: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 300: + identifier: allowedMimeTypes + templateName: Inspector-MultiSelectEditor + label: formEditor.elements.ImageUpload.editor.allowedMimeTypes.label + propertyPath: properties.allowedMimeTypes + selectOptions: + 10: + value: image/jpeg + label: formEditor.elements.ImageUpload.editor.allowedMimeTypes.jpg + 20: + value: image/png + label: formEditor.elements.ImageUpload.editor.allowedMimeTypes.png + 30: + value: image/bmp + label: formEditor.elements.ImageUpload.editor.allowedMimeTypes.bmp + 400: + identifier: saveToFileMount + templateName: Inspector-SingleSelectEditor + label: formEditor.elements.FileUploadMixin.editor.saveToFileMount.label + propertyPath: properties.saveToFileMount + selectOptions: + 10: + value: '1:/user_upload/' + label: '1:/user_upload/' + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + properties: + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - image/jpeg + label: formEditor.elements.ImageUpload.label + group: custom + groupSorting: 400 + iconIdentifier: t3-form-icon-image-upload + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\FileUpload + properties: + containerClassAttribute: input + elementClassAttribute: lightbox + elementErrorClassAttribute: error + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - image/jpeg + - image/png + - image/bmp + imageLinkMaxWidth: 500 + imageMaxWidth: 500 + imageMaxHeight: 500 + finishersDefinition: + Closure: + implementationClassName: TYPO3\CMS\Form\Domain\Finishers\ClosureFinisher + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.Closure.editor.header.label + predefinedDefaults: + options: + closure: '' + Confirmation: + implementationClassName: TYPO3\CMS\Form\Domain\Finishers\ConfirmationFinisher + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.Confirmation.editor.header.label + predefinedDefaults: + options: + message: '' + EmailToSender: + implementationClassName: TYPO3\CMS\Form\Domain\Finishers\EmailFinisher + options: + templatePathAndFilename: 'EXT:form/Resources/Private/Frontend/Templates/Finishers/Email/{@format}.html' + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.EmailToSender.editor.header.label + predefinedDefaults: + options: + subject: '' + recipientAddress: '' + recipientName: '' + senderAddress: '' + senderName: '' + replyToAddress: '' + carbonCopyAddress: '' + blindCarbonCopyAddress: '' + format: html + attachUploads: true + FormEngine: + label: tt_content.finishersDefinition.EmailToSender.label + elements: + subject: + label: tt_content.finishersDefinition.EmailToSender.subject.label + config: + type: input + recipientAddress: + label: tt_content.finishersDefinition.EmailToSender.recipientAddress.label + config: + type: input + eval: required + recipientName: + label: tt_content.finishersDefinition.EmailToSender.recipientName.label + config: + type: input + senderAddress: + label: tt_content.finishersDefinition.EmailToSender.senderAddress.label + config: + type: input + eval: required + senderName: + label: tt_content.finishersDefinition.EmailToSender.senderName.label + config: + type: input + replyToAddress: + label: tt_content.finishersDefinition.EmailToSender.replyToAddress.label + config: + type: input + carbonCopyAddress: + label: tt_content.finishersDefinition.EmailToSender.carbonCopyAddress.label + config: + type: input + blindCarbonCopyAddress: + label: tt_content.finishersDefinition.EmailToSender.blindCarbonCopyAddress.label + config: + type: input + format: + label: tt_content.finishersDefinition.EmailToSender.format.label + config: + type: select + renderType: selectSingle + minitems: 1 + maxitems: 1 + size: 1 + items: + 10: + - tt_content.finishersDefinition.EmailToSender.format.1 + - html + 20: + - tt_content.finishersDefinition.EmailToSender.format.2 + - plaintext + EmailToReceiver: + implementationClassName: TYPO3\CMS\Form\Domain\Finishers\EmailFinisher + options: + templatePathAndFilename: 'EXT:form/Resources/Private/Frontend/Templates/Finishers/Email/{@format}.html' + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.header.label + predefinedDefaults: + options: + subject: '' + recipientAddress: '' + recipientName: '' + senderAddress: '' + senderName: '' + replyToAddress: '' + carbonCopyAddress: '' + blindCarbonCopyAddress: '' + format: html + attachUploads: true + translation: + language: '' + FormEngine: + label: tt_content.finishersDefinition.EmailToReceiver.label + elements: + subject: + label: tt_content.finishersDefinition.EmailToReceiver.subject.label + config: + type: input + recipientAddress: + label: tt_content.finishersDefinition.EmailToReceiver.recipientAddress.label + config: + type: input + eval: required + recipientName: + label: tt_content.finishersDefinition.EmailToReceiver.recipientName.label + config: + type: input + senderAddress: + label: tt_content.finishersDefinition.EmailToReceiver.senderAddress.label + config: + type: input + eval: required + senderName: + label: tt_content.finishersDefinition.EmailToReceiver.senderName.label + config: + type: input + replyToAddress: + label: tt_content.finishersDefinition.EmailToReceiver.replyToAddress.label + config: + type: input + carbonCopyAddress: + label: tt_content.finishersDefinition.EmailToReceiver.carbonCopyAddress.label + config: + type: input + blindCarbonCopyAddress: + label: tt_content.finishersDefinition.EmailToReceiver.blindCarbonCopyAddress.label + config: + type: input + format: + label: tt_content.finishersDefinition.EmailToReceiver.format.label + config: + type: select + renderType: selectSingle + minitems: 1 + maxitems: 1 + size: 1 + items: + 10: + - tt_content.finishersDefinition.EmailToSender.format.1 + - html + 20: + - tt_content.finishersDefinition.EmailToSender.format.2 + - plaintext + translation: + language: + label: tt_content.finishersDefinition.EmailToReceiver.language.label + config: + type: select + renderType: selectSingle + minitems: 1 + maxitems: 1 + size: 1 + items: + 10: + - tt_content.finishersDefinition.EmailToReceiver.language.1 + - default + DeleteUploads: + implementationClassName: TYPO3\CMS\Form\Domain\Finishers\DeleteUploadsFinisher + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.DeleteUploads.editor.header.label + FlashMessage: + implementationClassName: TYPO3\CMS\Form\Domain\Finishers\FlashMessageFinisher + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.FlashMessage.editor.header.label + predefinedDefaults: + options: + messageBody: '' + messageTitle: '' + messageArguments: '' + messageCode: 0 + severity: 0 + Redirect: + implementationClassName: TYPO3\CMS\Form\Domain\Finishers\RedirectFinisher + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.Redirect.editor.header.label + predefinedDefaults: + options: + pageUid: '' + additionalParameters: '' + FormEngine: + label: tt_content.finishersDefinition.Redirect.label + elements: + pageUid: + label: tt_content.finishersDefinition.Redirect.pageUid.label + config: + type: group + internal_type: db + allowed: pages + size: 1 + minitems: 1 + maxitems: 1 + fieldWizard: + recordOverview: + disabled: 1 + additionalParameters: + label: tt_content.finishersDefinition.Redirect.additionalParameters.label + config: + type: input + SaveToDatabase: + implementationClassName: TYPO3\CMS\Form\Domain\Finishers\SaveToDatabaseFinisher + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.SaveToDatabase.editor.header.label + predefinedDefaults: + options: { } + validatorsDefinition: + NotEmpty: + implementationClassName: TYPO3\CMS\Extbase\Validation\Validator\NotEmptyValidator + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.FormElement.editor.requiredValidator.label + DateTime: + implementationClassName: TYPO3\CMS\Extbase\Validation\Validator\DateTimeValidator + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.DatePicker.validators.DateTime.editor.header.label + Alphanumeric: + implementationClassName: TYPO3\CMS\Extbase\Validation\Validator\AlphanumericValidator + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.Alphanumeric.label + Text: + implementationClassName: TYPO3\CMS\Extbase\Validation\Validator\TextValidator + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.Text.label + StringLength: + implementationClassName: TYPO3\CMS\Extbase\Validation\Validator\StringLengthValidator + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.StringLength.label + predefinedDefaults: + options: + minimum: '' + maximum: '' + EmailAddress: + implementationClassName: TYPO3\CMS\Extbase\Validation\Validator\EmailAddressValidator + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.EmailAddress.label + Integer: + implementationClassName: TYPO3\CMS\Extbase\Validation\Validator\IntegerValidator + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.Integer.label + Float: + implementationClassName: TYPO3\CMS\Extbase\Validation\Validator\FloatValidator + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.Float.label + NumberRange: + implementationClassName: TYPO3\CMS\Extbase\Validation\Validator\NumberRangeValidator + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.NumberRange.label + predefinedDefaults: + options: + minimum: '' + maximum: '' + RegularExpression: + implementationClassName: TYPO3\CMS\Extbase\Validation\Validator\RegularExpressionValidator + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.RegularExpression.label + predefinedDefaults: + options: + regularExpression: '' + Count: + implementationClassName: TYPO3\CMS\Form\Mvc\Validation\CountValidator + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.MultiSelectionMixin.validators.Count.editor.header.label + predefinedDefaults: + options: + minimum: '' + maximum: '' + formEditor: + translationFile: 'EXT:form/Resources/Private/Language/Database.xlf' + dynamicRequireJsModules: + app: TYPO3/CMS/Form/Backend/FormEditor + mediator: TYPO3/CMS/Form/Backend/FormEditor/Mediator + viewModel: TYPO3/CMS/Form/Backend/FormEditor/ViewModel + addInlineSettings: { } + maximumUndoSteps: 10 + stylesheets: + 200: 'EXT:form/Resources/Public/Css/form.css' + formEditorFluidConfiguration: + templatePathAndFilename: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/InlineTemplates.html' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Backend/Partials/FormEditor/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Backend/Layouts/FormEditor/' + formEditorPartials: + FormElement-_ElementToolbar: Stage/_ElementToolbar + FormElement-_UnknownElement: Stage/_UnknownElement + FormElement-Page: Stage/Page + FormElement-SummaryPage: Stage/SummaryPage + FormElement-Fieldset: Stage/Fieldset + FormElement-GridContainer: Stage/Fieldset + FormElement-GridRow: Stage/Fieldset + FormElement-Text: Stage/SimpleTemplate + FormElement-Password: Stage/SimpleTemplate + FormElement-AdvancedPassword: Stage/SimpleTemplate + FormElement-Textarea: Stage/SimpleTemplate + FormElement-Checkbox: Stage/SimpleTemplate + FormElement-MultiCheckbox: Stage/SelectTemplate + FormElement-MultiSelect: Stage/SelectTemplate + FormElement-RadioButton: Stage/SelectTemplate + FormElement-SingleSelect: Stage/SelectTemplate + FormElement-DatePicker: Stage/SimpleTemplate + FormElement-StaticText: Stage/StaticText + FormElement-Hidden: Stage/SimpleTemplate + FormElement-ContentElement: Stage/ContentElement + FormElement-FileUpload: Stage/FileUploadTemplate + FormElement-ImageUpload: Stage/FileUploadTemplate + Modal-InsertElements: Modals/InsertElements + Modal-InsertPages: Modals/InsertPages + Modal-ValidationErrors: Modals/ValidationErrors + Inspector-FormElementHeaderEditor: Inspector/FormElementHeaderEditor + Inspector-CollectionElementHeaderEditor: Inspector/CollectionElementHeaderEditor + Inspector-TextEditor: Inspector/TextEditor + Inspector-PropertyGridEditor: Inspector/PropertyGridEditor + Inspector-SingleSelectEditor: Inspector/SingleSelectEditor + Inspector-MultiSelectEditor: Inspector/MultiSelectEditor + Inspector-GridColumnViewPortConfigurationEditor: Inspector/GridColumnViewPortConfigurationEditor + Inspector-TextareaEditor: Inspector/TextareaEditor + Inspector-RemoveElementEditor: Inspector/RemoveElementEditor + Inspector-FinishersEditor: Inspector/FinishersEditor + Inspector-ValidatorsEditor: Inspector/ValidatorsEditor + Inspector-RequiredValidatorEditor: Inspector/RequiredValidatorEditor + Inspector-CheckboxEditor: Inspector/CheckboxEditor + Inspector-Typo3WinBrowserEditor: Inspector/Typo3WinBrowserEditor + formElementPropertyValidatorsDefinition: + NotEmpty: + errorMessage: formEditor.formElementPropertyValidatorsDefinition.NotEmpty.label + Integer: + errorMessage: formEditor.formElementPropertyValidatorsDefinition.Integer.label + NaiveEmail: + errorMessage: formEditor.formElementPropertyValidatorsDefinition.NaiveEmail.label + NaiveEmailOrEmpty: + errorMessage: formEditor.formElementPropertyValidatorsDefinition.NaiveEmail.label + FormElementIdentifierWithinCurlyBracesInclusive: + errorMessage: formEditor.formElementPropertyValidatorsDefinition.FormElementIdentifierWithinCurlyBraces.label + FormElementIdentifierWithinCurlyBracesExclusive: + errorMessage: formEditor.formElementPropertyValidatorsDefinition.FormElementIdentifierWithinCurlyBraces.label + formElementGroups: + input: + label: formEditor.formElementGroups.input.label + select: + label: formEditor.formElementGroups.select.label + custom: + label: formEditor.formElementGroups.custom.label + container: + label: formEditor.formElementGroups.container.label + page: + label: formEditor.formElementGroups.page.label + formEngine: + translationFile: 'EXT:form/Resources/Private/Language/Database.xlf' + formManager: + dynamicRequireJsModules: + app: TYPO3/CMS/Form/Backend/FormManager + viewModel: TYPO3/CMS/Form/Backend/FormManager/ViewModel + stylesheets: + 100: 'EXT:form/Resources/Public/Css/form.css' + translationFile: 'EXT:form/Resources/Private/Language/Database.xlf' + javaScriptTranslationFile: 'EXT:form/Resources/Private/Language/locallang_formManager_javascript.xlf' + selectablePrototypesConfiguration: + 100: + identifier: standard + label: formManager.selectablePrototypesConfiguration.standard.label + newFormTemplates: + 100: + templatePath: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/Yaml/NewForms/BlankForm.yaml' + label: formManager.selectablePrototypesConfiguration.standard.newFormTemplates.blankForm.label + 200: + templatePath: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/Yaml/NewForms/SimpleContactForm.yaml' + label: formManager.selectablePrototypesConfiguration.standard.newFormTemplates.simpleContactForm.label + controller: + deleteAction: + errorTitle: formManagerController.deleteAction.error.title + errorMessage: formManagerController.deleteAction.error.body diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/formManager/Index.rst b/typo3/sysext/form/Documentation/ConfigurationReference/formManager/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..ffa64832ef93822f00c403ce05094bd1de4bc216 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/formManager/Index.rst @@ -0,0 +1,436 @@ +.. include:: ../../Includes.txt + + +.. _typo3.cms.form.formmanager: + +============= +[formManager] +============= + + +.. _typo3.cms.form.formmanager-properties: + +Properties +========== + + +.. _typo3.cms.form.formmanager.dynamicrequirejsmodules.app: + +dynamicRequireJsModules.app +--------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.formManager.dynamicRequireJsModules.app + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form manager) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + dynamicRequireJsModules: + app: TYPO3/CMS/Form/Backend/FormManager + viewModel: TYPO3/CMS/Form/Backend/FormManager/ViewModel + +:aspect:`Description` + Internal setting. RequireJS path for the form manager JavaScript app. + + +.. _typo3.cms.form.formmanager.dynamicrequirejsmodules.viewmodel: + +dynamicRequireJsModules.viewModel +--------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.formManager.dynamicRequireJsModules.viewModel + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form manager) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + dynamicRequireJsModules: + app: TYPO3/CMS/Form/Backend/FormManager + viewModel: TYPO3/CMS/Form/Backend/FormManager/ViewModel + +:aspect:`Description` + Internal setting. RequireJS path for the form manager JavaScript view model. + + +.. _typo3.cms.form.formmanager.stylesheets: + +stylesheets +----------- + +:aspect:`Option path` + TYPO3.CMS.Form.formManager.stylesheets + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form manager) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + + stylesheets: + 100: 'EXT:form/Resources/Public/Css/form.css' + +:aspect:`Description` + Internal setting. Path for the form manager CSS file. + + +.. _typo3.cms.form.formmanager.translationfile: + +translationFile +--------------- + +:aspect:`Option path` + TYPO3.CMS.Form.formManager.translationFile + +:aspect:`Data type` + string/ array + +:aspect:`Needed by` + Backend (form manager) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + + translationFile: 'EXT:form/Resources/Private/Language/Database.xlf' + +:aspect:`Good to know` + :ref:`Translate "Start template" options<concepts-formmanager-translation-starttemplate>` + +:aspect:`Description` + The translation file(s) which should be used to translate parts of the form manager. + + +.. _typo3.cms.form.formmanager.javascripttranslationfile: + +javaScriptTranslationFile +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.formManager.javaScriptTranslationFile + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form manager) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + + javaScriptTranslationFile: 'EXT:form/Resources/Private/Language/locallang_formManager_javascript.xlf' + +:aspect:`Description` + Internal setting. Path for the inline language labels for the form manager app. + + +.. _typo3.cms.form.formmanager.selectableprototypesconfiguration: + +selectablePrototypesConfiguration +--------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form manager) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + + selectablePrototypesConfiguration: + 100: + identifier: standard + label: formManager.selectablePrototypesConfiguration.standard.label + newFormTemplates: + 100: + templatePath: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/Yaml/NewForms/BlankForm.yaml' + label: formManager.selectablePrototypesConfiguration.standard.newFormTemplates.blankForm.label + 200: + templatePath: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/Yaml/NewForms/SimpleContactForm.yaml' + label: formManager.selectablePrototypesConfiguration.standard.newFormTemplates.simpleContactForm.label + +:aspect:`Good to know` + - :ref:`"Start templates"<concepts-formmanager-starttemplate>` + - :ref:`Translate "Start template" options<concepts-formmanager-translation-starttemplate>` + +:aspect:`Description` + Array with numerical Keys. Configure the ``Start template`` selection list within the ``form manager`` "Advanced settings" step. + + +.. _typo3.cms.form.formmanager.selectableprototypesconfiguration.*.identifier: + +selectablePrototypesConfiguration.*.identifier +---------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration.*.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form manager) + +:aspect:`Mandatory` + Yes + +:aspect:`Related options` + - :ref:`TYPO3.CMS.Form.prototypes <typo3.cms.form.prototypes>` + +:aspect:`Good to know` + - :ref:`"Start templates"<concepts-formmanager-starttemplate>` + +:aspect:`Description` + Reference to a ``prototype`` which should be used for the newly created form definition. + + +.. _typo3.cms.form.formmanager.selectableprototypesconfiguration.*.label: + +selectablePrototypesConfiguration.*.label +----------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration.*.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form manager) + +:aspect:`Mandatory` + Yes + +:aspect:`Good to know` + - :ref:`"Start templates"<concepts-formmanager-starttemplate>` + - :ref:`Translate "Start template" options<concepts-formmanager-translation-starttemplate>` + +:aspect:`Description` + The ``Form prototype`` selectlist label for this ``prototype`` within the ``form manager`` "Advanced settings" step. + + +.. _typo3.cms.form.formmanager.selectableprototypesconfiguration.*.newformtemplates: + +selectablePrototypesConfiguration.*.newFormTemplates +---------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration.*.newFormTemplates + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form manager) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + selectablePrototypesConfiguration: + 100: + identifier: standard + label: formManager.selectablePrototypesConfiguration.standard.label + newFormTemplates: + 100: + templatePath: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/Yaml/NewForms/BlankForm.yaml' + label: formManager.selectablePrototypesConfiguration.standard.newFormTemplates.blankForm.label + 200: + templatePath: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/Yaml/NewForms/SimpleContactForm.yaml' + label: formManager.selectablePrototypesConfiguration.standard.newFormTemplates.simpleContactForm.label + +:aspect:`Good to know` + - :ref:`"Start templates"<concepts-formmanager-starttemplate>` + - :ref:`Translate "Start template" options<concepts-formmanager-translation-starttemplate>` + +:aspect:`Description` + Array with numerical Keys. Configure the ``Start templates`` selectlist for this ``prototype`` within the ``form manager`` "Advanced settings" step. + + +.. _typo3.cms.form.formmanager.selectableprototypesconfiguration.*.newformtemplates.*.templatepath: + +selectablePrototypesConfiguration.*.newFormTemplates.*.templatePath +------------------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration.*.newFormTemplates.*.templatePath + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form manager) + +:aspect:`Mandatory` + Yes + +:aspect:`Good to know` + - :ref:`"Start templates"<concepts-formmanager-starttemplate>` + - :ref:`Translate "Start template" options<concepts-formmanager-translation-starttemplate>` + +:aspect:`Description` + The filesystem path to the `Start template`` yaml file. + + +.. _typo3.cms.form.formmanager.selectableprototypesconfiguration.*.newformtemplates.*.label: + +selectablePrototypesConfiguration.*.newFormTemplates.*.label +------------------------------------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration.*.newFormTemplates.*.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form manager) + +:aspect:`Mandatory` + Yes + +:aspect:`Good to know` + - :ref:`"Start templates"<concepts-formmanager-starttemplate>` + - :ref:`Translate "Start template" options<concepts-formmanager-translation-starttemplate>` + +:aspect:`Description` + The ``Start template`` selectlist label for this ``Start template`` within the ``form manager`` "Advanced settings" step. + + +.. _typo3.cms.form.formmanager.controller: + +controller +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.formManager.controller + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form manager) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + + controller: + deleteAction: + errorTitle: formManagerController.deleteAction.error.title + errorMessage: formManagerController.deleteAction.error.body + +:aspect:`Description` + Internal setting. Configure the ``form manager`` flash message texts. + + +.. _typo3.cms.form.formmanager.controller.deleteaction.errortitle: + +controller.deleteAction.errorTitle +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.formManager.controller.deleteAction.errorTitle + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form manager) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + controller: + deleteAction: + errorTitle: formManagerController.deleteAction.error.title + errorMessage: formManagerController.deleteAction.error.body + +:aspect:`Description` + Internal setting. Configure the ``form manager`` flash message texts. + + +.. _typo3.cms.form.formmanager.controller.deleteaction.errormessage: + +controller.deleteAction.errorMessage +------------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.formManager.controller.deleteAction.errorMessage + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form manager) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + controller: + deleteAction: + errorTitle: formManagerController.deleteAction.error.title + errorMessage: formManagerController.deleteAction.error.body + +:aspect:`Description` + Internal setting. Configure the ``form manager`` flash message texts. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/persistenceManager/Index.rst b/typo3/sysext/form/Documentation/ConfigurationReference/persistenceManager/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..f1cb928b514de8dfb6e0068747f082090fc1fe8a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/persistenceManager/Index.rst @@ -0,0 +1,146 @@ +.. include:: ../../Includes.txt + + +.. _typo3.cms.form.persistencemanager: + +==================== +[persistenceManager] +==================== + + +.. _typo3.cms.form.persistencemanager-properties: + +Properties +========== + +.. _typo3.cms.form.persistencemanager.allowedfilemounts: + +allowedFileMounts +----------------- + +:aspect:`Option path` + TYPO3.CMS.Form.persistenceManager.allowedFileMounts + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend/ Backend (form manager/ form editor/ plugin) + +:aspect:`Mandatory` + Yes (if :ref:`allowedExtensionPaths <TYPO3.CMS.Form.persistenceManager.allowedExtensionPaths>` is not set) + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + persistenceManager: + allowedFileMounts: + 10: '1:/user_upload/' + +:aspect:`Good to know` + :ref:`Form/ File storages<concepts-form-file-storages>` + +:aspect:`Description` + EXT:form stores the form definitions within the file system and thus needs + write access to this storage. By default, the filemount ``user_uploads`` is + used. It is possible to configure a different and/ or an additional + filemount which is then utilized for storing and reading forms. + + +.. _typo3.cms.form.persistencemanager.allowSaveToExtensionPaths: + +allowSaveToExtensionPaths +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.persistenceManager.allowSaveToExtensionPaths + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Backend (form manager) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + persistenceManager: + allowSaveToExtensionPaths: false + +:aspect:`Good to know` + :ref:`Form/ File storages<concepts-form-file-storages>` + +:aspect:`Description` + Set this to ``true`` if you want to allow backend users to **edit** forms stored within your own extension. + + +.. _typo3.cms.form.persistencemanager.allowDeleteFromExtensionPaths: + +allowDeleteFromExtensionPaths +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.persistenceManager.allowDeleteFromExtensionPaths + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Backend (form manager) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + persistenceManager: + allowDeleteFromExtensionPaths: false + +:aspect:`Good to know` + :ref:`Form/ File storages<concepts-form-file-storages>` + +:aspect:`Description` + Set this to ``true`` if you want to allow backend users to **delete** forms stored within your own extension. + + +.. _typo3.cms.form.persistencemanager.allowedExtensionPaths: + +allowedExtensionPaths +--------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.persistenceManager.allowedExtensionPaths + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend/ Backend (form manager/ form editor/ plugin) + +:aspect:`Mandatory` + Yes (if :ref:`allowedFileMounts <TYPO3.CMS.Form.persistenceManager.allowedFileMounts>` is not set) + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + :ref:`Form/ File storages<concepts-form-file-storages>` + +:aspect:`Description` + Define the paths to folders which contain forms within your own extension. + For example: + + .. code-block:: yaml + + allowedExtensionPaths: + 10: EXT:my_site_package/Resources/Private/Forms/ diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/Index.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..0804acdbac814305e002a0c7022029cc3c8ed261 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/Index.rst @@ -0,0 +1,95 @@ +.. include:: ../../Includes.txt + + +.. _typo3.cms.form.prototypes: + +============ +[prototypes] +============ + + +.. _typo3.cms.form.prototypes-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.*: + +prototypes +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend/ Backend (form manager/ form editor/ plugin) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + + prototypes: + standard: + [...] + +:aspect:`Good to know` + - :ref:`"Prototypes"<concepts-configuration-prototypes>` + - :ref:`"Form configuration vs. form definition"<concepts-formdefinition-vs-formconfiguration>` + +:aspect:`Description` + Array which defines the available prototypes. Every key within this array is called the ``<prototypeIdentifier>``. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>: + +<prototypeIdentifier> +--------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier> + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend/ Backend (form manager/ form editor/ plugin) + +:aspect:`Mandatory` + Yes + +:aspect:`Related options` + - :ref:`"TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration.*.identifier"<typo3.cms.form.formmanager.selectableprototypesconfiguration.*.identifier>` + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + prototypes: + standard: + [...] + +:aspect:`Good to know` + - :ref:`"Prototypes"<concepts-configuration-prototypes>` + - :ref:`"Form configuration vs. form definition"<concepts-formdefinition-vs-formconfiguration>` + +:aspect:`Description` + This array key identifies the `prototype``. Every ``form definition`` references to such a ``<prototypeIdentifier>`` through the property ``prototypeName``. + + +Subproperties +============= + +.. toctree:: + + formElementsDefinition/Index + finishersDefinition/Index + validatorsDefinition/Index + formEditor/Index + formEngine/Index diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/Index.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..a2e99eed5ecb38f0d3f37861ff2aba38857c31b2 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/Index.rst @@ -0,0 +1,395 @@ +.. include:: ../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition: + +===================== +[finishersDefinition] +===================== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.*: + +[finishersDefinition] +--------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + + prototypes: + <prototypeIdentifier>: + finishersDefinition: + [...] + +:aspect:`Good to know` + - :ref:`"Custom finisher implementations"<concepts-frontendrendering-codecomponents-customfinisherimplementations>` + +:aspect:`Description` + Array which defines the available finishers. Every key within this array is called the ``<finisherIdentifier>``. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.<finisheridentifier>: + +<finisherIdentifier> +-------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisherIdentifier> + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + + prototypes: + standard: + Closure: + [...] + Confirmation: + [...] + EmailToSender: + [...] + EmailToReceiver: + [...] + DeleteUploads: + [...] + FlashMessage: + [...] + Redirect: + [...] + SaveToDatabase: + [...] + +:aspect:`Related options` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.\<formElementTypeIdentifier>.formEditor.propertyCollections.finishers.[*].identifier"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.propertycollections.finishers.*.identifier>` + - :ref:`"[FinishersEditor] selectOptions.[*].value"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.selectoptions.*.value-finisherseditor>` + +:aspect:`Good to know` + - :ref:`"Custom finisher implementations"<concepts-frontendrendering-codecomponents-customfinisherimplementations>` + +:aspect:`Description` + This array key identifies a finisher. This identifier could be used to attach a finisher to a form. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.<finisheridentifier>-commonproperties: + +Common <finisherIdentifier> properties +============================================= + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.implementationClassName: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + Depends (see :ref:`concrete finishers configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Custom finisher implementations"<concepts-frontendrendering-codecomponents-customfinisherimplementations>` + +:aspect:`Description` + .. include:: properties/implementationClassName.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.options: + +options +------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.options + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Depends (see :ref:`concrete finishers configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>-concreteconfigurations>`) + +:aspect:`Default value` + Depends (see :ref:`concrete finishers configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Custom finisher implementations"<concepts-frontendrendering-codecomponents-customfinisherimplementations>` + +:aspect:`Description` + Array with finisher options. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.translation.translationFile: + +translation.translationFile +--------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.translation.translationFile + +:aspect:`Data type` + string/ array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>` + +:aspect:`Description` + Filesystem path(s) to translation files which should be searched for finisher translations. + If the property is undefined, - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.translation.translationFile"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.translation.translationfile>` will be used. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.formeditor: + +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value` + Depends (see :ref:`concrete finishers configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>-concreteconfigurations>`) + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Array with configurations for the ``form editor`` + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + Depends (see :ref:`concrete finishers configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>-concreteconfigurations>`) + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + Depends (see :ref:`concrete finishers configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: properties/label.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.formeditor.predefineddefaults: + +formeditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + Depends (see :ref:`concrete finishers configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>-concreteconfigurations>`) + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: properties/predefinedDefaults.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.formengine: + +FormEngine +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.FormEngine + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (plugin) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + Depends (see :ref:`concrete finishers configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>-concreteconfigurations>`) + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Array with configurations for the ``form plugin`` + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.FormEngine.label: + +FormEngine.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.FormEngine.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (plugin) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + Depends (see :ref:`concrete finishers configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>` + +:aspect:`Description` + .. include:: properties/formEngine/label.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.FormEngine.elements: + +FormEngine.elements +------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.FormEngine.elements + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (plugin) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + Depends (see :ref:`concrete finishers configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>` + +:aspect:`Description` + .. include:: properties/formEngine/elements.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.<finisheridentifier>-concreteconfigurations: + +Concrete configurations +======================= + +.. toctree:: + + finishers/Closure + finishers/Confirmation + finishers/EmailToReceiver + finishers/EmailToSender + finishers/DeleteUploads + finishers/FlashMessage + finishers/Redirect + finishers/SaveToDatabase diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/Closure.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/Closure.rst new file mode 100644 index 0000000000000000000000000000000000000000..768452cccf58b56f3b92deee7f914e0c5f4fc279 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/Closure.rst @@ -0,0 +1,186 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.closure: + +========= +[Closure] +========= + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinitionclosure-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.closure.implementationclassname: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Closure.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + Closure: + implementationClassName: TYPO3\CMS\Form\Domain\Finishers\ClosureFinisher + +:aspect:`Good to know` + - :ref:`"Custom finisher implementations"<concepts-frontendrendering-codecomponents-customfinisherimplementations>` + +:aspect:`Description` + .. include:: ../properties/implementationClassName.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.closure.options.closure: + +options.closure +--------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Closure.options.closure + +:aspect:`Data type` + \Closure + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + null + +.. :aspect:`Good to know` + ToDo + - :ref:`"Closure finisher"<apireference-finisheroptions-closurefinisher>` + - :ref:`"Custom finisher implementations"<concepts-frontendrendering-codecomponents-customfinisherimplementations>` + +:aspect:`Description` + The closure which are invoked if the finisher is treggered. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.closure.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Closure.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Closure: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.Closure.editor.header.label + predefinedDefaults: + options: + closure: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.closure.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Closure.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + Closure: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.Closure.editor.header.label + predefinedDefaults: + options: + closure: '' + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: ../properties/label.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.closure.formeditor.predefineddefaults: + +formeditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Closure.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Closure: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.Closure.editor.header.label + predefinedDefaults: + options: + closure: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/predefinedDefaults.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/Confirmation.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/Confirmation.rst new file mode 100644 index 0000000000000000000000000000000000000000..f9f94f34bad5d9fd24faedc2eeb0efc1e3facb59 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/Confirmation.rst @@ -0,0 +1,217 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.confirmation: + +============== +[Confirmation] +============== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinitionconfirmation-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.confirmation.implementationclassname: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Confirmation.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + Confirmation: + implementationClassName: TYPO3\CMS\Form\Domain\Finishers\ConfirmationFinisher + +:aspect:`Good to know` + - :ref:`"Custom finisher implementations"<concepts-frontendrendering-codecomponents-customfinisherimplementations>` + +:aspect:`Description` + .. include:: ../properties/implementationClassName.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.confirmation.options.message: + +options.message +--------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Confirmation.options.message + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + The form has been submitted. + +:aspect:`Good to know` + - :ref:`"Confirmation finisher"<apireference-finisheroptions-confirmationfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + - :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>` + +:aspect:`Description` + The text which is shown if the finisher is invoked. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.confirmation.options.translation.translationfile: + +options.translation.translationFile +----------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Confirmation.options.translation.translationFile + +:aspect:`Data type` + string/ array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Confirmation finisher"<apireference-finisheroptions-confirmationfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + - :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>` + +:aspect:`Description` + If set, this translation file(s) will be used for finisher option translations. + If not set, the translation file(s) from the 'Form' element will be used. + Read :ref:`Translate finisher options<concepts-frontendrendering-translation-finishers>` for more informations. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.confirmation.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Confirmation.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Confirmation: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.Confirmation.editor.header.label + predefinedDefaults: + options: + message: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.confirmation.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Confirmation.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + Confirmation: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.Confirmation.editor.header.label + predefinedDefaults: + options: + message: '' + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: ../properties/label.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.confirmation.formeditor.predefineddefaults: + +formeditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Confirmation.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Confirmation: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.Confirmation.editor.header.label + predefinedDefaults: + options: + message: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/predefinedDefaults.rst + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/DeleteUploads.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/DeleteUploads.rst new file mode 100644 index 0000000000000000000000000000000000000000..eabb81fc6b1fe03b466696ed5d1aae5b77cf4907 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/DeleteUploads.rst @@ -0,0 +1,114 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.deleteuploads: + +=============== +[DeleteUploads] +=============== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinitiondeleteuploads-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.deleteuploads.implementationclassname: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.DeleteUploads.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + DeleteUploads: + implementationClassName: TYPO3\CMS\Form\Domain\Finishers\DeleteUploadsFinisher + +:aspect:`Good to know` + - :ref:`"Custom finisher implementations"<concepts-frontendrendering-codecomponents-customfinisherimplementations>` + +:aspect:`Description` + Array which defines the available finishers. Every key within this array is called the ``<finisherIdentifier>`` + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.deleteuploads.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.DeleteUploads.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + DeleteUploads: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.DeleteUploads.editor.header.label + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.deleteuploads.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.DeleteUploads.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + DeleteUploads: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.DeleteUploads.editor.header.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: ../properties/label.rst + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/EmailToReceiver.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/EmailToReceiver.rst new file mode 100644 index 0000000000000000000000000000000000000000..52205d0e0c9689c6b4bdc03706a6bcb127bce05f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/EmailToReceiver.rst @@ -0,0 +1,788 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.emailtoreceiver: + +================= +[EmailToReceiver] +================= + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinitionemailtoreceiver-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.implementationclassname: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + EmailToReceiver: + implementationClassName: TYPO3\CMS\Form\Domain\Finishers\EmailFinisher + +:aspect:`Good to know` + - :ref:`"Custom finisher implementations"<concepts-frontendrendering-codecomponents-customfinisherimplementations>` + +:aspect:`Description` + .. include:: ../properties/implementationClassName.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.subject: + +options.subject +--------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.subject + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + - :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>` + +:aspect:`Description` + Subject of the email. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.recipientaddress: + +options.recipientAddress +------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.recipientAddress + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Email address of the recipient (To). + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.recipientname: + +options.recipientName +--------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.recipientName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + empty string + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Human-readable name of the recipient. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.senderaddress: + +options.senderAddress +--------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.senderAddress + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Email address of the sender/ visitor (From). + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.sendername: + +options.senderName +------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.senderName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + empty string + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Human-readable name of the sender. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.replytoaddress: + +options.replyToAddress +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.replyToAddress + +:aspect:`Data type` + string/ array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Email address of to be used as reply-to email (use multiple addresses with an array). + +.. note:: + For the moment, the ``form editor`` cannot deal with multiple reply-to addresses (use multiple addresses with an array) + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.carboncopyaddress: + +options.carbonCopyAddress +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.carbonCopyAddress + +:aspect:`Data type` + string/ array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Email address of the copy recipient (use multiple addresses with an array) + +.. note:: + For the moment, the ``form editor`` cannot deal with multiple copy recipient addresses (use multiple addresses with an array) + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.blindcarboncopyaddress: + +options.blindCarbonCopyAddress +------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.blindCarbonCopyAddress + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Email address of the blind copy recipient (use multiple addresses with an array) + +.. note:: + For the moment, the ``form editor`` cannot deal with multiple blind copy recipient addresses (use multiple addresses with an array) + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.format: + +options.format +-------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.format + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + html + +:aspect:`Possible values` + html/ plaintext + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + The format of the email. By default mails are sent as HTML. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.attachuploads: + +options.attachUploads +--------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.attachUploads + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + true + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + If set, all uploaded items are attached to the email. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.translation.language: + +options.translation.language +---------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.translation.language + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + - :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>` + +:aspect:`Description` + If not set, the finisher options are translated depending on the current frontend language (if translations exists). + This option allows you to force translations for a given sys_language isocode, e.g 'dk' or 'de'. + Read :ref:`Translate finisher options<concepts-frontendrendering-translation-finishers>` for more informations. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.translation.translationfile: + +options.translation.translationFile +----------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.translation.translationFile + +:aspect:`Data type` + string/ array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + - :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>` + +:aspect:`Description` + If set, this translation file(s) will be used for finisher option translations. + If not set, the translation file(s) from the 'Form' element will be used. + Read :ref:`Translate finisher options<concepts-frontendrendering-translation-finishers>` for more informations. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.templatepathandfilename: + +options.templatePathAndFilename +------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.templatePathAndFilename + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + EmailToReceiver: + options: + templatePathAndFilename: 'EXT:form/Resources/Private/Frontend/Templates/Finishers/Email/{@format}.html' + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + +:aspect:`Description` + Template path and filename for the mail body. + The placeholder {\@format} will be replaced with the value from option ``format``. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.partialrootpaths: + +options.partialRootPaths +------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.partialRootPaths + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + +:aspect:`Description` + Fluid layout paths. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.layoutrootpaths: + +options.layoutRootPaths +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.layoutRootPaths + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + +:aspect:`Description` + Fluid partial paths. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.variables: + +options.variables +----------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.variables + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + +:aspect:`Description` + Associative array of variables which are available inside the Fluid template. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + EmailToReceiver: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.header.label + predefinedDefaults: + options: + subject: '' + recipientAddress: '' + recipientName: '' + senderAddress: '' + senderName: '' + replyToAddress: '' + carbonCopyAddress: '' + blindCarbonCopyAddress: '' + format: html + attachUploads: true + translation: + language: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + EmailToReceiver: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.header.label + predefinedDefaults: + options: + subject: '' + recipientAddress: '' + recipientName: '' + senderAddress: '' + senderName: '' + replyToAddress: '' + carbonCopyAddress: '' + blindCarbonCopyAddress: '' + format: html + attachUploads: true + translation: + language: '' + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: ../properties/label.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.formeditor.predefineddefaults: + +formeditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + EmailToReceiver: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.header.label + predefinedDefaults: + options: + subject: '' + recipientAddress: '' + recipientName: '' + senderAddress: '' + senderName: '' + replyToAddress: '' + carbonCopyAddress: '' + blindCarbonCopyAddress: '' + format: html + attachUploads: true + translation: + language: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/predefinedDefaults.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.formengine.label: + +FormEngine.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.FormEngine.label + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (plugin) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + EmailToReceiver: + FormEngine: + label: tt_content.finishersDefinition.EmailToReceiver.label + +:aspect:`Good to know` + - :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>` + +:aspect:`Description` + .. include:: ../properties/formEngine/label.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.formengine.elements: + +FormEngine.elements +------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.FormEngine.elements + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (plugin) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + EmailToReceiver: + FormEngine: + label: tt_content.finishersDefinition.EmailToReceiver.label + elements: + subject: + label: tt_content.finishersDefinition.EmailToReceiver.subject.label + config: + type: input + recipientAddress: + label: tt_content.finishersDefinition.EmailToReceiver.recipientAddress.label + config: + type: input + eval: required + recipientName: + label: tt_content.finishersDefinition.EmailToReceiver.recipientName.label + config: + type: input + senderAddress: + label: tt_content.finishersDefinition.EmailToReceiver.senderAddress.label + config: + type: input + eval: required + senderName: + label: tt_content.finishersDefinition.EmailToReceiver.senderName.label + config: + type: input + replyToAddress: + label: tt_content.finishersDefinition.EmailToReceiver.replyToAddress.label + config: + type: input + carbonCopyAddress: + label: tt_content.finishersDefinition.EmailToReceiver.carbonCopyAddress.label + config: + type: input + blindCarbonCopyAddress: + label: tt_content.finishersDefinition.EmailToReceiver.blindCarbonCopyAddress.label + config: + type: input + format: + label: tt_content.finishersDefinition.EmailToReceiver.format.label + config: + type: select + renderType: selectSingle + minitems: 1 + maxitems: 1 + size: 1 + items: + 10: + - tt_content.finishersDefinition.EmailToSender.format.1 + - html + 20: + - tt_content.finishersDefinition.EmailToSender.format.2 + - plaintext + translation: + language: + label: tt_content.finishersDefinition.EmailToReceiver.language.label + config: + type: select + renderType: selectSingle + minitems: 1 + maxitems: 1 + size: 1 + items: + 10: + - tt_content.finishersDefinition.EmailToReceiver.language.1 + - default + +:aspect:`Good to know` + - :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>` + +:aspect:`Description` + .. include:: ../properties/formEngine/elements.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/EmailToSender.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/EmailToSender.rst new file mode 100644 index 0000000000000000000000000000000000000000..1eccf63e96990d3295ebc459a09409ac3c22f5f2 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/EmailToSender.rst @@ -0,0 +1,788 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.emailtosender: + +================= +[EmailToSender] +================= + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinitionemailtosender-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.implementationclassname: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + EmailToSender: + implementationClassName: TYPO3\CMS\Form\Domain\Finishers\EmailFinisher + +:aspect:`Good to know` + - :ref:`"Custom finisher implementations"<concepts-frontendrendering-codecomponents-customfinisherimplementations>` + +:aspect:`Description` + .. include:: ../properties/implementationClassName.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.subject: + +options.subject +--------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.subject + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + - :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>` + +:aspect:`Description` + Subject of the email. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.recipientaddress: + +options.recipientAddress +------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.recipientAddress + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Email address of the recipient (To). + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.recipientname: + +options.recipientName +--------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.recipientName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + empty string + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Human-readable name of the recipient. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.senderaddress: + +options.senderAddress +--------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.senderAddress + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Email address of the sender/ visitor (From). + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.sendername: + +options.senderName +------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.senderName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + empty string + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Human-readable name of the sender. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.replytoaddress: + +options.replyToAddress +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.replyToAddress + +:aspect:`Data type` + string/ array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Email address of to be used as reply-to email (use multiple addresses with an array). + +.. note:: + For the moment, the ``form editor`` cannot deal with multiple reply-to addresses (use multiple addresses with an array) + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.carboncopyaddress: + +options.carbonCopyAddress +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.carbonCopyAddress + +:aspect:`Data type` + string/ array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Email address of the copy recipient (use multiple addresses with an array) + +.. note:: + For the moment, the ``form editor`` cannot deal with multiple copy recipient addresses (use multiple addresses with an array) + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.blindcarboncopyaddress: + +options.blindCarbonCopyAddress +------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.blindCarbonCopyAddress + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Email address of the blind copy recipient (use multiple addresses with an array) + +.. note:: + For the moment, the ``form editor`` cannot deal with multiple blind copy recipient addresses (use multiple addresses with an array) + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.format: + +options.format +-------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.format + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + html + +:aspect:`Possible values` + html/ plaintext + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + The format of the email. By default mails are sent as HTML. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.attachuploads: + +options.attachUploads +--------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.attachUploads + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + true + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + If set, all uploaded items are attached to the email. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.translation.language: + +options.translation.language +---------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.translation.language + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + - :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>` + +:aspect:`Description` + If not set, the finisher options are translated depending on the current frontend language (if translations exists). + This option allows you to force translations for a given sys_language isocode, e.g 'dk' or 'de'. + Read :ref:`Translate finisher options<concepts-frontendrendering-translation-finishers>` for more informations. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.translation.translationfile: + +options.translation.translationFile +----------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.translation.translationFile + +:aspect:`Data type` + string/ array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + - :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>` + +:aspect:`Description` + If set, this translation file(s) will be used for finisher option translations. + If not set, the translation file(s) from the 'Form' element will be used. + Read :ref:`Translate finisher options<concepts-frontendrendering-translation-finishers>` for more informations. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.templatepathandfilename: + +options.templatePathAndFilename +------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.templatePathAndFilename + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + EmailToSender: + options: + templatePathAndFilename: 'EXT:form/Resources/Private/Frontend/Templates/Finishers/Email/{@format}.html' + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + +:aspect:`Description` + Template path and filename for the mail body. + The placeholder {\@format} will be replaced with the value from option ``format``. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.partialrootpaths: + +options.partialRootPaths +------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.partialRootPaths + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + +:aspect:`Description` + Fluid layout paths. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.layoutrootpaths: + +options.layoutRootPaths +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.layoutRootPaths + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + +:aspect:`Description` + Fluid partial paths. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.variables: + +options.variables +----------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.variables + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` + +:aspect:`Description` + Associative array of variables which are available inside the Fluid template. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + EmailToSender: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.EmailToSender.editor.header.label + predefinedDefaults: + options: + subject: '' + recipientAddress: '' + recipientName: '' + senderAddress: '' + senderName: '' + replyToAddress: '' + carbonCopyAddress: '' + blindCarbonCopyAddress: '' + format: html + attachUploads: true + translation: + language: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + EmailToSender: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.EmailToSender.editor.header.label + predefinedDefaults: + options: + subject: '' + recipientAddress: '' + recipientName: '' + senderAddress: '' + senderName: '' + replyToAddress: '' + carbonCopyAddress: '' + blindCarbonCopyAddress: '' + format: html + attachUploads: true + translation: + language: '' + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: ../properties/label.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.formeditor.predefineddefaults: + +formeditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + EmailToSender: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.EmailToSender.editor.header.label + predefinedDefaults: + options: + subject: '' + recipientAddress: '' + recipientName: '' + senderAddress: '' + senderName: '' + replyToAddress: '' + carbonCopyAddress: '' + blindCarbonCopyAddress: '' + format: html + attachUploads: true + translation: + language: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/predefinedDefaults.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.formengine.label: + +FormEngine.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.FormEngine.label + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (plugin) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + EmailToSender: + FormEngine: + label: tt_content.finishersDefinition.EmailToSender.label + +:aspect:`Good to know` + - :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>` + +:aspect:`Description` + .. include:: ../properties/formEngine/label.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.formengine.elements: + +FormEngine.elements +------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.FormEngine.elements + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (plugin) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + EmailToSender: + FormEngine: + label: tt_content.finishersDefinition.EmailToSender.label + elements: + subject: + label: tt_content.finishersDefinition.EmailToSender.subject.label + config: + type: input + recipientAddress: + label: tt_content.finishersDefinition.EmailToSender.recipientAddress.label + config: + type: input + eval: required + recipientName: + label: tt_content.finishersDefinition.EmailToSender.recipientName.label + config: + type: input + senderAddress: + label: tt_content.finishersDefinition.EmailToSender.senderAddress.label + config: + type: input + eval: required + senderName: + label: tt_content.finishersDefinition.EmailToSender.senderName.label + config: + type: input + replyToAddress: + label: tt_content.finishersDefinition.EmailToSender.replyToAddress.label + config: + type: input + carbonCopyAddress: + label: tt_content.finishersDefinition.EmailToSender.carbonCopyAddress.label + config: + type: input + blindCarbonCopyAddress: + label: tt_content.finishersDefinition.EmailToSender.blindCarbonCopyAddress.label + config: + type: input + format: + label: tt_content.finishersDefinition.EmailToSender.format.label + config: + type: select + renderType: selectSingle + minitems: 1 + maxitems: 1 + size: 1 + items: + 10: + - tt_content.finishersDefinition.EmailToSender.format.1 + - html + 20: + - tt_content.finishersDefinition.EmailToSender.format.2 + - plaintext + translation: + language: + label: tt_content.finishersDefinition.EmailToSender.language.label + config: + type: select + renderType: selectSingle + minitems: 1 + maxitems: 1 + size: 1 + items: + 10: + - tt_content.finishersDefinition.EmailToSender.language.1 + - default + +:aspect:`Good to know` + - :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>` + +:aspect:`Description` + .. include:: ../properties/formEngine/elements.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/FlashMessage.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/FlashMessage.rst new file mode 100644 index 0000000000000000000000000000000000000000..c4d5912996036c604e19e4508be7e4d493b8343d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/FlashMessage.rst @@ -0,0 +1,341 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.flashmessage: + +============== +[FlashMessage] +============== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinitionflashmessage-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.implementationclassname: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + FlashMessage: + implementationClassName: TYPO3\CMS\Form\Domain\Finishers\FlashMessageFinisher + +:aspect:`Good to know` + - :ref:`"Custom finisher implementations"<concepts-frontendrendering-codecomponents-customfinisherimplementations>` + +:aspect:`Description` + .. include:: ../properties/implementationClassName.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.options.messagebody: + +options.messageBody +------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.options.messageBody + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + null + +:aspect:`Good to know` + - :ref:`"FlashMessage finisher"<apireference-finisheroptions-flashmessagefinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + - :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>` + +:aspect:`Description` + The flash message body TEXT. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.options.messagetitle: + +options.messageTitle +-------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.options.messageTitle + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + empty string + +:aspect:`Good to know` + - :ref:`"FlashMessage finisher"<apireference-finisheroptions-flashmessagefinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + - :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>` + +:aspect:`Description` + The flash message title. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.options.messagearguments: + +options.messageArguments +------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.options.messageArguments + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + empty array + +:aspect:`Good to know` + - :ref:`"FlashMessage finisher"<apireference-finisheroptions-flashmessagefinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + - :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>` + +:aspect:`Description` + The flash message arguments, if needed. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.options.messagecode: + +options.messageCode +------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.options.messageCode + +:aspect:`Data type` + int + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + null + +:aspect:`Good to know` + - :ref:`"FlashMessage finisher"<apireference-finisheroptions-flashmessagefinisher>` + +:aspect:`Description` + The flash message code, if needed. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.options.severity: + +options.severity +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.options.severity + +:aspect:`Data type` + int + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + \TYPO3\CMS\Core\Messaging\AbstractMessage::OK (0) + +:aspect:`Good to know` + - :ref:`"FlashMessage finisher"<apireference-finisheroptions-flashmessagefinisher>` + +:aspect:`Description` + The flash message severity code. + See \TYPO3\CMS\Core\Messaging\AbstractMessage constants for the codes. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.options.translation.translationfile: + +options.translation.translationFile +----------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.options.translation.translationFile + +:aspect:`Data type` + string/ array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"FlashMessage finisher"<apireference-finisheroptions-flashmessagefinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + - :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>` + +:aspect:`Description` + If set, this translation file(s) will be used for finisher option translations. + If not set, the translation file(s) from the 'Form' element will be used. + Read :ref:`Translate finisher options<concepts-frontendrendering-translation-finishers>` for more informations. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + FlashMessage: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.FlashMessage.editor.header.label + predefinedDefaults: + options: + messageBody: '' + messageTitle: '' + messageArguments: '' + messageCode: 0 + severity: 0 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + FlashMessage: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.FlashMessage.editor.header.label + predefinedDefaults: + options: + messageBody: '' + messageTitle: '' + messageArguments: '' + messageCode: 0 + severity: 0 + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: ../properties/label.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.formeditor.predefineddefaults: + +formeditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + FlashMessage: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.FlashMessage.editor.header.label + predefinedDefaults: + options: + messageBody: '' + messageTitle: '' + messageArguments: '' + messageCode: 0 + severity: 0 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/predefinedDefaults.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/Redirect.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/Redirect.rst new file mode 100644 index 0000000000000000000000000000000000000000..7571afd72d5f354a9140ff3900fbef8295094f7d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/Redirect.rst @@ -0,0 +1,386 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.redirect: + +========== +[Redirect] +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinitionredirect-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.redirect.implementationclassname: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + Redirect: + implementationClassName: TYPO3\CMS\Form\Domain\Finishers\RedirectFinisher + +:aspect:`Good to know` + - :ref:`"Custom finisher implementations"<concepts-frontendrendering-codecomponents-customfinisherimplementations>` + +:aspect:`Description` + .. include:: ../properties/implementationClassName.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.redirect.options.pageuid: + +options.pageUid +--------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.options.pageUid + +:aspect:`Data type` + int + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + 1 + +:aspect:`Good to know` + - :ref:`"Redirect finisher"<apireference-finisheroptions-redirectfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Redirect to this page uid. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.redirect.options.additionalparameters: + +options.additionalParameters +---------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.options.additionalParameters + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + empty string + +:aspect:`Good to know` + - :ref:`"Redirect finisher"<apireference-finisheroptions-redirectfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Additional parameters which should be used on the target page. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.redirect.options.delay: + +options.delay +------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.options.delay + +:aspect:`Data type` + int + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + 0 + +:aspect:`Good to know` + - :ref:`"Redirect finisher"<apireference-finisheroptions-redirectfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + The redirect delay in seconds. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.redirect.options.statuscode: + +options.statusCode +------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.options.statusCode + +:aspect:`Data type` + int + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + 303 + +:aspect:`Good to know` + - :ref:`"Redirect finisher"<apireference-finisheroptions-redirectfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + The HTTP status code for the redirect. Default is "303 See Other". + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.redirect.options.translation.translationfile: + +options.translation.translationFile +----------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.options.translation.translationFile + +:aspect:`Data type` + string/ array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Redirect finisher"<apireference-finisheroptions-redirectfinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + - :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>` + +:aspect:`Description` + If set, this translation file(s) will be used for finisher option translations. + If not set, the translation file(s) from the 'Form' element will be used. + Read :ref:`Translate finisher options<concepts-frontendrendering-translation-finishers>` for more informations. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.redirect.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Redirect: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.Redirect.editor.header.label + predefinedDefaults: + options: + pageUid: '' + additionalParameters: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.redirect.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + Redirect: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.Redirect.editor.header.label + predefinedDefaults: + options: + pageUid: '' + additionalParameters: '' + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: ../properties/label.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.redirect.formeditor.predefineddefaults: + +formeditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Redirect: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.Redirect.editor.header.label + predefinedDefaults: + options: + pageUid: '' + additionalParameters: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/predefinedDefaults.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.redirect.formengine.label: + +FormEngine.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.FormEngine.label + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (plugin) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Redirect: + FormEngine: + label: tt_content.finishersDefinition.Redirect.label + +:aspect:`Good to know` + - :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>` + +:aspect:`Description` + .. include:: ../properties/formEngine/label.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.redirect.formengine.elements: + +FormEngine.elements +------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.FormEngine.elements + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (plugin) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Redirect: + FormEngine: + label: tt_content.finishersDefinition.Redirect.label + elements: + pageUid: + label: tt_content.finishersDefinition.Redirect.pageUid.label + config: + type: group + internal_type: db + allowed: pages + size: 1 + minitems: 1 + maxitems: 1 + fieldWizard: + recordOverview: + disabled: 1 + additionalParameters: + label: tt_content.finishersDefinition.Redirect.additionalParameters.label + config: + type: input + +:aspect:`Good to know` + - :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>` + +:aspect:`Description` + .. include:: ../properties/formEngine/elements.rst + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/SaveToDatabase.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/SaveToDatabase.rst new file mode 100644 index 0000000000000000000000000000000000000000..d1163c79b5964cd5e5c32f6c5fb794576133de9d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/finishers/SaveToDatabase.rst @@ -0,0 +1,489 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.savetodatabase: + +================ +[SaveToDatabase] +================ + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinitionsavetodatabase-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.implementationclassname: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + SaveToDatabase: + implementationClassName: TYPO3\CMS\Form\Domain\Finishers\SaveToDatabaseFinisher + +:aspect:`Good to know` + - :ref:`"Custom finisher implementations"<concepts-frontendrendering-codecomponents-customfinisherimplementations>` + +:aspect:`Description` + .. include:: ../properties/implementationClassName.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.table: + +options.table +------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.table + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + null + +:aspect:`Good to know` + - :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Insert or update values into this table. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.mode: + +options.mode +------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.mode + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + 'insert' + +:aspect:`Possible values` + insert/ update + +:aspect:`Good to know` + - :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + ``insert`` will create a new database row with the values from the submitted form and/or some predefined values. @see options.elements and options.databaseFieldMappings + + ``update`` will update a given database row with the values from the submitted form and/or some predefined values. 'options.whereClause' is then required. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.whereclause: + +options.whereClause +------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.whereClause + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes, if mode = update + +:aspect:`Default value` + empty array + +:aspect:`Good to know` + - :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + This where clause will be used for a database update action. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.elements: + +options.elements +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.elements + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + empty array + +:aspect:`Good to know` + - :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Use ``options.elements`` to map form element values to existing database columns. + Each key within ``options.elements`` has to match with a form element identifier. + The value for each key within ``options.elements`` is an array with additional informations. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.elements.<formelementidentifier>.mapondatabasecolumn: + +options.elements.<formElementIdentifier>.mapOnDatabaseColumn +------------------------------------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.elements.<formElementIdentifier>.mapOnDatabaseColumn + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + The value from the submitted form element with the identifier ``<formElementIdentifier>`` will be written into this database column. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.elements.<formelementidentifier>.mapondatabasecolumn.savefileidentifierinsteadofuid: + +options.elements.<formElementIdentifier>.mapOnDatabaseColumn.saveFileIdentifierInsteadOfUid +------------------------------------------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.elements.<formElementIdentifier>.mapOnDatabaseColumn.saveFileIdentifierInsteadOfUid + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + false + +:aspect:`Good to know` + - :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Set this to true if the database column should not be written if the value from the submitted form element with the identifier + ``<formElementIdentifier>`` is empty (think about password fields etc.) + + This setting only rules for form elements which creates a FAL object like ``FileUpload`` or ``ImageUpload``. + By default, the uid of the FAL object will be written into the database column. Set this to true if you want to store the + FAL identifier (1:/user_uploads/some_uploaded_pic.jpg) instead. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.elements.<formelementidentifier>.mapondatabasecolumn.skipifvalueisempty: + +options.elements.<formElementIdentifier>.mapOnDatabaseColumn.skipIfValueIsEmpty +------------------------------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.elements.<formElementIdentifier>.mapOnDatabaseColumn.skipIfValueIsEmpty + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + false + +:aspect:`Good to know` + - :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Set this to true if the database column should not be written if the value from the submitted form element with the identifier + ``<formElementIdentifier>`` is empty (think about password fields etc.) + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.databasecolumnmappings: + +options.databaseColumnMappings +------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.databaseColumnMappings + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + empty array + +:aspect:`Good to know` + - :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Use this to map database columns to static values. + Each key within ``options.databaseColumnMappings`` has to match with an existing database column. + The value for each key within ``options.databaseColumnMappings`` is an array with additional informations. + + This mapping is done *before* the ``options.element`` mapping. + This means if you map a database column to a value through ``options.databaseColumnMappings`` and map a submitted + form element value to the same database column through ``options.element``, the submitted form element value + will override the value you set within ``options.databaseColumnMappings``. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.databasecolumnmappings.<databasecolumnname>.value: + +options.databaseColumnMappings.<databaseColumnName>.value +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.databaseColumnMappings.<databaseColumnName>.value + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + The value which will be written to the database column. + You can also use the :ref:`FormRuntime accessor feature<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` to access every getable property from the ``FormRuntime`` + In short: use something like ``{<formElementIdentifier>}`` to get the value from the submitted form element with the identifier ``<formElementIdentifier>``. + + If you use the FormRuntime accessor feature within ``options.databaseColumnMappings``, than the functionality is nearly equal + to the the ``options.elements`` configuration variant. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.databasecolumnmappings.<databasecolumnname>.skipifvalueisempty: + +options.databaseColumnMappings.<databaseColumnName>.skipIfValueIsEmpty +---------------------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.databaseColumnMappings.<databaseColumnName>.skipIfValueIsEmpty + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + +:aspect:`Description` + Set this to true if the database column should not be written if the value from ``options.databaseColumnMappings.<databaseColumnName>.value`` is empty. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.translation.translationfile: + +options.translation.translationFile +----------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.translation.translationFile + +:aspect:`Data type` + string/ array + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + No + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>` + - :ref:`"Accessing form runtime values"<concepts-frontendrendering-codecomponents-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + - :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>` + +:aspect:`Description` + If set, this translation file(s) will be used for finisher option translations. + If not set, the translation file(s) from the 'Form' element will be used. + Read :ref:`Translate finisher options<concepts-frontendrendering-translation-finishers>` for more informations. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + SaveToDatabase: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.SaveToDatabase.editor.header.label + predefinedDefaults: + options: { } + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + SaveToDatabase: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.SaveToDatabase.editor.header.label + predefinedDefaults: + options: { } + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: ../properties/label.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.formeditor.predefineddefaults: + +formeditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + SaveToDatabase: + formEditor: + iconIdentifier: t3-form-icon-finisher + label: formEditor.elements.Form.finisher.SaveToDatabase.editor.header.label + predefinedDefaults: + options: { } + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/predefinedDefaults.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/properties/formEngine/elements.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/properties/formEngine/elements.rst new file mode 100644 index 0000000000000000000000000000000000000000..3d58e7f965fbb262f872a1ffdab98c6a587ba1bf --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/properties/formEngine/elements.rst @@ -0,0 +1,4 @@ +Every array key must match to the related finisher option name. +For example, the - :ref:`"[Redirect] finisher"<typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.redirect>` has the option - :ref:`"pageUid"<typo3.cms.form.prototypes.\<prototypeIdentifier>.finishersdefinition.redirect.options.pageuid>`. +If you want to make the ``pageUid`` overwritable within the ``form plugin``, then an array key ``pageUid`` has to exists within ``TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.FormEngine.elements``. +The configuration within ``TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.FormEngine.elements.pageUid`` must follow the TCA syntax. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/properties/formEngine/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/properties/formEngine/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..000474d80fb6f1eb7a73d169a4697a34636401dc --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/properties/formEngine/label.rst @@ -0,0 +1,3 @@ +Finisher options are overwritable within the ``form plugin``. +If the "Override finisher settings" checkbox is selected within the ``form plugin``, every finisher who has a - :ref:`"FormEngine"<typo3.cms.form.prototypes.\<prototypeIdentifier>.finishersdefinition.\<finisheridentifier>.formengine>` configuration, is shown in a seperate tab. +``label`` is the label for such a tab. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/properties/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/properties/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..a4de2a003b4fb0925d5b0cc42084bcd86f536566 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/properties/iconIdentifier.rst @@ -0,0 +1,2 @@ +An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. +This icon will be shown within the - :ref:`"Inspector [CollectionElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` if the finisher is selected. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/properties/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/properties/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..aa74df744ba8c4497064b9ad1e10b13623dd9ec5 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/properties/implementationClassName.rst @@ -0,0 +1 @@ +Classname which implements the finisher. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/properties/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/properties/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..f144f610c858f86b74ea19520fc2f1a41399c679 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/properties/label.rst @@ -0,0 +1 @@ +This label will be shown within the - :ref:`"Inspector [CollectionElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` if the finisher is selected. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/properties/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/properties/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..0a7f05300d0e6f86f9f03e493d31478514ea97e6 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/finishersDefinition/properties/predefinedDefaults.rst @@ -0,0 +1 @@ +Defines predefined defaults for finisher options which are prefilled, if the finisher is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formEditor/Index.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formEditor/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..c1ec50f28323cc15c51d2fc6e2cd179829201fdd --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formEditor/Index.rst @@ -0,0 +1,705 @@ +.. include:: ../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor: + +============ +[formEditor] +============ + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.translationfile: + +translationFile +--------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.translationFile + +:aspect:`Data type` + string/ array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + formEditor: + translationFile: 'EXT:form/Resources/Private/Language/Database.xlf' + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + Filesystem path(s) to translation files which should be searched for form editor translations. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.dynamicrequirejsmodules.app: + +dynamicRequireJsModules.app +--------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.dynamicRequireJsModules.app + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + formEditor: + dynamicRequireJsModules: + app: TYPO3/CMS/Form/Backend/FormEditor + mediator: TYPO3/CMS/Form/Backend/FormEditor/Mediator + viewModel: TYPO3/CMS/Form/Backend/FormEditor/ViewModel + +:aspect:`Good to know` + - :ref:`"Form editor"<concepts-formeditor>` + +:aspect:`Description` + RequireJS path for the form editor JavaScript app. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.dynamicrequirejsmodules.mediator: + +dynamicRequireJsModules.mediator +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.dynamicRequireJsModules.mediator + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + formEditor: + dynamicRequireJsModules: + app: TYPO3/CMS/Form/Backend/FormEditor + mediator: TYPO3/CMS/Form/Backend/FormEditor/Mediator + viewModel: TYPO3/CMS/Form/Backend/FormEditor/ViewModel + + +:aspect:`Good to know` + - :ref:`"Form editor"<concepts-formeditor>` + +:aspect:`Description` + RequireJS path for the form editor JavaScript mediator. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.dynamicrequirejsmodules.viewmodel: + +dynamicRequireJsModules.viewModel +--------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.dynamicRequireJsModules.viewModel + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + formEditor: + dynamicRequireJsModules: + app: TYPO3/CMS/Form/Backend/FormEditor + mediator: TYPO3/CMS/Form/Backend/FormEditor/Mediator + viewModel: TYPO3/CMS/Form/Backend/FormEditor/ViewModel + + +:aspect:`Good to know` + - :ref:`"Form editor"<concepts-formeditor>` + +:aspect:`Description` + RequireJS path for the form editor JavaScript view model. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.dynamicrequirejsmodules.additionalviewmodelmodules: + +dynamicRequireJsModules.additionalViewModelModules +-------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.dynamicRequireJsModules.additionalViewModelModules + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (prototype 'standard')` + undefined + +:aspect:`Good to know` + - :ref:`"Form editor"<concepts-formeditor>` + - :ref:`"Register custom JavaScript modules"<concepts-formeditor-basicjavascriptconcepts-registercustomjavascriptmodules>` + +:aspect:`Description` + Array with RequireJS paths for custom JavaScript modules. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.addinlinesettings: + +addInlineSettings +----------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.addInlineSettings + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (prototype 'standard')` + undefined + +:aspect:`Good to know` + - :ref:`"Form editor"<concepts-formeditor>` + +:aspect:`Description` + Adds Javascript Inline Setting. This will occur in TYPO3.settings - object. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.maximumundosteps: + +maximumUndoSteps +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.maximumUndoSteps + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + formEditor: + maximumUndoSteps: 10 + +:aspect:`Good to know` + - :ref:`"Form editor"<concepts-formeditor>` + +:aspect:`Description` + Define the maximum possible undo steps within the form editor. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.stylesheets: + +stylesheets +----------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.stylesheets + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + formEditor: + stylesheets: + 200: 'EXT:form/Resources/Public/Css/form.css' + +:aspect:`Good to know` + - :ref:`"Form editor"<concepts-formeditor>` + +:aspect:`Description` + The CSS files to be used by the ``form editor``. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.formeditorfluidconfiguration: + +formEditorFluidConfiguration +---------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.formEditorFluidConfiguration + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + formEditor: + formEditorFluidConfiguration: + templatePathAndFilename: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/InlineTemplates.html' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Backend/Partials/FormEditor/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Backend/Layouts/FormEditor/' + +:aspect:`Good to know` + - :ref:`"Form editor"<concepts-formeditor>` + - :ref:`"view/inspector/editor/insert/perform"<apireference-formeditor-basicjavascriptconcepts-events-view-inspector-editor-insert-perform>` + +:aspect:`Description` + Basic fluid template search path configurations. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.formeditorfluidconfiguration.templatepathandfilename: + +formEditorFluidConfiguration.templatePathAndFilename +---------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.formEditorFluidConfiguration.templatePathAndFilename + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + formEditor: + formEditorFluidConfiguration: + templatePathAndFilename: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/InlineTemplates.html' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Backend/Partials/FormEditor/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Backend/Layouts/FormEditor/' + +:aspect:`Good to know` + - :ref:`"Form editor"<concepts-formeditor>` + +:aspect:`Description` + Internal setting. Template which render the inline HTML templates which are used by the form editor JavaScript. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.formeditorfluidconfiguration.partialrootpaths: + +formEditorFluidConfiguration.partialRootPaths +--------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.formEditorFluidConfiguration.partialRootPaths + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4-5 + + formEditor: + formEditorFluidConfiguration: + templatePathAndFilename: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/InlineTemplates.html' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Backend/Partials/FormEditor/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Backend/Layouts/FormEditor/' + +:aspect:`Good to know` + - :ref:`"Form editor"<concepts-formeditor>` + - :ref:`"view/inspector/editor/insert/perform"<apireference-formeditor-basicjavascriptconcepts-events-view-inspector-editor-insert-perform>` + +:aspect:`Description` + Array with fluid partial search paths for the inline HTML templates which are used by the form editor JavaScript. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.formeditorfluidconfiguration.layoutrootpaths: + +formEditorFluidConfiguration.layoutRootPaths +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.formEditorFluidConfiguration.layoutRootPaths + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6-7 + + formEditor: + formEditorFluidConfiguration: + templatePathAndFilename: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/InlineTemplates.html' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Backend/Partials/FormEditor/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Backend/Layouts/FormEditor/' + +:aspect:`Good to know` + - :ref:`"Form editor"<concepts-formeditor>` + - :ref:`"view/inspector/editor/insert/perform"<apireference-formeditor-basicjavascriptconcepts-events-view-inspector-editor-insert-perform>` + +:aspect:`Description` + Internal setting. Array with fluid layout search paths. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.formeditorpartials: + +formEditorPartials +------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.formEditorPartials + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + formEditor: + formEditorPartials: + FormElement-_ElementToolbar: Stage/_ElementToolbar + FormElement-_UnknownElement: Stage/_UnknownElement + FormElement-Page: Stage/Page + FormElement-SummaryPage: Stage/SummaryPage + FormElement-Fieldset: Stage/Fieldset + FormElement-GridContainer: Stage/Fieldset + FormElement-GridRow: Stage/Fieldset + FormElement-Text: Stage/SimpleTemplate + FormElement-Password: Stage/SimpleTemplate + FormElement-AdvancedPassword: Stage/SimpleTemplate + FormElement-Textarea: Stage/SimpleTemplate + FormElement-Checkbox: Stage/SimpleTemplate + FormElement-MultiCheckbox: Stage/SelectTemplate + FormElement-MultiSelect: Stage/SelectTemplate + FormElement-RadioButton: Stage/SelectTemplate + FormElement-SingleSelect: Stage/SelectTemplate + FormElement-DatePicker: Stage/SimpleTemplate + FormElement-StaticText: Stage/StaticText + FormElement-Hidden: Stage/SimpleTemplate + FormElement-ContentElement: Stage/ContentElement + FormElement-FileUpload: Stage/FileUploadTemplate + FormElement-ImageUpload: Stage/FileUploadTemplate + Modal-InsertElements: Modals/InsertElements + Modal-InsertPages: Modals/InsertPages + Modal-ValidationErrors: Modals/ValidationErrors + Inspector-FormElementHeaderEditor: Inspector/FormElementHeaderEditor + Inspector-CollectionElementHeaderEditor: Inspector/CollectionElementHeaderEditor + Inspector-TextEditor: Inspector/TextEditor + Inspector-PropertyGridEditor: Inspector/PropertyGridEditor + Inspector-SingleSelectEditor: Inspector/SingleSelectEditor + Inspector-MultiSelectEditor: Inspector/MultiSelectEditor + Inspector-GridColumnViewPortConfigurationEditor: Inspector/GridColumnViewPortConfigurationEditor + Inspector-TextareaEditor: Inspector/TextareaEditor + Inspector-RemoveElementEditor: Inspector/RemoveElementEditor + Inspector-FinishersEditor: Inspector/FinishersEditor + Inspector-ValidatorsEditor: Inspector/ValidatorsEditor + Inspector-RequiredValidatorEditor: Inspector/RequiredValidatorEditor + Inspector-CheckboxEditor: Inspector/CheckboxEditor + Inspector-Typo3WinBrowserEditor: Inspector/Typo3WinBrowserEditor + +:aspect:`Good to know` + - :ref:`"Form editor"<concepts-formeditor>` + - :ref:`"Common Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>` + - :ref:`"available inspector editors"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formEditor.editors-availableinspectoreditors>` + - :ref:`"view/inspector/editor/insert/perform"<apireference-formeditor-basicjavascriptconcepts-events-view-inspector-editor-insert-perform>` + +:aspect:`Description` + Array with mappings for the inline HTML templates. The keys are identifierts which could be used within the JavaScript code. The values are partial paths, relative to :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formeditor.formEditorFluidConfiguration.partialRootPaths"<typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorfluidconfiguration.partialrootpaths>`. + The partials content will be rendered as inline HTML. This inline HTML templates can be identified and used by such a key (e.g. "Inspector-TextEditor") within the JavaScript code. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.formelementpropertyvalidatorsdefinition: + +formElementPropertyValidatorsDefinition +--------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.formElementPropertyValidatorsDefinition + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + formEditor: + formElementPropertyValidatorsDefinition: + NotEmpty: + errorMessage: formEditor.formElementPropertyValidatorsDefinition.NotEmpty.label + Integer: + errorMessage: formEditor.formElementPropertyValidatorsDefinition.Integer.label + NaiveEmail: + errorMessage: formEditor.formElementPropertyValidatorsDefinition.NaiveEmail.label + NaiveEmailOrEmpty: + errorMessage: formEditor.formElementPropertyValidatorsDefinition.NaiveEmail.label + FormElementIdentifierWithinCurlyBracesInclusive: + errorMessage: formEditor.formElementPropertyValidatorsDefinition.FormElementIdentifierWithinCurlyBraces.label + FormElementIdentifierWithinCurlyBracesExclusive: + errorMessage: formEditor.formElementPropertyValidatorsDefinition.FormElementIdentifierWithinCurlyBraces.label + +:aspect:`Related options` + - :ref:`"[TextEditor] propertyValidators"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.propertyvalidators-texteditor>` + - :ref:`"[Typo3WinBrowserEditor] propertyValidators"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.propertyvalidators-typo3winbrowsereditor>` + +:aspect:`Good to know` + - :ref:`"Form editor"<concepts-formeditor>` + +:aspect:`Description` + Some inspector editors are able to validate it's values through a JavaScript methods. + ``formElementPropertyValidatorsDefinition`` define basic configurations for such JavaScript validators. + This JavaScript validators can be registered through ``getFormEditorApp().addPropertyValidationValidator()``. The first method argument is the identifier + for this validator. Every array key within ``formElementPropertyValidatorsDefinition`` must be equal to such a identifier. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.formelementpropertyvalidatorsdefinition.<formelementpropertyvalidatoridentifier>.errormessage: + +formElementPropertyValidatorsDefinition.<formElementPropertyValidatorIdentifier>.errorMessage +--------------------------------------------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.formElementPropertyValidatorsDefinition.<formElementPropertyValidatorIdentifier>.errorMessage + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4, 6, 8, 10, 12, 14 + + formEditor: + formElementPropertyValidatorsDefinition: + NotEmpty: + errorMessage: formEditor.formElementPropertyValidatorsDefinition.NotEmpty.label + Integer: + errorMessage: formEditor.formElementPropertyValidatorsDefinition.Integer.label + NaiveEmail: + errorMessage: formEditor.formElementPropertyValidatorsDefinition.NaiveEmail.label + NaiveEmailOrEmpty: + errorMessage: formEditor.formElementPropertyValidatorsDefinition.NaiveEmail.label + FormElementIdentifierWithinCurlyBracesInclusive: + errorMessage: formEditor.formElementPropertyValidatorsDefinition.FormElementIdentifierWithinCurlyBraces.label + FormElementIdentifierWithinCurlyBracesExclusive: + errorMessage: formEditor.formElementPropertyValidatorsDefinition.FormElementIdentifierWithinCurlyBraces.label + +:aspect:`Related options` + - :ref:`"[TextEditor] propertyValidators"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.propertyvalidators-texteditor>` + - :ref:`"[Typo3WinBrowserEditor] propertyValidators"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.propertyvalidators-typo3winbrowsereditor>` + +:aspect:`Good to know` + - :ref:`"Form editor"<concepts-formeditor>` + +:aspect:`Description` + The error message for a inspector editor property validator which is shown if the validation fails. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.formelementgroups: + +formElementGroups +----------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.formElementGroups + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + formEditor: + formElementGroups: + input: + label: formEditor.formElementGroups.input.label + select: + label: formEditor.formElementGroups.select.label + custom: + label: formEditor.formElementGroups.custom.label + container: + label: formEditor.formElementGroups.container.label + page: + label: formEditor.formElementGroups.page.label + +:aspect:`Related options` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Password.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.password.formeditor.group>` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.group>` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Text.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.text.formeditor.group>` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Page.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.page.formeditor.group>` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.group>` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.group>` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Checkbox.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.checkbox.formeditor.group>` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.SummaryPage.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.summarypage.formeditor.group>` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.ImageUpload.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.imageupload.formeditor.group>` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.GridContainer.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.gridcontainer.formeditor.group>` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Hidden.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.hidden.formeditor.group>` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.StaticText.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.statictext.formeditor.group>` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.RadioButton.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.radiobutton.formeditor.group>` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.SingleSelect.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.singleselect.formeditor.group>` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.fileupload.formeditor.group>` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.GridRow.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.gridrow.formeditor.group>` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Fieldset.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.fieldset.formeditor.group>` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.ContentElement.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.contentelement.formeditor.group>` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.group>` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.group>` + +:aspect:`Good to know` + - :ref:`"Form editor"<concepts-formeditor>` + +:aspect:`Description` + Every form element can be placed within a group within the ``form editor`` "new Element" modal. + Every form element which should be shown within such a group, must have a ``group`` property. The form element ``group`` property value + must be equal to an array key within ``formElementGroups``. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.formelementgroups.<formelementgroupidentifier>.label: + +formElementGroups.<formElementGroupIdentifier>.label +---------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.formElementGroups.<formElementGroupIdentifier>.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4, 6, 8, 10, 12 + + formEditor: + formElementGroups: + input: + label: formEditor.formElementGroups.input.label + select: + label: formEditor.formElementGroups.select.label + custom: + label: formEditor.formElementGroups.custom.label + container: + label: formEditor.formElementGroups.container.label + page: + label: formEditor.formElementGroups.page.label + +:aspect:`Good to know` + - :ref:`"Form editor"<concepts-formeditor>` + +:aspect:`Description` + The label for a group within the ``form editor`` "new Element" modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/Index.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..f8319bc1ee2bae85b1ecc9f2fafb0c91263f0b38 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/Index.rst @@ -0,0 +1,765 @@ +.. include:: ../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition: + +======================== +[formElementsDefinition] +======================== + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.*: + +[formElementsDefinition] +------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + + prototypes: + <prototypeIdentifier>: + formElementsDefinition: + [...] + +:aspect:`Good to know` + - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>` + +:aspect:`Description` + Array which defines the available form elements. Every key within this array is called the ``<formElementTypeIdentifier>``. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>: + +<formElementTypeIdentifier> +--------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier> + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + + prototypes: + standard: + Form: + [...] + Page: + [...] + SummaryPage: + [...] + Fieldset: + [...] + GridContainer: + [...] + GridRow: + [...] + Text: + [...] + Password: + [...] + AdvancedPassword: + [...] + Textarea: + [...] + Honeypot: + [...] + Hidden: + [...] + Checkbox: + [...] + MultiCheckbox: + [...] + MultiSelect: + [...] + RadioButton: + [...] + SingleSelect: + [...] + DatePicker: + [...] + StaticText: + [...] + ContentElement: + [...] + FileUpload: + [...] + ImageUpload: + [...] + +:aspect:`Good to know` + - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>` + +:aspect:`Description` + This array key identifies a form element. This identifier could be used to attach a form element to a form. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>-commonproperties: + +Common <formElementTypeIdentifier> properties +============================================= + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.implementationclassname: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>` + +:aspect:`Description` + Classname which implements the form element. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.renderingoptions.translation.translationfile: + +renderingOptions.translation.translationFile +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.renderingOptions.translation.translationFile + +:aspect:`Data type` + string/ array + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>` + - :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>` + +:aspect:`Description` + Filesystem path(s) to translation files which should be searched for form element property translations. + If ``translationFile`` is undefined, - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.translation.translationFile"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.translation.translationfile>` will be used. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.renderingOptions.translation.translatePropertyValueIfEmpty: + +renderingOptions.translation.translatePropertyValueIfEmpty +---------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.renderingoptions.translation.translatepropertyvalueifempty + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + true + +:aspect:`Good to know` + - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>` + - :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>` + +:aspect:`Description` + If set to ``false``, the form element property translation will be skipped if the form element property value is empty. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.renderingoptions.templatename: + +renderingOptions.templateName +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.renderingOptions.templateName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Mandatory` + (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Default value` + undefined + +:aspect:`Good to know` + - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>` + - :ref:`"templateName"<apireference-frontendrendering-fluidformrenderer-options-templatename>` + +:aspect:`Description` + Set ``templateName`` to define a custom template name which should be used instead of the ``<formElementTypeIdentifier>``. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.properties: + +properties +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.properties + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>` + - :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>` + +:aspect:`Description` + Array with form element specific properties. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.properties.fluidadditionalattributes: + +properties.fluidAdditionalAttributes +------------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.properties.fluidAdditionalAttributes + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>` + - :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>` + +:aspect:`Description` + The values within this array goes directely into the fluid form element viewhelpers property ``additionalAttributes``. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.properties.gridcolumnclassautoconfiguration: + +properties.gridColumnClassAutoConfiguration +------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.properties.gridColumnClassAutoConfiguration + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + Undefined + +:aspect:`Related options` + - :ref:`"GridRow viewPorts"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.gridrow.properties.gridcolumnclassautoconfiguration.viewports>` + +:aspect:`Description` + If the form element lies within a GridRow you can define the number of columns which the form element should occupy. + Each ``viewPorts`` configuration key has to match with on ofe the defined viewports within ``TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.properties.gridColumnClassAutoConfiguration.viewPorts`` + + .. code-block:: yaml + :linenos: + + gridColumnClassAutoConfiguration: + viewPorts: + lg: + numbersOfColumnsToUse: '2' + md: + numbersOfColumnsToUse: '3' + sm: + numbersOfColumnsToUse: '4' + xs: + numbersOfColumnsToUse: '5' + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.label: + +label +----- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>` + - :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>` + +:aspect:`Description` + The label for the form element. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor: + +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No (but recommended) + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Array with configurations for the ``form editor`` + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.predefineddefaults: + +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections: + +formEditor.propertyCollections +------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + Array with configurations for ``property collections`` for the form element. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections.validators: + +formEditor.propertyCollections.validators +----------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.validators + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + Array with configurations for available validators for a form element. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections.validators.*.identifier: + +formEditor.propertyCollections.validators.[*].identifier +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.validators.[*].identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections.validators.*.editors: + +formEditor.propertyCollections.validators.[*].editors +----------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.validators.[*].editors + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + Array with available ``inspector editors`` for this validator. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections.finishers: + +formEditor.propertyCollections.finishers +---------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.finishers + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + Array with configurations for available finisher for a form definition. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections.finishers.*.identifier: + +formEditor.propertyCollections.finishers.[*].identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.finishers.[*].identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<finisherIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>>` + +:aspect:`Description` + Identifies the finisher which should be attached to the form definition. Must be equal to a existing ``<finisherIdentifier>``. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections.finishers.*.editors: + +formEditor.propertyCollections.finishers.[*].editors +---------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.finishers.[*].editors + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + Array with available ``inspector editors`` for this finisher. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.label: + +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.group: + +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Related options` + - :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formElementGroups <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formelementgroups>` + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.groupsorting: + +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.iconidentifier: + +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formEditor.editors-tree: + +formEditor.editors +------------------ + +.. toctree:: + + formEditor/Index + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>-concreteconfigurations: + +Concrete configurations +======================= + +.. toctree:: + + formElementTypes/AdvancedPassword + formElementTypes/Checkbox + formElementTypes/ContentElement + formElementTypes/DatePicker + formElementTypes/Fieldset + formElementTypes/FileUpload + formElementTypes/Form + formElementTypes/GridContainer + formElementTypes/GridRow + formElementTypes/Hidden + formElementTypes/Honeypot + formElementTypes/ImageUpload + formElementTypes/MultiCheckbox + formElementTypes/MultiSelect + formElementTypes/Page + formElementTypes/Password + formElementTypes/RadioButton + formElementTypes/SingleSelect + formElementTypes/StaticText + formElementTypes/SummaryPage + formElementTypes/Text + formElementTypes/Textarea diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/Index.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..d75b33902ffb975b73983da2f747989b4b3e0fbd --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/Index.rst @@ -0,0 +1,110 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*: + +================================================== +[<formElementTypeIdentifier>][formEditor][editors] +================================================== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors: + +<formElementTypeIdentifier>.formEditor.editors +---------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeidentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.editors + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + Array with numerical keys. Each arrayitem describes an ``inspector editor`` which is used to write values into a form element property. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*-commonproperties: + +Common [<formElementTypeIdentifier>][formEditor][editors][*] properties +======================================================================= + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier: +.. include:: inspectorEditors/properties/Identifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename: + +templateName +------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.editors.*.templateName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Related options` + - :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>` + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + .. include:: inspectorEditors/properties/TemplateName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label: +.. include:: inspectorEditors/properties/Label.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertypath: +.. include:: inspectorEditors/properties/PropertyPath.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formEditor.editors-availableinspectoreditors: + +available inspector editors +--------------------------- + +.. toctree:: + + inspectorEditors/CheckboxEditor + inspectorEditors/CollectionElementHeaderEditor + inspectorEditors/FinishersEditor + inspectorEditors/FormElementHeaderEditor + inspectorEditors/GridColumnViewPortConfigurationEditor + inspectorEditors/MultiSelectEditor + inspectorEditors/PropertyGridEditor + inspectorEditors/RemoveElementEditor + inspectorEditors/RequiredValidatorEditor + inspectorEditors/SingleSelectEditor + inspectorEditors/TextareaEditor + inspectorEditors/TextEditor + inspectorEditors/Typo3WinBrowserEditor + inspectorEditors/ValidatorsEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/CheckboxEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/CheckboxEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..4394726188f4edc8a414017a9448285dd11dbc61 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/CheckboxEditor.rst @@ -0,0 +1,60 @@ +.. include:: ../../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.checkboxeditor: + +================ +[CheckboxEditor] +================ + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.checkboxeditor-introduction: + +Introduction +============ + +Shows a checkbox which write 'true' or 'false' within the form definition for a form element property. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.checkboxeditor-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-checkboxeditor: + +templateName +------------ + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Related options` + - :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>` + +:aspect:`value` + Inspector-CheckboxEditor + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + .. include:: properties/TemplateName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-checkboxeditor: +.. include:: properties/Identifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-checkboxeditor: +.. include:: properties/Label.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertypath-checkboxeditor: +.. include:: properties/PropertyPath.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/CollectionElementHeaderEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/CollectionElementHeaderEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..0e944356fad13a3dc9f7adb131e37b3102166bb9 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/CollectionElementHeaderEditor.rst @@ -0,0 +1,57 @@ +.. include:: ../../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor: + +=============================== +[CollectionElementHeaderEditor] +=============================== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor-introduction: + +Introduction +============ + +This is not really an editor because this editor don't write values into the form definition. +This editor show the header area for collection elements (finishers/ validators) with it's icon and label. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templateName-collectionelementheadereditor: + +templateName +------------ + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Related options` + - :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>` + +:aspect:`value` + Inspector-CollectionElementHeaderEditor + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + .. include:: properties/TemplateName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-collectionelementheadereditor: +.. include:: properties/Identifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-collectionelementheadereditor: +.. include:: properties/Label.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/FinishersEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/FinishersEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..601cedae9116802830c108fc8a06cbba4608ab35 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/FinishersEditor.rst @@ -0,0 +1,105 @@ +.. include:: ../../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.finisherseditor: + +================= +[FinishersEditor] +================= + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.finisherseditor-introduction: + +Introduction +============ + +Shows a select list with finishers. If a finisher is already added to the form definition, then this finisher will be removed from the select list. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.finisherseditor-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-finisherseditor: + +templateName +------------ + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Related options` + - :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>` + +:aspect:`value` + Inspector-FinishersEditor + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + .. include:: properties/TemplateName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-finisherseditor: +.. include:: properties/Identifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-finisherseditor: +.. include:: properties/Label.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.selectoptions.*.value-finisherseditor: + +selectOptions.[*].value +----------------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Related options` + - :ref:`"[finishersDefinition]"<typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.*>` + + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Has to match with a ``TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersdefinition`` configuration key. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.selectoptions.*.label-finisherseditor: + +selectOptions.[*].label +----------------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The label which is shown within the select field. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/FormElementHeaderEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/FormElementHeaderEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..136c3d4168997b6aaebc002f014706a005e861b6 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/FormElementHeaderEditor.rst @@ -0,0 +1,53 @@ +.. include:: ../../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor: + +========================= +[FormElementHeaderEditor] +========================= + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor-introduction: + +Introduction +============ + +This is not really an editor because this editor don't write values into the form definition. +This editor show the header area for the form element with it's icon and label. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-formelementheadereditor: + +templateName +------------ + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Related options` + - :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>` + +:aspect:`value` + Inspector-FormElementHeaderEditor + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + .. include:: properties/TemplateName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-formelementheadereditor: +.. include:: properties/Identifier.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/GridColumnViewPortConfigurationEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/GridColumnViewPortConfigurationEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..7b50d6ac20b382e2984026be8144ff77e78877d7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/GridColumnViewPortConfigurationEditor.rst @@ -0,0 +1,175 @@ +.. include:: ../../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor: + +======================================= +[GridColumnViewPortConfigurationEditor] +======================================= + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor-introduction: + +Introduction +============ + +Shows a viewport selector as buttons and an input field. With this editor, you can define how many columns per viewPort an form element should occupy. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templateName-gridcolumnviewportconfigurationeditor: + +templateName +------------ + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Related options` + - :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>` + +:aspect:`value` + Inspector-GridColumnViewPortConfigurationEditor + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + .. include:: properties/TemplateName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-gridcolumnviewportconfigurationeditor: +.. include:: properties/Identifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-gridcolumnviewportconfigurationeditor: +.. include:: properties/Label.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.configurationOptions.viewPorts.*.viewPortIdentifier-gridcolumnviewportconfigurationeditor: + +configurationOptions.viewPorts.[*].viewPortIdentifier +----------------------------------------------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Related options` + - :ref:`"properties.gridColumnClassAutoConfiguration"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.\<formelementtypeidentifier>.properties.gridcolumnclassautoconfiguration>` + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Has to match with a ``TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.properties.gridColumnClassAutoConfiguration.viewPorts`` configuration key. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.configurationOptions.viewPorts.*.label-gridcolumnviewportconfigurationeditor: + +configurationOptions.viewPorts.[*].label +---------------------------------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The label for the viewport button. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.configurationOptions.numbersOfColumnsToUse.label-gridcolumnviewportconfigurationeditor: + +configurationOptions.numbersOfColumnsToUse.label +------------------------------------------------ + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The label for the "Numbers of columns" input field. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.configurationOptions.numbersOfColumnsToUse.propertyPath-gridcolumnviewportconfigurationeditor: + +configurationOptions.numbersOfColumnsToUse.propertyPath +------------------------------------------------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The path to the property of the form element which should be written. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.configurationOptions.numbersOfColumnsToUse.fieldExplanationText-gridcolumnviewportconfigurationeditor: + +configurationOptions.numbersOfColumnsToUse.fieldExplanationText +--------------------------------------------------------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A text which is shown at the bottom of the "Numbers of columns" input field. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/MultiSelectEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/MultiSelectEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..679c4e1b562ac5fdf7e36a712031e5dba5977084 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/MultiSelectEditor.rst @@ -0,0 +1,108 @@ +.. include:: ../../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.multiselecteditor: + +=================== +[MultiSelectEditor] +=================== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.multiselecteditor-introduction: + +Introduction +============ + +Shows a multiselect list with values. If one or more selectoptions are selected, then the option value will be written within a form element property which is defined by the "propertyPath" option. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.multiselecteditor-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-multiselecteditor: + +templateName +------------ + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Related options` + - :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>` + +:aspect:`value` + Inspector-MultiSelectEditor + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + .. include:: properties/TemplateName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-multiselecteditor: +.. include:: properties/Identifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-multiselecteditor: +.. include:: properties/Label.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertypath-multiselecteditor: +.. include:: properties/PropertyPath.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.selectoptions.*.value-multiselecteditor: + +selectOptions.[*].value +----------------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The value which should be written into the corresponding form elements property. + The corresponding form elements property is identified by the ``propertyPath`` option. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.selectoptions.*.label-multiselecteditor: + +selectOptions.[*].label +----------------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The label which is shown within the select field. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/PropertyGridEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/PropertyGridEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..0e484f55b7a0f6a522db3f478c4e0bc4c5208e68 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/PropertyGridEditor.rst @@ -0,0 +1,232 @@ +.. include:: ../../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertygrideditor: + +==================== +[PropertyGridEditor] +==================== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertygrideditor-introduction: + +Introduction +============ + +Shows a grid which allows you to add (and remove) multiple rows and fill values for each row. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertygrideditor-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-propertygrideditor: + +templateName +------------ + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Related options` + - :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>` + +:aspect:`value` + Inspector-PropertyGridEditor + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + .. include:: properties/TemplateName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-propertygrideditor: +.. include:: properties/Identifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-propertygrideditor: +.. include:: properties/Label.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertypath-propertygrideditor: +.. include:: properties/PropertyPath.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.issortable-propertygrideditor: + +isSortable +---------- + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + If set to 'false' then the rows are not sortable. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.enableaddrow-propertygrideditor: + +enableAddRow +------------ + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + If set to 'false' the the "add new row" button is disabled. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.enabledeleterow-propertygrideditor: + +enableDeleteRow +--------------- + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + If set to 'false' the the "delete row" button is disabled. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.multiselection-propertygrideditor: + +multiSelection +-------------- + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + If set to 'false' then only one row can be marked as preselected. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.removelastavailablerowflashmessagetitle-propertygrideditor: + +removeLastAvailableRowFlashMessageTitle +--------------------------------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + There must be at least one existing row within this ``inspector editor``. If the last existing row is tried to be removed then a flash message is shown. + This property define the title for the flash message. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.removelastavailablerowflashmessagemessage-propertygrideditor: + +removeLastAvailableRowFlashMessageMessage +----------------------------------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + There must be at least one existing row within this ``inspector editor``. If the last existing row is tried to be removed then a flash message is shown. + This property define the text for the flash message. + + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.shouldshowpreselectedvaluecolumn-propertygrideditor: + +shouldShowPreselectedValueColumn +-------------------------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + If set to 'false' then the column which is used to mark a row as preselected will be disabled. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/RemoveElementEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/RemoveElementEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..caba6d658eeb77a4ca0b5be7304ce1791ddc337f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/RemoveElementEditor.rst @@ -0,0 +1,52 @@ +.. include:: ../../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor: + +===================== +[RemoveElementEditor] +===================== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor-introduction: + +Introduction +============ + +This editor show a button which allows you to remove the form element or the collection element (finishers/ validators). + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-removeelementeditor: + +templateName +------------ + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Related options` + - :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>` + +:aspect:`value` + Inspector-RemoveElementEditor + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + .. include:: properties/TemplateName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-removeelementeditor: +.. include:: properties/Identifier.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/RequiredValidatorEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/RequiredValidatorEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..5ca5147d10aad7d8dcfae19c0e01542ccb44fbb4 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/RequiredValidatorEditor.rst @@ -0,0 +1,127 @@ +.. include:: ../../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor: + +========================= +[RequiredValidatorEditor] +========================= + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor-introduction: + +Introduction +============ + +Shows a checkbox. If set, a validator ('NotEmpty' by default) will be written into the ``form definition``. In addition another property could be written into the ``form definition``. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-requiredvalidatoreditor: + +templateName +------------ + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Related options` + - :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>` + +:aspect:`value` + Inspector-RequiredValidatorEditor + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + .. include:: properties/TemplateName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-requiredvalidatoreditor: +.. include:: properties/Identifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-requiredvalidatoreditor: +.. include:: properties/Label.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.validatoridentifier-requiredvalidatoreditor: + +validatorIdentifier +------------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + The ``<validatorIdentifier>`` which should be used. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertypath-requiredvalidatoreditor: + +propertyPath +------------ + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +.. :aspect:`Related options` + @ToDo + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + An property path which should be written into the `form definition`` if the checkbox is set. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertyvalue-requiredvalidatoreditor: + +propertyValue +------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +.. :aspect:`Related options` + @ToDo + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + The value for the property path which should be written into the `form definition`` if the checkbox is set. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/SingleSelectEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/SingleSelectEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..a74f6158d7e5336858dffac0c1acef096fdbb677 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/SingleSelectEditor.rst @@ -0,0 +1,110 @@ +.. include:: ../../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.singleselecteditor: + +==================== +[SingleSelectEditor] +==================== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.singleselecteditor-introduction: + +Introduction +============ + +Shows a single select list with values. If a selectoption is selected, then the option value will be written within a form element property which is defined by the "propertyPath" option. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.singleselecteditor-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-singleselecteditor: + +templateName +------------ + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Related options` + - :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>` + +:aspect:`value` + Inspector-SingleSelectEditor + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + .. include:: properties/TemplateName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-singleselecteditor: +.. include:: properties/Identifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-singleselecteditor: +.. include:: properties/Label.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertypath-singleselecteditor: +.. include:: properties/PropertyPath.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.selectoptions.*.value-singleselecteditor: + +selectOptions.[*].value +----------------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The value which should be written into the corresponding form elements property. + The corresponding form elements property is identified by the ``propertyPath`` option. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.selectoptions.*.label-singleselecteditor: + +selectOptions.[*].label +----------------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The label which is shown within the select field. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/TextEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/TextEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..bdda54901cbb54487a864e11b8f5ed412c66118e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/TextEditor.rst @@ -0,0 +1,205 @@ +.. include:: ../../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.texteditor: + +============ +[TextEditor] +============ + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.texteditor-introduction: + +Introduction +============ + +Shows a single line textfield. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.texteditor-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-texteditor: + +templateName +------------ + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Related options` + - :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>` + +:aspect:`value` + Inspector-TextEditor + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + .. include:: properties/TemplateName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-texteditor: +.. include:: properties/Identifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-texteditor: +.. include:: properties/Label.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertypath-texteditor: +.. include:: properties/PropertyPath.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.donotsetifpropertyvalueisempty-texteditor: + +doNotSetIfPropertyValueIsEmpty +------------------------------ + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +.. :aspect:`Related options` + @ToDo + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + If set to true then the property which should be written through this ``inspector editor`` will be removed within the ``form definition`` if the + value from the ``inspector editor`` is empty instead of writing an empty value ('') for this property. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertyvalidators-texteditor: + +propertyValidators +------------------ + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Related options` + - :ref:`"formElementPropertyValidatorsDefinition"<typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formelementpropertyvalidatorsdefinition>` + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + This ``inspector editors`` is able to validate it's value through JavaScript methods. + This JavaScript validators can be registered through ``getFormEditorApp().addPropertyValidationValidator()``. + The first method argument is the identifier for such a validator. + Every array value within ``propertyValidators`` must be equal to such a identifier. + + For example: + + .. code-block:: yaml + + propertyValidators: + 10: 'Integer' + 20: 'FormElementIdentifierWithinCurlyBracesExclusive' + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertyvalidatorsmode-texteditor: + +propertyValidatorsMode +---------------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value` + AND + +:aspect:`possible values` + OR/ AND + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + If set to 'OR' then at least one validator must be valid to accept the ``inspector editor`` value. If set to 'AND' then all validators must be valid. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.fieldexplanationtext-texteditor: + +fieldExplanationText +-------------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +.. :aspect:`Related options` + @ToDo + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + A text which is shown at the bottom of the ``inspector editor``. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.additionalelementpropertypaths-texteditor: + +additionalElementPropertyPaths +------------------------------ + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +.. :aspect:`Related options` + @ToDo + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + An array which holds property paths which should be written in addition to the propertyPath option. + + For example: + + .. code-block:: yaml + + additionalElementPropertyPaths: + 10: 'properties.fluidAdditionalAttributes.maxlength' diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/TextareaEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/TextareaEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..ae2149ce27b9e5311dca0783760d6c37fcc720c1 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/TextareaEditor.rst @@ -0,0 +1,59 @@ +.. include:: ../../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.textareaeditor: + +================ +[TextareaEditor] +================ + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.textareaeditor-introduction: + +Introduction +============ + +Shows a textarea. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.textareaeditor-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-textareaeditor: + +templateName +------------ + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Related options` + - :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>` + +:aspect:`value` + Inspector-TextareaEditor + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + .. include:: properties/TemplateName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-textareaeditor: +.. include:: properties/Identifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-textareaeditor: +.. include:: properties/Label.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertypath-textareaeditor: +.. include:: properties/PropertyPath.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/Typo3WinBrowserEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/Typo3WinBrowserEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..f747ee8c2e5bccb3ca196f71fd529627e488f934 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/Typo3WinBrowserEditor.rst @@ -0,0 +1,199 @@ +.. include:: ../../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.typo3winbrowsereditor: + +======================= +[Typo3WinBrowserEditor] +======================= + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.typo3winbrowsereditor-introduction: + +Introduction +============ + +Shows a popup window to select a record (e.g. pages or tt_content records) as you know it from within the form engine. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.typo3winbrowsereditor-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-typo3winbrowsereditor: + +templateName +------------ + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Related options` + - :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>` + +:aspect:`value` + Inspector-Typo3WinBrowserEditor + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + .. include:: properties/TemplateName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-typo3winbrowsereditor: +.. include:: properties/Identifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-typo3winbrowsereditor: +.. include:: properties/Label.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertypath-typo3winbrowsereditor: +.. include:: properties/PropertyPath.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.buttonlabel-typo3winbrowsereditor: + +buttonLabel +----------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + The label for the button which opens the popup window. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.browsabletype-typo3winbrowsereditor: + +browsableType +------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + The allowed selectable record types e.g 'pages' or 'tt_content'. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertyvalidators-typo3winbrowsereditor: + +propertyValidators +------------------ + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Related options` + - :ref:`"formElementPropertyValidatorsDefinition"<typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formelementpropertyvalidatorsdefinition>` + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + This ``inspector editors`` is able to validate it's value through JavaScript methods. + This JavaScript validators can be registered through ``getFormEditorApp().addPropertyValidationValidator()``. + The first method argument is the identifier for such a validator. + Every array value within ``propertyValidators`` must be equal to such a identifier. + + For example: + + .. code-block:: yaml + + propertyValidators: + 10: 'Integer' + 20: 'FormElementIdentifierWithinCurlyBracesExclusive' + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertyvalidatorsmode-typo3winbrowsereditor: + +propertyValidatorsMode +---------------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value` + AND + +:aspect:`possible values` + OR/ AND + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + If set to 'OR' then at least one validator must be valid to accept the ``inspector editor`` value. If set to 'AND' then all validators must be valid. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.fieldexplanationtext-typo3winbrowsereditor: + +fieldExplanationText +-------------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +.. :aspect:`Related options` + @ToDo + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + A text which is shown at the bottom of the ``inspector editor``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/ValidatorsEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/ValidatorsEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..987134cf02d9b87f90febbd2b162ad2e7ed37c98 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/ValidatorsEditor.rst @@ -0,0 +1,104 @@ +.. include:: ../../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.validatorseditor: + +================== +[ValidatorsEditor] +================== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.validatorseditor-introduction: + +Introduction +============ + +Shows a select list with validators. If a validator is already added to the form element, then this validator will be removed from the select list. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.validatorseditor-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-validatorseditor: + +templateName +------------ + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Related options` + - :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>` + +:aspect:`value` + Inspector-FinishersEditor + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`Description` + .. include:: properties/TemplateName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-validatorseditor: +.. include:: properties/Identifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-validatorseditor: +.. include:: properties/Label.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.selectoptions.*.value-validatorseditor: + +selectOptions.[*].value +----------------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Related options` + - :ref:`"[validatorsDefinition]"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.*>` + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Has to match with a ``TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition`` configuration key. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.selectoptions.*.label-validatorseditor: + +selectOptions.[*].label +----------------------- + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +.. :aspect:`Related options` + @ToDo + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The label which is shown within the select field. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/properties/Identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/properties/Identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..d8eaac745307a837ec7318d0b6e65c091bc15c85 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/properties/Identifier.rst @@ -0,0 +1,24 @@ +identifier +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.editors.*.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + +:aspect:`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 optionpath ``TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.editors``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/properties/Label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/properties/Label.rst new file mode 100644 index 0000000000000000000000000000000000000000..ea92ac305ef62dd5aca76e68ff5f84f2eeec251d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/properties/Label.rst @@ -0,0 +1,24 @@ +label +----- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.editors.*.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + The label for this ``inspector editor`` which is shown within the ``inspector component``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/properties/PropertyPath.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/properties/PropertyPath.rst new file mode 100644 index 0000000000000000000000000000000000000000..797123c4a603770a9df108841d4dafb972cddd89 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/properties/PropertyPath.rst @@ -0,0 +1,25 @@ +propertyPath +------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.editors.*.propertyPath + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"JavaScript FormElement model"<apireference-formeditor-basicjavascriptconcepts-formelementmodel>` + +:aspect:`Description` + The path to the property of the form element which should be written by this ``inspector editor``. + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/properties/TemplateName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/properties/TemplateName.rst new file mode 100644 index 0000000000000000000000000000000000000000..9ec65df8ff5a6ef6c393d5fa2982a4a311f60391 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formEditor/inspectorEditors/properties/TemplateName.rst @@ -0,0 +1,2 @@ +The inline HTML template which is used for this inspector editor. +Must be equal to an existing array key within ``TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formEditor.formEditorPartials`` and must be started with 'Inspector-' by convention. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword.rst new file mode 100644 index 0000000000000000000000000000000000000000..96862235acbfea418f0bd3a164551c6688687c7d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword.rst @@ -0,0 +1,184 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.advancedpassword: + +================== +[AdvancedPassword] +================== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.advancedpassword-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.implementationclassname: +.. include:: AdvancedPassword/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.properties.containerclassattribute: +.. include:: AdvancedPassword/properties/containerClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.properties.elementclassattribute: +.. include:: AdvancedPassword/properties/elementClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.properties.elementerrorclassattribute: +.. include:: AdvancedPassword/properties/elementErrorClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.properties.confirmationlabel: +.. include:: AdvancedPassword/properties/confirmationLabel.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.properties.confirmationclassattribute: +.. include:: AdvancedPassword/properties/confirmationClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor: +.. include:: AdvancedPassword/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.editors.100: +.. include:: AdvancedPassword/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.editors.200: +.. include:: AdvancedPassword/formEditor/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.editors.300: +.. include:: AdvancedPassword/formEditor/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.editors.400: +.. include:: AdvancedPassword/formEditor/editors/400.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.editors.700: +.. include:: AdvancedPassword/formEditor/editors/700.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.editors.800: +.. include:: AdvancedPassword/formEditor/editors/800.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.editors.900: +.. include:: AdvancedPassword/formEditor/editors/900.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.editors.9999: +.. include:: AdvancedPassword/formEditor/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.predefineddefaults: +.. include:: AdvancedPassword/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.10: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/10.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.10.identifier: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/10/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.10.editors.100: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/10/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.10.editors.9999: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/10/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.20: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/20.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.20.identifier: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/20/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.20.editors.100: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/20/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.20.editors.9999: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/20/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.30: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/30.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.30.identifier: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/30/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.30.editors.100: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/30/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.30.editors.200: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/30/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.30.editors.300: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/30/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.30.editors.9999: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/30/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.40: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/40.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.40.identifier: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/40/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.40.editors.100: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/40/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.40.editors.9999: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/40/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.50: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/50.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.50.identifier: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/50/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.50.editors.100: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/50/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.50.editors.9999: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/50/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.60: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/60.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.60.identifier: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/60/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.60.editors.100: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/60/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.60.editors.9999: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/60/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.70: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/70.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.70.identifier: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/70/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.70.editors.100: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/70/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.70.editors.200: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/70/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.70.editors.300: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/70/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.70.editors.9999: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/70/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.80: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/80.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.80.identifier: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/80/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.80.editors.100: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/80/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.80.editors.200: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/80/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.80.editors.9999: +.. include:: AdvancedPassword/formEditor/propertyCollections/validators/80/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.label: +.. include:: AdvancedPassword/formEditor/label.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.group: +.. include:: AdvancedPassword/formEditor/group.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.groupsorting: +.. include:: AdvancedPassword/formEditor/groupSorting.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.iconidentifier: +.. include:: AdvancedPassword/formEditor/iconIdentifier.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..9de6aad332c27a3ddfcd1ed89299b678e8baf64c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor.rst @@ -0,0 +1,244 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + AdvancedPassword: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 300: + identifier: confirmationLabel + templateName: Inspector-TextEditor + label: formEditor.elements.AdvancedPassword.editor.confirmationLabel.label + propertyPath: properties.confirmationLabel + 400: + identifier: placeholder + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.placeholder.label + propertyPath: properties.fluidAdditionalAttributes.placeholder + compatibilityPropertyPath: properties.placeholder + doNotSetIfPropertyValueIsEmpty: true + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.TextMixin.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.TextMixin.editor.validators.EmptyValue.label + 20: + value: Alphanumeric + label: formEditor.elements.TextMixin.editor.validators.Alphanumeric.label + 30: + value: Text + label: formEditor.elements.TextMixin.editor.validators.Text.label + 40: + value: StringLength + label: formEditor.elements.TextMixin.editor.validators.StringLength.label + 50: + value: EmailAddress + label: formEditor.elements.TextMixin.editor.validators.EmailAddress.label + 60: + value: Integer + label: formEditor.elements.TextMixin.editor.validators.Integer.label + 70: + value: Float + label: formEditor.elements.TextMixin.editor.validators.Float.label + 80: + value: NumberRange + label: formEditor.elements.TextMixin.editor.validators.NumberRange.label + 90: + value: RegularExpression + label: formEditor.elements.TextMixin.editor.validators.RegularExpression.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + properties: + confirmationLabel: formEditor.element.AdvancedPassword.editor.confirmationLabel.predefinedDefaults + propertyCollections: + validators: + 10: + identifier: Alphanumeric + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Alphanumeric.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 20: + identifier: Text + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Text.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 30: + identifier: StringLength + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.StringLength.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.minlength + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.maxlength + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 40: + identifier: EmailAddress + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.EmailAddress.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 50: + identifier: Integer + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Integer.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 60: + identifier: Float + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Float.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 70: + identifier: NumberRange + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.NumberRange.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 80: + identifier: RegularExpression + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.header.label + 200: + identifier: regex + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.label + fieldExplanationText: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.fieldExplanationText + propertyPath: options.regularExpression + propertyValidators: + 10: NotEmpty + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + label: formEditor.elements.AdvancedPassword.label + group: custom + groupSorting: 500 + iconIdentifier: t3-form-icon-advanced-password diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..715ae335dcca6b89050a29d1fa5db24be78830b4 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/100.rst @@ -0,0 +1,29 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + AdvancedPassword: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..ff477b151f4a4a875d775d8ba3a21afd25601bbd --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/200.rst @@ -0,0 +1,31 @@ +formEditor.editors.200 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + AdvancedPassword: + formEditor: + editors: + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..0f31b7eea38e89f52e447f8147adea8603169aab --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/300.rst @@ -0,0 +1,31 @@ +formEditor.editors.300 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.editors.300 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + AdvancedPassword: + formEditor: + editors: + 300: + identifier: confirmationLabel + templateName: Inspector-TextEditor + label: formEditor.elements.AdvancedPassword.editor.confirmationLabel.label + propertyPath: properties.confirmationLabel diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/400.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/400.rst new file mode 100644 index 0000000000000000000000000000000000000000..bfe647ee4d21ea5017978bc5e60a3982f63cec93 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/400.rst @@ -0,0 +1,33 @@ +formEditor.editors.400 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.editors.400 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + AdvancedPassword: + formEditor: + editors: + 400: + identifier: placeholder + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.placeholder.label + propertyPath: properties.fluidAdditionalAttributes.placeholder + compatibilityPropertyPath: properties.placeholder + doNotSetIfPropertyValueIsEmpty: true diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/700.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/700.rst new file mode 100644 index 0000000000000000000000000000000000000000..311ec910fa9004deb82138cf827cf8ec5f25f656 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/700.rst @@ -0,0 +1,48 @@ +formEditor.editors.700 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.editors.700 + +:aspect:`Data type` + array/ :ref:`[GridColumnViewPortConfigurationEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + AdvancedPassword: + formEditor: + editors: + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/800.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/800.rst new file mode 100644 index 0000000000000000000000000000000000000000..6d0c6be67b002eaaaa7c77bb23c47fdeafc362ac --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/800.rst @@ -0,0 +1,34 @@ +formEditor.editors.800 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.editors.800 + +:aspect:`Data type` + array/ :ref:`[RequiredValidatorEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + AdvancedPassword: + formEditor: + editors: + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/900.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/900.rst new file mode 100644 index 0000000000000000000000000000000000000000..487114f7796a51803e693aa2087632a655bae5c6 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/900.rst @@ -0,0 +1,58 @@ +formEditor.editors.900 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.editors.900 + +:aspect:`Data type` + array/ :ref:`[ValidatorsEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.validatorseditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + AdvancedPassword: + formEditor: + editors: + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.TextMixin.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.TextMixin.editor.validators.EmptyValue.label + 20: + value: Alphanumeric + label: formEditor.elements.TextMixin.editor.validators.Alphanumeric.label + 30: + value: Text + label: formEditor.elements.TextMixin.editor.validators.Text.label + 40: + value: StringLength + label: formEditor.elements.TextMixin.editor.validators.StringLength.label + 50: + value: EmailAddress + label: formEditor.elements.TextMixin.editor.validators.EmailAddress.label + 60: + value: Integer + label: formEditor.elements.TextMixin.editor.validators.Integer.label + 70: + value: Float + label: formEditor.elements.TextMixin.editor.validators.Float.label + 80: + value: NumberRange + label: formEditor.elements.TextMixin.editor.validators.NumberRange.label + 90: + value: RegularExpression + label: formEditor.elements.TextMixin.editor.validators.RegularExpression.label diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..2597d35e88e953525fe34618927e1bc607f8f0f2 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/editors/9999.rst @@ -0,0 +1,29 @@ +formEditor.editors.9999 +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + AdvancedPassword: + formEditor: + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/group.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/group.rst new file mode 100644 index 0000000000000000000000000000000000000000..24895cbecbffb609f0aa89782e84feed96af318b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/group.rst @@ -0,0 +1,30 @@ +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + AdvancedPassword: + formEditor: + group: custom + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/groupSorting.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/groupSorting.rst new file mode 100644 index 0000000000000000000000000000000000000000..3865faec728095e2c19d0a270f3ccf892ece3d6f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/groupSorting.rst @@ -0,0 +1,29 @@ +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + AdvancedPassword: + formEditor: + groupSorting: 500 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..5ca6f5f4e6490f574e5800838340bb63be879ec1 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + AdvancedPassword: + formEditor: + iconIdentifier: t3-form-icon-advanced-password + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..35025fe3014f8f76f8b18fea5298811f95db15e8 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/label.rst @@ -0,0 +1,29 @@ +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + AdvancedPassword: + formEditor: + label: formEditor.elements.AdvancedPassword.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..038f314a8fbb7addaa8f7b1ab73cd9991f6cf33d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/predefinedDefaults.rst @@ -0,0 +1,31 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + AdvancedPassword: + formEditor: + predefinedDefaults: + properties: + confirmationLabel: formEditor.element.AdvancedPassword.editor.confirmationLabel.predefinedDefaults + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/10.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/10.rst new file mode 100644 index 0000000000000000000000000000000000000000..8764cb0a742842daeba8c959cc595416041b2cae --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/10.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.10 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.10 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 10: + identifier: Alphanumeric + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Alphanumeric.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/10/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/10/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..9ba32ba0106465f90a32d7457e3d1e5265d8c221 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/10/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.10.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.10.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 10: + identifier: Alphanumeric + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Alphanumeric.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/10/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/10/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..789f7eba21012562c032fc05810c5fc9f8c83493 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/10/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.10.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.10.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 10: + identifier: Alphanumeric + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/10/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/10/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..aa305afc454d4d57392411797b81dd95af615563 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/10/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.10.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.10.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 10: + identifier: Alphanumeric + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/20.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/20.rst new file mode 100644 index 0000000000000000000000000000000000000000..8740529673f69f4f5f1e2dff1c9ecc4acffa614b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/20.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.20 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.20 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 20: + identifier: Text + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Text.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/20/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/20/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..83846da8f2de12bbe0f9e3532b8815a48d8f149f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/20/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.20.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.20.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 20: + identifier: Text + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Text.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/20/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/20/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..3c1665d795389da9d78582cf9f47316d36e7076f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/20/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.20.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.20.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 20: + identifier: Text + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/20/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/20/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..ce07224a71ba9973540c7be4c021481ea4d4b19c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/20/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.20.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.20.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 20: + identifier: Text + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/30.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/30.rst new file mode 100644 index 0000000000000000000000000000000000000000..3430d4420546f3186caa4487c2008583fe0f03c6 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/30.rst @@ -0,0 +1,57 @@ +formEditor.propertyCollections.validators.30 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.30 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.StringLength.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.minlength + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.maxlength + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/30/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/30/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..f3789c0ce4f65fe216501595f01b6acd23752f23 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/30/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.30.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.30.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.StringLength.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/30/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/30/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..96af2666f8da540554dddfdbe653052c39e4c803 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/30/editors/200.rst @@ -0,0 +1,39 @@ +formEditor.propertyCollections.validators.30.editors.200 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.30.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + editors: + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.minlength + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/30/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/30/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..5bd95db8a4e823dcf17f9ebfb184bdabad5cc8ea --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/30/editors/300.rst @@ -0,0 +1,39 @@ +formEditor.propertyCollections.validators.30.editors.300 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.30.editors.300 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + editors: + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.maxlength + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/30/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/30/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..a29ba5351962cbd0fe05af449df11b3e8a8c3410 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/30/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.30.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.30.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/30/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/30/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..b4bf710b6b7308930eb0e2da8b8bcdc43391221c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/30/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.30.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.30.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/40.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/40.rst new file mode 100644 index 0000000000000000000000000000000000000000..bb7b4ee3b8e0a58ecaa455ab019942e21de4d9a1 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/40.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.40 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.40 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 40: + identifier: EmailAddress + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.EmailAddress.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/40/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/40/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..2ae87f92aa771490a1b472f424bec53864da3df5 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/40/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.40.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.40.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 40: + identifier: EmailAddress + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.EmailAddress.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/40/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/40/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..e7f6e7b4996198576ce6cb7bfda3f0e28187cf35 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/40/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.40.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.40.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 40: + identifier: EmailAddress + editors: + 100: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/40/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/40/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..38ea31547538e56575fcea6a1d23c1f68ec7f60c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/40/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.40.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.40.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 40: + identifier: EmailAddress + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/50.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/50.rst new file mode 100644 index 0000000000000000000000000000000000000000..5e8e11ecf93867c3fdcca9557d7bd914a0130114 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/50.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.50 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.50 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 50: + identifier: Integer + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Integer.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/50/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/50/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..fa9eb52e73743047240f91a43db859dab60adc02 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/50/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.50.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.50.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 50: + identifier: Integer + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Integer.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/50/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/50/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..09ca4263a864f2c32364c8bb694ee82f26e32cec --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/50/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.50.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.50.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 50: + identifier: Integer + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/50/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/50/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..5b5856ee47cbd4a7a3f6f1cd61f737b96933ea56 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/50/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.50.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.50.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 50: + identifier: Integer + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/60.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/60.rst new file mode 100644 index 0000000000000000000000000000000000000000..ae795d935caef976b351567e416b1e16bcfe795e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/60.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.60 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.60 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 60: + identifier: Float + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Float.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/60/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/60/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..12f90e2f431952af83e61f510312181086fe7a46 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/60/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.60.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.60.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 60: + identifier: Float + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Float.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/60/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/60/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..1fb1dcf669d18804f2b5e88fce4225527bd0b6f5 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/60/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.60.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.60.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 60: + identifier: Float + editors: + 100: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/60/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/60/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..92e9d57bf1b8e1618c19ea5ecc242a940b5b8bc7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/60/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.60.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.60.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 60: + identifier: Float + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/70.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/70.rst new file mode 100644 index 0000000000000000000000000000000000000000..da6347601e8b2b4629a3b92c6f3e3bff6800ab57 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/70.rst @@ -0,0 +1,53 @@ +formEditor.propertyCollections.validators.70 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.70 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.NumberRange.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/70/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/70/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..15bc655c344c6a1d883fe4e675e146526feeefb1 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/70/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.70.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.70.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.NumberRange.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/70/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/70/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..5dac71d1ccede7fc9a09d80b2f58e69f005b1737 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/70/editors/200.rst @@ -0,0 +1,37 @@ +formEditor.propertyCollections.validators.70.editors.200 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.70.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + editors: + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/70/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/70/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..5f837e00ba5bb7a3a25c4d23a58c30efaad51acc --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/70/editors/300.rst @@ -0,0 +1,36 @@ +formEditor.propertyCollections.validators.70.editors.300 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.70.editors.300 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + editors: + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/70/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/70/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..c5cbc03064e259fa4974a384c449ef8818af944b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/70/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.70.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.70.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/70/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/70/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..f14aba0500dd4cc2040d2205e869a38c3896b352 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/70/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.70.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.70.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/80.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/80.rst new file mode 100644 index 0000000000000000000000000000000000000000..b86d3a4cae1f83b729d6d60a67d3c1015ee70e15 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/80.rst @@ -0,0 +1,43 @@ +formEditor.propertyCollections.validators.80 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.80 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 80: + identifier: RegularExpression + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.header.label + 200: + identifier: regex + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.label + fieldExplanationText: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.fieldExplanationText + propertyPath: options.regularExpression + propertyValidators: + 10: NotEmpty + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/80/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/80/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..a7d0a53d5b929382cfa8d925f9f83be4961d0cef --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/80/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.80.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.80.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 80: + identifier: RegularExpression + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/80/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/80/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..ff9a40fdd71c47c0f6448c6e9bde24104d7f0c6f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/80/editors/200.rst @@ -0,0 +1,36 @@ +formEditor.propertyCollections.validators.80.editors.200 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.80.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 80: + identifier: RegularExpression + editors: + 200: + identifier: regex + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.label + fieldExplanationText: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.fieldExplanationText + propertyPath: options.regularExpression + propertyValidators: + 10: NotEmpty + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/80/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/80/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..a93ef25ffffee7f4035198948ecacb6e2922b291 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/80/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.80.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.80.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 80: + identifier: RegularExpression + editors: + 100: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/80/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/80/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..ad358593a063f15e923de7905897f845c5486754 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/formEditor/propertyCollections/validators/80/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.80.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.80.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + AdvancedPassword: + formEditor: + propertyCollections: + validators: + 80: + identifier: RegularExpression + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..b77cbdd8d4ef6b29e20339faa0a705884d1c1bf8 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + AdvancedPassword: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\AdvancedPassword + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/properties/confirmationClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/properties/confirmationClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..2b7ca7bad096b11a4143138e19f7f100f1431a46 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/properties/confirmationClassAttribute.rst @@ -0,0 +1,39 @@ +properties.confirmationClassAttribute +------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.properties.confirmationClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 7 + + AdvancedPassword: + properties: + containerClassAttribute: input + elementClassAttribute: input-medium + elementErrorClassAttribute: error + confirmationLabel: '' + confirmationClassAttribute: input-medium + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class written to the password confirmation form element. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/properties/confirmationLabel.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/properties/confirmationLabel.rst new file mode 100644 index 0000000000000000000000000000000000000000..78f92aa5d7b6f97292b0fff8e70130fb165661e4 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/properties/confirmationLabel.rst @@ -0,0 +1,39 @@ +properties.confirmationLabel +---------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.properties.confirmationLabel + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + Yes + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + AdvancedPassword: + properties: + containerClassAttribute: input + elementClassAttribute: input-medium + elementErrorClassAttribute: error + confirmationLabel: '' + confirmationClassAttribute: input-medium + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The label for the password confirmation form element. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/properties/containerClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/properties/containerClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..84759d889a64005846d96ee3b4adf7202f5bb8e9 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/properties/containerClassAttribute.rst @@ -0,0 +1,39 @@ +properties.containerClassAttribute +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.properties.containerClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + AdvancedPassword: + properties: + containerClassAttribute: input + elementClassAttribute: input-medium + elementErrorClassAttribute: error + confirmationLabel: '' + confirmationClassAttribute: input-medium + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is typically wrapped around the form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/properties/elementClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/properties/elementClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..6c029f7ce49f93af9c1a1364cb64dd1a829f66ad --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/properties/elementClassAttribute.rst @@ -0,0 +1,39 @@ +properties.elementClassAttribute +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.properties.elementClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + AdvancedPassword: + properties: + containerClassAttribute: input + elementClassAttribute: input-medium + elementErrorClassAttribute: error + confirmationLabel: '' + confirmationClassAttribute: input-medium + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class written to the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/properties/elementErrorClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/properties/elementErrorClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..db16a00e88eda665c5a9d8587b0c6a2aac9c658b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/AdvancedPassword/properties/elementErrorClassAttribute.rst @@ -0,0 +1,39 @@ +properties.elementErrorClassAttribute +------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.properties.elementErrorClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + AdvancedPassword: + properties: + containerClassAttribute: input + elementClassAttribute: input-medium + elementErrorClassAttribute: error + confirmationLabel: '' + confirmationClassAttribute: input-medium + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is written to the form element if validation errors exists. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox.rst new file mode 100644 index 0000000000000000000000000000000000000000..adc6d880ce6caaed50d0a801250493f4f9710054 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox.rst @@ -0,0 +1,62 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.checkbox: + +========== +[Checkbox] +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.checkbox-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.implementationclassname: +.. include:: Checkbox/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.properties.containerclassattribute: +.. include:: Checkbox/properties/containerClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.properties.elementclassattribute: +.. include:: Checkbox/properties/elementClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.properties.elementerrorclassattribute: +.. include:: Checkbox/properties/elementErrorClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.properties.value: +.. include:: Checkbox/properties/value.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.formeditor: +.. include:: Checkbox/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.formeditor.editors.100: +.. include:: Checkbox/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.formeditor.editors.200: +.. include:: Checkbox/formEditor/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.formeditor.editors.700: +.. include:: Checkbox/formEditor/editors/700.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.formeditor.editors.800: +.. include:: Checkbox/formEditor/editors/800.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.formeditor.editors.9999: +.. include:: Checkbox/formEditor/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.formeditor.predefineddefaults: +.. include:: Checkbox/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.formeditor.label: +.. include:: Checkbox/formEditor/label.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.formeditor.group: +.. include:: Checkbox/formEditor/group.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.formeditor.groupsorting: +.. include:: Checkbox/formEditor/groupSorting.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.formeditor.iconidentifier: +.. include:: Checkbox/formEditor/iconIdentifier.rst + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..b2950ab0d96a98a4ef0a906f5048df60fcfdf4c5 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor.rst @@ -0,0 +1,68 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + Checkbox: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: { } + label: formEditor.elements.Checkbox.label + group: select + groupSorting: 100 + iconIdentifier: t3-form-icon-checkbox diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..343b5a4246db4a65507141489d4fc4b887832ffd --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/editors/100.rst @@ -0,0 +1,29 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Checkbox: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..b8b5d7e095959c17e5e67afb93a1ac4b9e37baf0 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/editors/200.rst @@ -0,0 +1,31 @@ +formEditor.editors.200 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.formEditor.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Checkbox: + formEditor: + editors: + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/editors/700.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/editors/700.rst new file mode 100644 index 0000000000000000000000000000000000000000..4f9499184a1972eb0c7e5ebac10455ccfcbc2a3e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/editors/700.rst @@ -0,0 +1,49 @@ +formEditor.editors.700 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.formEditor.editors.700 + +:aspect:`Data type` + array/ :ref:`[GridColumnViewPortConfigurationEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Checkbox: + formEditor: + editors: + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/editors/800.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/editors/800.rst new file mode 100644 index 0000000000000000000000000000000000000000..61334c56a52bb776693b1b892500215f03b0f918 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/editors/800.rst @@ -0,0 +1,35 @@ +formEditor.editors.800 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.formEditor.editors.800 + +:aspect:`Data type` + array/ :ref:`[RequiredValidatorEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Checkbox: + formEditor: + editors: + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..8a9e2cbdaf3ff099b74ac79c7759247f80d951f1 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/editors/9999.rst @@ -0,0 +1,30 @@ +formEditor.editors.9999 +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.formEditor.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Checkbox: + formEditor: + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/group.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/group.rst new file mode 100644 index 0000000000000000000000000000000000000000..5fcc5f4c68b959e8a4095cf0ab219877733806ef --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/group.rst @@ -0,0 +1,30 @@ +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Checkbox: + formEditor: + group: select + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/groupSorting.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/groupSorting.rst new file mode 100644 index 0000000000000000000000000000000000000000..3d80ca8e56a354d93660f25d12164ad844ae718c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/groupSorting.rst @@ -0,0 +1,29 @@ +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Checkbox: + formEditor: + groupSorting: 100 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..4fdc99766ba1313e32dadbba034037f95e7221de --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Checkbox: + formEditor: + iconIdentifier: t3-form-icon-checkbox + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..b06f7cb6e9b517f39077f7873be1ffb5b4489254 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/label.rst @@ -0,0 +1,29 @@ +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Checkbox: + formEditor: + label: formEditor.elements.Checkbox.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..6248bd66c78683bc4edfa527600be301f01b7675 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/formEditor/predefinedDefaults.rst @@ -0,0 +1,29 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Checkbox: + formEditor: + predefinedDefaults: { } + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..6dad683f3d6ca1dde4e5c47b5d1daa915c29a257 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + Checkbox: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/properties/containerClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/properties/containerClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..e71d6679ad2b91f39ff45f53b5bb23d3c6ebafdd --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/properties/containerClassAttribute.rst @@ -0,0 +1,38 @@ +properties.containerClassAttribute +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.properties.containerClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Checkbox: + properties: + containerClassAttribute: 'input checkbox' + elementClassAttribute: add-on + elementErrorClassAttribute: error + value: 1 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is typically wrapped around the form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/properties/elementClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/properties/elementClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..02c7c48b6a2732a04e57499188d29e036ac8c8f8 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/properties/elementClassAttribute.rst @@ -0,0 +1,38 @@ +properties.elementClassAttribute +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.properties.elementClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + Checkbox: + properties: + containerClassAttribute: 'input checkbox' + elementClassAttribute: add-on + elementErrorClassAttribute: error + value: 1 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class written to the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/properties/elementErrorClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/properties/elementErrorClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..64fed7fa9c6312e20e230c11fb1395d5e2931015 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/properties/elementErrorClassAttribute.rst @@ -0,0 +1,38 @@ +properties.elementErrorClassAttribute +------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.properties.elementErrorClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + Checkbox: + properties: + containerClassAttribute: 'input checkbox' + elementClassAttribute: add-on + elementErrorClassAttribute: error + value: 1 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is written to the form element if validation errors exists. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/properties/value.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/properties/value.rst new file mode 100644 index 0000000000000000000000000000000000000000..e8199c5b11e42bdde36846e3a78953b561dda230 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Checkbox/properties/value.rst @@ -0,0 +1,38 @@ +properties.value +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.properties.value + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Checkbox: + properties: + containerClassAttribute: 'input checkbox' + elementClassAttribute: add-on + elementErrorClassAttribute: error + value: 1 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The value of the checkbox which should be sent to the server. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..6c5312f343c0ab8ffdd386100dadf3f1c80f25f3 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement.rst @@ -0,0 +1,46 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.contentelement: + +================ +[ContentElement] +================ + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.contentelement-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.contentelement.implementationclassname: +.. include:: ContentElement/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.contentelement.properties.contentelementuid: +.. include:: ContentElement/properties/contentElementUid.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.contentelement.formeditor: +.. include:: ContentElement/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.contentelement.formeditor.editors.100: +.. include:: ContentElement/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.contentelement.formeditor.editors.300: +.. include:: ContentElement/formEditor/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.contentelement.formeditor.editors.9999: +.. include:: ContentElement/formEditor/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.contentelement.formeditor.predefineddefaults: +.. include:: ContentElement/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.contentelement.formeditor.label: +.. include:: ContentElement/formEditor/label.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.contentelement.formeditor.group: +.. include:: ContentElement/formEditor/group.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.contentelement.formeditor.groupsorting: +.. include:: ContentElement/formEditor/groupSorting.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.contentelement.formeditor.iconidentifier: +.. include:: ContentElement/formEditor/iconIdentifier.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..b868af585ff1c570522efb54321d3d5bdb5462ce --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor.rst @@ -0,0 +1,47 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ContentElement.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + ContentElement: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 300: + identifier: contentElement + templateName: Inspector-Typo3WinBrowserEditor + label: formEditor.elements.ContentElement.editor.contentElement.label + buttonLabel: formEditor.elements.ContentElement.editor.contentElement.buttonLabel + browsableType: tt_content + propertyPath: properties.contentElementUid + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + properties: + contentElementUid: '' + label: formEditor.elements.ContentElement.label + group: custom + groupSorting: 700 + iconIdentifier: t3-form-icon-content-element diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..3523b790f21df97907555c8514765a0bf0fc0137 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/editors/100.rst @@ -0,0 +1,29 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ContentElement.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + ContentElement: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..62ea0d4a9ecef2af2bc126f253c8a169016f7055 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/editors/300.rst @@ -0,0 +1,37 @@ +formEditor.editors.300 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ContentElement.formEditor.editors.300 + +:aspect:`Data type` + array/ :ref:`[Typo3WinBrowserEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.typo3winbrowsereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + ContentElement: + formEditor: + editors: + 300: + identifier: contentElement + templateName: Inspector-Typo3WinBrowserEditor + label: formEditor.elements.ContentElement.editor.contentElement.label + buttonLabel: formEditor.elements.ContentElement.editor.contentElement.buttonLabel + browsableType: tt_content + propertyPath: properties.contentElementUid + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..1f623822987eb9403b88b424eab1b5ac08a3ba55 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/editors/9999.rst @@ -0,0 +1,30 @@ +formEditor.editors.9999 +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ContentElement.formEditor.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + ContentElement: + formEditor: + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/group.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/group.rst new file mode 100644 index 0000000000000000000000000000000000000000..075b75e2455a355c64b0f05526a8e570cc6053ac --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/group.rst @@ -0,0 +1,30 @@ +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ContentElement.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + ContentElement: + formEditor: + group: custom + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/groupSorting.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/groupSorting.rst new file mode 100644 index 0000000000000000000000000000000000000000..67d1111bdf1796e0a36084e8e5a92cd2a331a9dc --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/groupSorting.rst @@ -0,0 +1,29 @@ +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ContentElement.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + ContentElement: + formEditor: + groupSorting: 700 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..94f2f8b4e30e1dec95f4da17ff3b6af9e080c019 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ContentElement.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + ContentElement: + formEditor: + iconIdentifier: t3-form-icon-content-element + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..e4cac8d7edb05fdd0983208bfcd4c2d1bc142696 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/label.rst @@ -0,0 +1,29 @@ +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ContentElement.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + ContentElement: + formEditor: + label: formEditor.elements.ContentElement.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..70f2dbc9cf9524cee4ab3e6e9d3488d0b7e51b66 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/formEditor/predefinedDefaults.rst @@ -0,0 +1,31 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ContentElement.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + ContentElement: + formEditor: + predefinedDefaults: + properties: + contentElementUid: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..62f2d3a94cf39fb2a6d4cfc35956ce821e23239c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ContentElement.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + ContentElement: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/properties/contentElementUid.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/properties/contentElementUid.rst new file mode 100644 index 0000000000000000000000000000000000000000..852a296cafed26512453749f2229580de1212191 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ContentElement/properties/contentElementUid.rst @@ -0,0 +1,35 @@ +properties.contentElementUid +---------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ContentElement.properties.contentElementUid + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + Yes + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + ContentElement: + properties: + contentElementUid: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The uid of the content element which should be rendered. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker.rst new file mode 100644 index 0000000000000000000000000000000000000000..a22f3b9d9d4a8c73440a066ff611cbf6ca588d8c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker.rst @@ -0,0 +1,100 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.datepicker: + +============ +[DatePicker] +============ + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.datepicker-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.implementationclassname: +.. include:: DatePicker/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.properties.containerclassattribute: +.. include:: DatePicker/properties/containerClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.properties.elementclassattribute: +.. include:: DatePicker/properties/elementClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.properties.elementerrorclassattribute: +.. include:: DatePicker/properties/elementErrorClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.properties.timeselectorclassattribute: +.. include:: DatePicker/properties/timeSelectorClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.properties.timeselectorhourlabel: +.. include:: DatePicker/properties/timeSelectorHourLabel.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.properties.timeselectorminutelabel: +.. include:: DatePicker/properties/timeSelectorMinuteLabel.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.properties.dateformat: +.. include:: DatePicker/properties/dateFormat.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.properties.enabledatepicker: +.. include:: DatePicker/properties/enableDatePicker.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.properties.displaytimeselector: +.. include:: DatePicker/properties/displayTimeSelector.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor: +.. include:: DatePicker/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.editors.100: +.. include:: DatePicker/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.editors.200: +.. include:: DatePicker/formEditor/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.editors.300: +.. include:: DatePicker/formEditor/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.editors.400: +.. include:: DatePicker/formEditor/editors/400.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.editors.500: +.. include:: DatePicker/formEditor/editors/500.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.editors.700: +.. include:: DatePicker/formEditor/editors/700.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.editors.800: +.. include:: DatePicker/formEditor/editors/800.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.editors.900: +.. include:: DatePicker/formEditor/editors/900.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.editors.9999: +.. include:: DatePicker/formEditor/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.predefineddefaults: +.. include:: DatePicker/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.propertycollections.validators.10: +.. include:: DatePicker/formEditor/propertyCollections/validators/10.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.propertycollections.validators.10.identifier: +.. include:: DatePicker/formEditor/propertyCollections/validators/10/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.propertycollections.validators.10.editors.100: +.. include:: DatePicker/formEditor/propertyCollections/validators/10/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.propertycollections.validators.10.editors.9999: +.. include:: DatePicker/formEditor/propertyCollections/validators/10/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.label: +.. include:: DatePicker/formEditor/label.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.group: +.. include:: DatePicker/formEditor/group.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.groupsorting: +.. include:: DatePicker/formEditor/groupSorting.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.iconidentifier: +.. include:: DatePicker/formEditor/iconIdentifier.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..8ed60ad131c9deec50d0411e53870bbd4f1c58c4 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor.rst @@ -0,0 +1,110 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + DatePicker: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 300: + identifier: dateFormat + templateName: Inspector-TextEditor + label: formEditor.elements.DatePicker.editor.dateFormat.label + propertyPath: properties.dateFormat + 400: + identifier: enableDatePicker + templateName: Inspector-CheckboxEditor + label: formEditor.elements.DatePicker.editor.enableDatePicker.label + propertyPath: properties.enableDatePicker + 500: + identifier: displayTimeSelector + templateName: Inspector-CheckboxEditor + label: formEditor.elements.DatePicker.editor.displayTimeSelector.label + propertyPath: properties.displayTimeSelector + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.DatePicker.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.DatePicker.editor.validators.EmptyValue.label + 20: + value: DateTime + label: formEditor.elements.DatePicker.editor.validators.DateTime.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + properties: + dateFormat: Y-m-d + enableDatePicker: true + displayTimeSelector: false + label: formEditor.elements.DatePicker.label + group: custom + groupSorting: 200 + iconIdentifier: t3-form-icon-date-picker + propertyCollections: + validators: + 10: + identifier: DateTime + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.DatePicker.validators.DateTime.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..e9eb53f3376cbe3172b5f08227dfbb13f08b6eeb --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/100.rst @@ -0,0 +1,29 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + DatePicker: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..31f0d115e816dd64fc8432bccd6e15cd120d1b1b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/200.rst @@ -0,0 +1,31 @@ +formEditor.editors.200 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + DatePicker: + formEditor: + editors: + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..466df81353e20bb01912662fc6467788488c16ca --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/300.rst @@ -0,0 +1,31 @@ +formEditor.editors.300 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.editors.300 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + DatePicker: + formEditor: + editors: + 300: + identifier: dateFormat + templateName: Inspector-TextEditor + label: formEditor.elements.DatePicker.editor.dateFormat.label + propertyPath: properties.dateFormat diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/400.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/400.rst new file mode 100644 index 0000000000000000000000000000000000000000..fd0b4919336f9e23bd893958cc9ac2c7189aa2d9 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/400.rst @@ -0,0 +1,32 @@ +formEditor.editors.400 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.editors.400 + +:aspect:`Data type` + array/ :ref:`[CheckboxEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.checkboxeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + DatePicker: + formEditor: + editors: + 400: + identifier: enableDatePicker + templateName: Inspector-CheckboxEditor + label: formEditor.elements.DatePicker.editor.enableDatePicker.label + propertyPath: properties.enableDatePicker + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/500.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/500.rst new file mode 100644 index 0000000000000000000000000000000000000000..75e173b4a3defe8184a4f2425caeff5e4852453d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/500.rst @@ -0,0 +1,32 @@ +formEditor.editors.500 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.editors.500 + +:aspect:`Data type` + array/ :ref:`[CheckboxEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.checkboxeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + AdvancedPassword: + formEditor: + editors: + 500: + identifier: displayTimeSelector + templateName: Inspector-CheckboxEditor + label: formEditor.elements.DatePicker.editor.displayTimeSelector.label + propertyPath: properties.displayTimeSelector + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/700.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/700.rst new file mode 100644 index 0000000000000000000000000000000000000000..75d503c77973e3fe764a7120c4475ac3d5f9fa32 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/700.rst @@ -0,0 +1,49 @@ +formEditor.editors.700 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.editors.700 + +:aspect:`Data type` + array/ :ref:`[GridColumnViewPortConfigurationEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + DatePicker: + formEditor: + editors: + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/800.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/800.rst new file mode 100644 index 0000000000000000000000000000000000000000..adb5a0df9b074d4479dd332e559e517992839e61 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/800.rst @@ -0,0 +1,35 @@ +formEditor.editors.800 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.editors.800 + +:aspect:`Data type` + array/ :ref:`[RequiredValidatorEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + DatePicker: + formEditor: + editors: + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/900.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/900.rst new file mode 100644 index 0000000000000000000000000000000000000000..485d69630f9a42c4cfac612b4b0266a0c9a274a7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/900.rst @@ -0,0 +1,38 @@ +formEditor.editors.900 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.editors.900 + +:aspect:`Data type` + array/ :ref:`[ValidatorsEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.validatorseditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + DatePicker: + formEditor: + editors: + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.DatePicker.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.DatePicker.editor.validators.EmptyValue.label + 20: + value: DateTime + label: formEditor.elements.DatePicker.editor.validators.DateTime.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..a70cd8862cbdac67686ccbca7e29572cd48bd6ed --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/editors/9999.rst @@ -0,0 +1,30 @@ +formEditor.editors.9999 +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + DatePicker: + formEditor: + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/group.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/group.rst new file mode 100644 index 0000000000000000000000000000000000000000..dd5decf18da177c32c664130754ad965c35fed62 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/group.rst @@ -0,0 +1,30 @@ +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + DatePicker: + formEditor: + group: custom + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/groupSorting.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/groupSorting.rst new file mode 100644 index 0000000000000000000000000000000000000000..3d75e32eee36468042b8a6115142d04e21f65f84 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/groupSorting.rst @@ -0,0 +1,29 @@ +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + DatePicker: + formEditor: + groupSorting: 200 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..00d53193d41ae94001909bff324632e07d112ac0 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + DatePicker: + formEditor: + iconIdentifier: t3-form-icon-date-picker + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..c6c8b2d34653ad4e78742fece0a9098c2132b24e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/label.rst @@ -0,0 +1,29 @@ +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + DatePicker: + formEditor: + label: formEditor.elements.DatePicker.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..443a5f0b7e2c1b6b546bbef0497c5fc24a820fba --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/predefinedDefaults.rst @@ -0,0 +1,33 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + DatePicker: + formEditor: + predefinedDefaults: + properties: + dateFormat: Y-m-d + enableDatePicker: true + displayTimeSelector: false + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/propertyCollections/validators/10.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/propertyCollections/validators/10.rst new file mode 100644 index 0000000000000000000000000000000000000000..c5a5d59d586b5eca78766da0b010d82e5d868f2b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/propertyCollections/validators/10.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.10 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.propertyCollections.validators.10 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + DatePicker: + formEditor: + propertyCollections: + validators: + 10: + identifier: DateTime + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.DatePicker.validators.DateTime.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/propertyCollections/validators/10/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/propertyCollections/validators/10/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..9b97767c1a84bee7cee5868ee7b572d5e38a7f58 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/propertyCollections/validators/10/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.10.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.propertyCollections.validators.10.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + DatePicker: + formEditor: + propertyCollections: + validators: + 10: + identifier: DateTime + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.DatePicker.validators.DateTime.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/propertyCollections/validators/10/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/propertyCollections/validators/10/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..2e991043230282698a81f18096b975ef41ad23ad --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/propertyCollections/validators/10/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.10.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.propertyCollections.validators.10.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + DatePicker: + formEditor: + propertyCollections: + validators: + 10: + identifier: DateTime + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/propertyCollections/validators/10/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/propertyCollections/validators/10/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..bccfa1c996cf916eff6b553b43525d2d0b255f3a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/formEditor/propertyCollections/validators/10/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.10.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.propertyCollections.validators.10.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + DatePicker: + formEditor: + propertyCollections: + validators: + 10: + identifier: DateTime + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..2c849b47296a162cf9461e64cc79906daeca0b51 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + DatePicker: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\DatePicker + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/containerClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/containerClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..b3c7688b3f488e118c34b3cf1323d425689207c4 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/containerClassAttribute.rst @@ -0,0 +1,43 @@ +properties.containerClassAttribute +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.properties.containerClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + DatePicker: + properties: + containerClassAttribute: input + elementClassAttribute: 'small form-control' + elementErrorClassAttribute: error + timeSelectorClassAttribute: mini + timeSelectorHourLabel: '' + timeSelectorMinuteLabel: '' + dateFormat: Y-m-d + enableDatePicker: true + displayTimeSelector: false + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is typically wrapped around the form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/dateFormat.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/dateFormat.rst new file mode 100644 index 0000000000000000000000000000000000000000..c47efad03f6e68a0317d668821d5e089b0ed411f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/dateFormat.rst @@ -0,0 +1,43 @@ +properties.dateFormat +--------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.properties.dateFormat + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + Yes + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + DatePicker: + properties: + containerClassAttribute: input + elementClassAttribute: 'small form-control' + elementErrorClassAttribute: error + timeSelectorClassAttribute: mini + timeSelectorHourLabel: '' + timeSelectorMinuteLabel: '' + dateFormat: Y-m-d + enableDatePicker: true + displayTimeSelector: false + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The datepicker time format. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/displayTimeSelector.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/displayTimeSelector.rst new file mode 100644 index 0000000000000000000000000000000000000000..0270bb983e654124537e14b4c0e9ea17f4c6e5a8 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/displayTimeSelector.rst @@ -0,0 +1,43 @@ +properties.displayTimeSelector +------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.properties.displayTimeSelector + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + Yes + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 11 + + DatePicker: + properties: + containerClassAttribute: input + elementClassAttribute: 'small form-control' + elementErrorClassAttribute: error + timeSelectorClassAttribute: mini + timeSelectorHourLabel: '' + timeSelectorMinuteLabel: '' + dateFormat: Y-m-d + enableDatePicker: true + displayTimeSelector: false + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + If set to true, an additional timeselector will be shown. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/elementClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/elementClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..b6c4dcf274f738852168350602bddff60f761ae2 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/elementClassAttribute.rst @@ -0,0 +1,43 @@ +properties.elementClassAttribute +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.properties.elementClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + DatePicker: + properties: + containerClassAttribute: input + elementClassAttribute: 'small form-control' + elementErrorClassAttribute: error + timeSelectorClassAttribute: mini + timeSelectorHourLabel: '' + timeSelectorMinuteLabel: '' + dateFormat: Y-m-d + enableDatePicker: true + displayTimeSelector: false + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class written to the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/elementErrorClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/elementErrorClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..a6c1893649b6c786fee69da2cb8eeea4d642ac55 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/elementErrorClassAttribute.rst @@ -0,0 +1,43 @@ +properties.elementErrorClassAttribute +------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.properties.elementErrorClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + DatePicker: + properties: + containerClassAttribute: input + elementClassAttribute: 'small form-control' + elementErrorClassAttribute: error + timeSelectorClassAttribute: mini + timeSelectorHourLabel: '' + timeSelectorMinuteLabel: '' + dateFormat: Y-m-d + enableDatePicker: true + displayTimeSelector: false + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is written to the form element if validation errors exists. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/enableDatePicker.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/enableDatePicker.rst new file mode 100644 index 0000000000000000000000000000000000000000..0d917d853302458fa17637e5c41e33f3c131a88d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/enableDatePicker.rst @@ -0,0 +1,43 @@ +properties.enableDatePicker +--------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.properties.enableDatePicker + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 10 + + DatePicker: + properties: + containerClassAttribute: input + elementClassAttribute: 'small form-control' + elementErrorClassAttribute: error + timeSelectorClassAttribute: mini + timeSelectorHourLabel: '' + timeSelectorMinuteLabel: '' + dateFormat: Y-m-d + enableDatePicker: true + displayTimeSelector: false + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + If set to true, an inline javascript will be rendered. This javascript binds the jquery UI datepicker to the formelement. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/timeSelectorClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/timeSelectorClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..d398966b746957fedce939e5db505e18182d1f45 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/timeSelectorClassAttribute.rst @@ -0,0 +1,43 @@ +properties.timeSelectorClassAttribute +------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.properties.timeSelectorClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + DatePicker: + properties: + containerClassAttribute: input + elementClassAttribute: 'small form-control' + elementErrorClassAttribute: error + timeSelectorClassAttribute: mini + timeSelectorHourLabel: '' + timeSelectorMinuteLabel: '' + dateFormat: Y-m-d + enableDatePicker: true + displayTimeSelector: false + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class written to the time selector form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/timeSelectorHourLabel.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/timeSelectorHourLabel.rst new file mode 100644 index 0000000000000000000000000000000000000000..f2df79e2048196c4dbbd9886de72501ca4e1bdf3 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/timeSelectorHourLabel.rst @@ -0,0 +1,43 @@ +properties.timeSelectorHourLabel +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.properties.timeSelectorHourLabel + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 7 + + DatePicker: + properties: + containerClassAttribute: input + elementClassAttribute: 'small form-control' + elementErrorClassAttribute: error + timeSelectorClassAttribute: mini + timeSelectorHourLabel: '' + timeSelectorMinuteLabel: '' + dateFormat: Y-m-d + enableDatePicker: true + displayTimeSelector: false + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The label for the hour selector. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/timeSelectorMinuteLabel.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/timeSelectorMinuteLabel.rst new file mode 100644 index 0000000000000000000000000000000000000000..f70f25a7afb15b0c15e439d596624826e841160e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/DatePicker/properties/timeSelectorMinuteLabel.rst @@ -0,0 +1,43 @@ +properties.timeSelectorMinuteLabel +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.properties.timeSelectorMinuteLabel + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8 + + DatePicker: + properties: + containerClassAttribute: input + elementClassAttribute: 'small form-control' + elementErrorClassAttribute: error + timeSelectorClassAttribute: mini + timeSelectorHourLabel: '' + timeSelectorMinuteLabel: '' + dateFormat: Y-m-d + enableDatePicker: true + displayTimeSelector: false + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The label for the minute selector. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset.rst new file mode 100644 index 0000000000000000000000000000000000000000..ac4c2fe8513db1abe54e23929b78c9abda55c7b8 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset.rst @@ -0,0 +1,61 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.fieldset: + +========== +[Fieldset] +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.fieldset-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fieldset.implementationclassname: +.. include:: Fieldset/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fieldset.properties.containerclassattribute: +.. include:: Fieldset/properties/containerClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fieldset.properties.elementclassattribute: +.. include:: Fieldset/properties/elementClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fieldset.properties.elementerrorclassattribute: +.. include:: Fieldset/properties/elementErrorClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fieldset.renderingoptions._iscompositeformelement: +.. include:: Fieldset/renderingOptions/_isCompositeFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fieldset.formeditor: +.. include:: Fieldset/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fieldset.formeditor.editors.100: +.. include:: Fieldset/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fieldset.formeditor.editors.200: +.. include:: Fieldset/formEditor/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fieldset.formeditor.editors.700: +.. include:: Fieldset/formEditor/editors/700.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fieldset.formeditor.editors.9999: +.. include:: Fieldset/formEditor/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fieldset.formeditor.predefineddefaults: +.. include:: Fieldset/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fieldset.formeditor.label: +.. include:: Fieldset/formEditor/label.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fieldset.formeditor.group: +.. include:: Fieldset/formEditor/group.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fieldset.formeditor.groupsorting: +.. include:: Fieldset/formEditor/groupSorting.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fieldset.formeditor.iconidentifier: +.. include:: Fieldset/formEditor/iconIdentifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fieldset.formeditor._iscompositeformelement: +.. include:: Fieldset/formEditor/_isCompositeFormElement.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..2efced83114521354f4c1ee8bb9a90a1856c3f5d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor.rst @@ -0,0 +1,62 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Fieldset.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + Fieldset: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.Fieldset.editor.label.label + propertyPath: label + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: { } + label: formEditor.elements.Fieldset.label + group: container + groupSorting: 100 + _isCompositeFormElement: true + iconIdentifier: t3-form-icon-fieldset diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/_isCompositeFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/_isCompositeFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..57b6d15616311dd24b1e3bfdcdca143eb4f42d8d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/_isCompositeFormElement.rst @@ -0,0 +1,29 @@ +formEditor._isCompositeFormElement +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Fieldset.formEditor._isCompositeFormElement + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Fieldset: + formEditor: + _isCompositeFormElement: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting to define that the form element contains child form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..aa7e036474eea98f4277d0916b183ff19ce5d82e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/editors/100.rst @@ -0,0 +1,29 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Fieldset.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Fieldset: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..9002c5aefbc5399244affca418404b9b29d27f13 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/editors/200.rst @@ -0,0 +1,31 @@ +formEditor.editors.200 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Fieldset.formEditor.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Fieldset: + formEditor: + editors: + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.Fieldset.editor.label.label + propertyPath: label diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/editors/700.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/editors/700.rst new file mode 100644 index 0000000000000000000000000000000000000000..984353e5da4f11dca1006964595d13d932863c14 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/editors/700.rst @@ -0,0 +1,49 @@ +formEditor.editors.700 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Fieldset.formEditor.editors.700 + +:aspect:`Data type` + array/ :ref:`[GridColumnViewPortConfigurationEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Fieldset: + formEditor: + editors: + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..fe59de56693aa08720158cdb35b00bc1d258a813 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/editors/9999.rst @@ -0,0 +1,30 @@ +formEditor.editors.9999 +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Fieldset.formEditor.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Fieldset: + formEditor: + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/group.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/group.rst new file mode 100644 index 0000000000000000000000000000000000000000..4aece39f65d4421fc97f64ac36a74f2b6c016267 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/group.rst @@ -0,0 +1,30 @@ +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Fieldset.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Fieldset: + formEditor: + group: container + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/groupSorting.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/groupSorting.rst new file mode 100644 index 0000000000000000000000000000000000000000..2962ae97e708ba27ae26da10feed37d3dbe8f591 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/groupSorting.rst @@ -0,0 +1,29 @@ +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Fieldset.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Fieldset: + formEditor: + groupSorting: 100 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..22f5d1c5008b80f231c3debd0503ceabe75082ec --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Fieldset.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Fieldset: + formEditor: + iconIdentifier: t3-form-icon-fieldset + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..f6df277ec7c668f0cf249000e396b4326ed8510e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/label.rst @@ -0,0 +1,29 @@ +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Fieldset.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Fieldset: + formEditor: + label: formEditor.elements.Fieldset.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..4314a007c7b2650098979c79014ceeea49fb3ff3 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/formEditor/predefinedDefaults.rst @@ -0,0 +1,29 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Fieldset.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Fieldset: + formEditor: + predefinedDefaults: { } + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..c6c128b5374d137b575a6d1c287b9749e61457ac --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Fieldset.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + Fieldset: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\Section + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/properties/containerClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/properties/containerClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..b65e44784986d5e3bb82be76bddf362fc7366ab2 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/properties/containerClassAttribute.rst @@ -0,0 +1,37 @@ +properties.containerClassAttribute +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Fieldset.properties.containerClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Fieldset: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is typically wrapped around the form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/properties/elementClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/properties/elementClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..71e18be3532d15d98119e68ce82b5fca7d78eb01 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/properties/elementClassAttribute.rst @@ -0,0 +1,37 @@ +properties.elementClassAttribute +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Fieldset.properties.elementClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + Fieldset: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class written to the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/properties/elementErrorClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/properties/elementErrorClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..083c4b7bc0dbe427dec096c1abeeff9aa6aa1246 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/properties/elementErrorClassAttribute.rst @@ -0,0 +1,37 @@ +properties.elementErrorClassAttribute +------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Fieldset.properties.elementErrorClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + Fieldset: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is written to the form element if validation errors exists. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/renderingOptions/_isCompositeFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/renderingOptions/_isCompositeFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..d02f6ead628c9c68eadaed41a2882cd6ec15d473 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Fieldset/renderingOptions/_isCompositeFormElement.rst @@ -0,0 +1,35 @@ +renderingOptions._isCompositeFormElement +---------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Fieldset.renderingOptions._isCompositeFormElement + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + AdvancedPassword: + renderingOptions: + _isCompositeFormElement: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting to define that the form element contains child form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload.rst new file mode 100644 index 0000000000000000000000000000000000000000..f58b5e15d5f52c470ba7d7ea6bf7bae604d4a629 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload.rst @@ -0,0 +1,70 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.fileupload: + +============ +[FileUpload] +============ + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.fileupload-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fileupload.implementationclassname: +.. include:: FileUpload/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fileupload.properties.containerclassattribute: +.. include:: FileUpload/properties/containerClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fileupload.properties.elementclassattribute: +.. include:: FileUpload/properties/elementClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fileupload.properties.elementerrorclassattribute: +.. include:: FileUpload/properties/elementErrorClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fileupload.properties.savetofilemount: +.. include:: FileUpload/properties/saveToFileMount.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fileupload.properties.allowedmimetypes: +.. include:: FileUpload/properties/allowedMimeTypes.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fileupload.formeditor: +.. include:: FileUpload/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fileupload.formeditor.editors.100: +.. include:: FileUpload/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fileupload.formeditor.editors.200: +.. include:: FileUpload/formEditor/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fileupload.formeditor.editors.300: +.. include:: FileUpload/formEditor/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fileupload.formeditor.editors.400: +.. include:: FileUpload/formEditor/editors/400.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fileupload.formeditor.editors.700: +.. include:: FileUpload/formEditor/editors/700.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fileupload.formeditor.editors.800: +.. include:: FileUpload/formEditor/editors/800.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fileupload.formeditor.editors.9999: +.. include:: FileUpload/formEditor/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fileupload.formeditor.predefineddefaults: +.. include:: FileUpload/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fileupload.formeditor.label: +.. include:: FileUpload/formEditor/label.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fileupload.formeditor.group: +.. include:: FileUpload/formEditor/group.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fileupload.formeditor.groupsorting: +.. include:: FileUpload/formEditor/groupSorting.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.fileupload.formeditor.iconidentifier: +.. include:: FileUpload/formEditor/iconIdentifier.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..23bb26f45d7f4a75ca350e726767c23b02231660 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor.rst @@ -0,0 +1,108 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + FileUpload: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 300: + identifier: allowedMimeTypes + templateName: Inspector-MultiSelectEditor + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.label + propertyPath: properties.allowedMimeTypes + selectOptions: + 10: + value: application/msword + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.doc + 20: + value: application/vnd.openxmlformats-officedocument.wordprocessingml.document + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.docx + 30: + value: application/msexcel + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.xls + 40: + value: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.xlsx + 50: + value: application/pdf + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.pdf + 60: + value: application/vnd.oasis.opendocument.text + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.odt + 70: + value: application/vnd.oasis.opendocument.spreadsheet-template + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.ods + 400: + identifier: saveToFileMount + templateName: Inspector-SingleSelectEditor + label: formEditor.elements.FileUploadMixin.editor.saveToFileMount.label + propertyPath: properties.saveToFileMount + selectOptions: + 10: + value: '1:/user_upload/' + label: '1:/user_upload/' + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + properties: + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - application/pdf + label: formEditor.elements.FileUpload.label + group: custom + groupSorting: 100 + iconIdentifier: t3-form-icon-file-upload diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..aac468971f14faa8aad6f0bd074ed4a6ed4337e6 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/100.rst @@ -0,0 +1,29 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + FileUpload: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..d20db1a45405d975a4a8bfa783d2584d19357479 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/200.rst @@ -0,0 +1,31 @@ +formEditor.editors.200 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + FileUpload: + formEditor: + editors: + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..ae0a29e3f927e08d1481be686468a1cd68e5b161 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/300.rst @@ -0,0 +1,53 @@ +formEditor.editors.300 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.editors.300 + +:aspect:`Data type` + array/ :ref:`[MultiSelectEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.multiselecteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + FileUpload: + formEditor: + editors: + 300: + identifier: allowedMimeTypes + templateName: Inspector-MultiSelectEditor + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.label + propertyPath: properties.allowedMimeTypes + selectOptions: + 10: + value: application/msword + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.doc + 20: + value: application/vnd.openxmlformats-officedocument.wordprocessingml.document + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.docx + 30: + value: application/msexcel + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.xls + 40: + value: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.xlsx + 50: + value: application/pdf + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.pdf + 60: + value: application/vnd.oasis.opendocument.text + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.odt + 70: + value: application/vnd.oasis.opendocument.spreadsheet-template + label: formEditor.elements.FileUpload.editor.allowedMimeTypes.ods diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/400.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/400.rst new file mode 100644 index 0000000000000000000000000000000000000000..bbf5396723823cd034e802351f7d097e0bb72181 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/400.rst @@ -0,0 +1,36 @@ +formEditor.editors.400 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.editors.400 + +:aspect:`Data type` + array/ :ref:`[SingleSelectEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.singleselecteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + FileUpload: + formEditor: + editors: + 400: + identifier: saveToFileMount + templateName: Inspector-SingleSelectEditor + label: formEditor.elements.FileUploadMixin.editor.saveToFileMount.label + propertyPath: properties.saveToFileMount + selectOptions: + 10: + value: '1:/user_upload/' + label: '1:/user_upload/' + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/700.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/700.rst new file mode 100644 index 0000000000000000000000000000000000000000..7bc6a8f21bab4c85cf4954d9c90860467de8a87d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/700.rst @@ -0,0 +1,49 @@ +formEditor.editors.700 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.editors.700 + +:aspect:`Data type` + array/ :ref:`[GridColumnViewPortConfigurationEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + FileUpload: + formEditor: + editors: + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/800.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/800.rst new file mode 100644 index 0000000000000000000000000000000000000000..69d6fa5b22b025dfb93e9919aca616ada6624b46 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/800.rst @@ -0,0 +1,35 @@ +formEditor.editors.800 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.editors.800 + +:aspect:`Data type` + array/ :ref:`[RequiredValidatorEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + FileUpload: + formEditor: + editors: + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..7f7b9c5071ed39e7e535c3d1b6a0d99f82c59d35 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/editors/9999.rst @@ -0,0 +1,30 @@ +formEditor.editors.9999 +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + FileUpload: + formEditor: + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/group.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/group.rst new file mode 100644 index 0000000000000000000000000000000000000000..b8c4ff1a32fcb414167adda7a582297ee2dc300b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/group.rst @@ -0,0 +1,30 @@ +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + FileUpload: + formEditor: + group: custom + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/groupSorting.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/groupSorting.rst new file mode 100644 index 0000000000000000000000000000000000000000..ba55525bf49e56dbb1dbbbd8f3dc1fe3f63c65e0 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/groupSorting.rst @@ -0,0 +1,29 @@ +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + FileUpload: + formEditor: + groupSorting: 100 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..56534e1233c9101f09bc9a65b4cce2153da9d426 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + FileUpload: + formEditor: + iconIdentifier: t3-form-icon-file-upload + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..80a087af3186134519f5d950f73a60c63d02ecb3 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/label.rst @@ -0,0 +1,29 @@ +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + FileUpload: + formEditor: + label: formEditor.elements.FileUpload.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..16848a64553032219ec8e2772cdd1432e52eb37f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/formEditor/predefinedDefaults.rst @@ -0,0 +1,33 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + FileUpload: + formEditor: + predefinedDefaults: + properties: + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - application/pdf + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..d3530d5230b11d6081b0f739de32f7c3753f45ed --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + FileUpload: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\FileUpload + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/properties/allowedMimeTypes.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/properties/allowedMimeTypes.rst new file mode 100644 index 0000000000000000000000000000000000000000..5656b3638bbe0ba37957912a4e32f3d58c15b4fb --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/properties/allowedMimeTypes.rst @@ -0,0 +1,43 @@ +properties.allowedMimeTypes +--------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.properties.allowedMimeTypes + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + Yes + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 7- + + FileUpload: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - application/msword + - application/vnd.openxmlformats-officedocument.wordprocessingml.document + - application/vnd.oasis.opendocument.text + - application/pdf + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The allowed mime types for the file uploads. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/properties/containerClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/properties/containerClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..639c1ba2c183f4767da90fba0a66ea02bba65c6c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/properties/containerClassAttribute.rst @@ -0,0 +1,43 @@ +properties.containerClassAttribute +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.properties.containerClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + FileUpload: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - application/msword + - application/vnd.openxmlformats-officedocument.wordprocessingml.document + - application/vnd.oasis.opendocument.text + - application/pdf + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is typically wrapped around the form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/properties/elementClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/properties/elementClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..3002b8c26b4133bef6860502012bff168b16ec1d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/properties/elementClassAttribute.rst @@ -0,0 +1,43 @@ +properties.elementClassAttribute +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.properties.elementClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + FileUpload: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - application/msword + - application/vnd.openxmlformats-officedocument.wordprocessingml.document + - application/vnd.oasis.opendocument.text + - application/pdf + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class written to the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/properties/elementErrorClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/properties/elementErrorClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..f08118898b64bd4a6f9164f9a9c4d1d663360793 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/properties/elementErrorClassAttribute.rst @@ -0,0 +1,43 @@ +properties.elementErrorClassAttribute +------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.properties.elementErrorClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + FileUpload: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - application/msword + - application/vnd.openxmlformats-officedocument.wordprocessingml.document + - application/vnd.oasis.opendocument.text + - application/pdf + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is written to the form element if validation errors exists. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/properties/saveToFileMount.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/properties/saveToFileMount.rst new file mode 100644 index 0000000000000000000000000000000000000000..87a3b1accb87efff925dca61cea3ba893e7b475a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/FileUpload/properties/saveToFileMount.rst @@ -0,0 +1,47 @@ +properties.saveToFileMount +-------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.properties.saveToFileMount + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + Yes + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + FileUpload: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - application/msword + - application/vnd.openxmlformats-officedocument.wordprocessingml.document + - application/vnd.oasis.opendocument.text + - application/pdf + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The location (file mount) for the uploaded files. + If this file mount or the property "saveToFileMount" does not exist + the folder in which the form definition lies (persistence identifier) will be used. + If the form is generated programmatically and therefore no persistence identifier exist + the default storage "1:/user_upload/" will be used. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form.rst new file mode 100644 index 0000000000000000000000000000000000000000..8b8443eec8668177147dfc8124553a654e4153a9 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form.rst @@ -0,0 +1,307 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.form: + +====== +[Form] +====== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.form-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.translation.translationfile: +.. include:: Form/renderingOptions/translation/translationFile.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.templaterootpaths: +.. include:: Form/renderingOptions/templateRootPaths.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.partialrootpaths: +.. include:: Form/renderingOptions/partialRootPaths.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.layoutrootpaths: +.. include:: Form/renderingOptions/layoutRootPaths.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.addquerystring: +.. include:: Form/renderingOptions/addQueryString.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.argumentstobeexcludedfromquerystring: +.. include:: Form/renderingOptions/argumentsToBeExcludedFromQueryString.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.additionalparams: +.. include:: Form/renderingOptions/additionalParams.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.controlleraction: +.. include:: Form/renderingOptions/controllerAction.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.httpmethod: +.. include:: Form/renderingOptions/httpMethod.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.httpenctype: +.. include:: Form/renderingOptions/httpEnctype.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.renderingoptions._iscompositeformelement: +.. include:: Form/renderingOptions/_isCompositeFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.renderingoptions._istoplevelformelement: +.. include:: Form/renderingOptions/_isTopLevelFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.honeypot.enable: +.. include:: Form/renderingOptions/honeypot/enable.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.honeypot.formelementtouse: +.. include:: Form/renderingOptions/honeypot/formElementToUse.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.submitbuttonlabel: +.. include:: Form/renderingOptions/submitButtonLabel.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.skipunknownelements: +.. include:: Form/renderingOptions/skipUnknownElements.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor: +.. include:: Form/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.editors.100: +.. include:: Form/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.editors.200: +.. include:: Form/formEditor/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.editors.300: +.. include:: Form/formEditor/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.editors.900: +.. include:: Form/formEditor/editors/900.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.predefineddefaults: +.. include:: Form/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor._iscompositeformelement: +.. include:: Form/formEditor/_isCompositeFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor._istoplevelformelement: +.. include:: Form/formEditor/_isTopLevelFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.savesuccessflashmessagetitle: +.. include:: Form/formEditor/saveSuccessFlashMessageTitle.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.savesuccessflashmessagemessage: +.. include:: Form/formEditor/saveSuccessFlashMessageMessage.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.modalvalidationerrorsdialogtitle: +.. include:: Form/formEditor/modalValidationErrorsDialogTitle.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.modalvalidationerrorsconfirmButton: +.. include:: Form/formEditor/modalValidationErrorsConfirmButton.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.modalinsertelementsdialogtitle: +.. include:: Form/formEditor/modalInsertElementsDialogTitle.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.modalinsertpagesdialogtitle: +.. include:: Form/formEditor/modalInsertPagesDialogTitle.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.modalclosedialogmessage: +.. include:: Form/formEditor/modalCloseDialogMessage.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.modalclosedialogtitle: +.. include:: Form/formEditor/modalCloseDialogTitle.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.modalcloseconfirmbutton: +.. include:: Form/formEditor/modalCloseConfirmButton.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.modalclosecanclebutton: +.. include:: Form/formEditor/modalCloseCancleButton.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.modalremoveelementdialogtitle: +.. include:: Form/formEditor/modalRemoveElementDialogTitle.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.modalremoveelementdialogmessage: +.. include:: Form/formEditor/modalRemoveElementDialogMessage.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.modalremoveelementconfirmbutton: +.. include:: Form/formEditor/modalRemoveElementConfirmButton.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.modalremoveelementcanclebutton: +.. include:: Form/formEditor/modalRemoveElementCancleButton.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.modalremoveelementlastavailablepageflashmessagetitle: +.. include:: Form/formEditor/modalRemoveElementLastAvailablePageFlashMessageTitle.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.modalremoveelementlastavailablepageflashmessagemessage: +.. include:: Form/formEditor/modalRemoveElementLastAvailablePageFlashMessageMessage.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.inspectoreditorformelementselectornoelements: +.. include:: Form/formEditor/inspectorEditorFormElementSelectorNoElements.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.paginationtitle: +.. include:: Form/formEditor/paginationTitle.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.iconidentifier: +.. include:: Form/formEditor/iconIdentifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.10: +.. include:: Form/formEditor/propertyCollections/finishers/10.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.10.identifier: +.. include:: Form/formEditor/propertyCollections/finishers/10/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.10.editors.100: +.. include:: Form/formEditor/propertyCollections/finishers/10/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.10.editors.200: +.. include:: Form/formEditor/propertyCollections/finishers/10/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.10.editors.300: +.. include:: Form/formEditor/propertyCollections/finishers/10/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.10.editors.400: +.. include:: Form/formEditor/propertyCollections/finishers/10/editors/400.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.10.editors.500: +.. include:: Form/formEditor/propertyCollections/finishers/10/editors/500.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.10.editors.600: +.. include:: Form/formEditor/propertyCollections/finishers/10/editors/600.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.10.editors.700: +.. include:: Form/formEditor/propertyCollections/finishers/10/editors/700.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.10.editors.800: +.. include:: Form/formEditor/propertyCollections/finishers/10/editors/800.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.10.editors.900: +.. include:: Form/formEditor/propertyCollections/finishers/10/editors/900.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.10.editors.1000: +.. include:: Form/formEditor/propertyCollections/finishers/10/editors/1000.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.10.editors.1100: +.. include:: Form/formEditor/propertyCollections/finishers/10/editors/1100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.10.editors.9999: +.. include:: Form/formEditor/propertyCollections/finishers/10/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.20: +.. include:: Form/formEditor/propertyCollections/finishers/20.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.20.identifier: +.. include:: Form/formEditor/propertyCollections/finishers/20/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.20.editors.100: +.. include:: Form/formEditor/propertyCollections/finishers/20/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.20.editors.200: +.. include:: Form/formEditor/propertyCollections/finishers/20/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.20.editors.300: +.. include:: Form/formEditor/propertyCollections/finishers/20/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.20.editors.400: +.. include:: Form/formEditor/propertyCollections/finishers/20/editors/400.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.20.editors.500: +.. include:: Form/formEditor/propertyCollections/finishers/20/editors/500.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.20.editors.600: +.. include:: Form/formEditor/propertyCollections/finishers/20/editors/600.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.20.editors.700: +.. include:: Form/formEditor/propertyCollections/finishers/20/editors/700.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.20.editors.800: +.. include:: Form/formEditor/propertyCollections/finishers/20/editors/800.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.20.editors.900: +.. include:: Form/formEditor/propertyCollections/finishers/20/editors/900.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.20.editors.1000: +.. include:: Form/formEditor/propertyCollections/finishers/20/editors/1000.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.20.editors.1100: +.. include:: Form/formEditor/propertyCollections/finishers/20/editors/1100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.20.editors.1200: +.. include:: Form/formEditor/propertyCollections/finishers/20/editors/1200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.20.editors.9999: +.. include:: Form/formEditor/propertyCollections/finishers/20/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.30: +.. include:: Form/formEditor/propertyCollections/finishers/30.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.30.identifier: +.. include:: Form/formEditor/propertyCollections/finishers/30/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.30.editors.100: +.. include:: Form/formEditor/propertyCollections/finishers/30/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.30.editors.200: +.. include:: Form/formEditor/propertyCollections/finishers/30/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.30.editors.300: +.. include:: Form/formEditor/propertyCollections/finishers/30/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.30.editors.9999: +.. include:: Form/formEditor/propertyCollections/finishers/30/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.40: +.. include:: Form/formEditor/propertyCollections/finishers/40.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.40.identifier: +.. include:: Form/formEditor/propertyCollections/finishers/40/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.40.editors.100: +.. include:: Form/formEditor/propertyCollections/finishers/40/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.40.editors.9999: +.. include:: Form/formEditor/propertyCollections/finishers/40/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.50: +.. include:: Form/formEditor/propertyCollections/finishers/50.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.50.identifier: +.. include:: Form/formEditor/propertyCollections/finishers/50/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.50.editors.100: +.. include:: Form/formEditor/propertyCollections/finishers/50/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.50.editors.9999: +.. include:: Form/formEditor/propertyCollections/finishers/50/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.60: +.. include:: Form/formEditor/propertyCollections/finishers/60.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.60.identifier: +.. include:: Form/formEditor/propertyCollections/finishers/60/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.60.editors.100: +.. include:: Form/formEditor/propertyCollections/finishers/60/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.60.editors.9999: +.. include:: Form/formEditor/propertyCollections/finishers/60/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.70: +.. include:: Form/formEditor/propertyCollections/finishers/70.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.70.identifier: +.. include:: Form/formEditor/propertyCollections/finishers/70/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.70.editors.100: +.. include:: Form/formEditor/propertyCollections/finishers/70/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.70.editors.9999: +.. include:: Form/formEditor/propertyCollections/finishers/70/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.80: +.. include:: Form/formEditor/propertyCollections/finishers/80.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.80.identifier: +.. include:: Form/formEditor/propertyCollections/finishers/80/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.80.editors.100: +.. include:: Form/formEditor/propertyCollections/finishers/80/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.form.formeditor.propertycollections.finishers.80.editors.9999: +.. include:: Form/formEditor/propertyCollections/finishers/80/editors/9999.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..a0573114c88439c9e6bbe901f9269c8c2af5de4c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor.rst @@ -0,0 +1,371 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + Form: + formEditor: + predefinedDefaults: + renderingOptions: + submitButtonLabel: 'formEditor.elements.Form.editor.submitButtonLabel.value' + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.BaseFormElementMixin.editor.label.label + propertyPath: label + 300: + identifier: 'submitButtonLabel' + templateName: 'Inspector-TextEditor' + label: 'formEditor.elements.Form.editor.submitButtonLabel.label' + propertyPath: 'renderingOptions.submitButtonLabel' + 900: + identifier: finishers + templateName: Inspector-FinishersEditor + label: formEditor.elements.Form.editor.finishers.label + selectOptions: + 10: + value: '' + label: formEditor.elements.Form.editor.finishers.EmptyValue.label + 20: + value: EmailToSender + label: formEditor.elements.Form.editor.finishers.EmailToSender.label + 30: + value: EmailToReceiver + label: formEditor.elements.Form.editor.finishers.EmailToReceiver.label + 40: + value: Redirect + label: formEditor.elements.Form.editor.finishers.Redirect.label + 50: + value: DeleteUploads + label: formEditor.elements.Form.editor.finishers.DeleteUploads.label + _isCompositeFormElement: false + _isTopLevelFormElement: true + saveSuccessFlashMessageTitle: formEditor.elements.Form.saveSuccessFlashMessageTitle + saveSuccessFlashMessageMessage: formEditor.elements.Form.saveSuccessFlashMessageMessage + modalValidationErrorsDialogTitle: formEditor.modals.validationErrors.dialogTitle + modalValidationErrorsConfirmButton: formEditor.modals.validationErrors.confirmButton + modalInsertElementsDialogTitle: formEditor.modals.insertElements.dialogTitle + modalInsertPagesDialogTitle: formEditor.modals.newPages.dialogTitle + modalCloseDialogMessage: formEditor.modals.close.dialogMessage + modalCloseDialogTitle: formEditor.modals.close.dialogTitle + modalCloseConfirmButton: formEditor.modals.close.confirmButton + modalCloseCancleButton: formEditor.modals.close.cancleButton + modalRemoveElementDialogTitle: formEditor.modals.removeElement.dialogTitle + modalRemoveElementDialogMessage: formEditor.modals.removeElement.dialogMessage + modalRemoveElementConfirmButton: formEditor.modals.removeElement.confirmButton + modalRemoveElementCancleButton: formEditor.modals.removeElement.cancleButton + modalRemoveElementLastAvailablePageFlashMessageTitle: formEditor.modals.removeElement.lastAvailablePageFlashMessageTitle + modalRemoveElementLastAvailablePageFlashMessageMessage: formEditor.modals.removeElement.lastAvailablePageFlashMessageMessage + inspectorEditorFormElementSelectorNoElements: formEditor.inspector.editor.formelement_selector.no_elements + paginationTitle: formEditor.pagination.title + iconIdentifier: content-elements-mailform + propertyCollections: + finishers: + 10: + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.header.label + 200: + identifier: subject + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.subject.label + propertyPath: options.subject + enableFormelementSelectionButton: true + propertyValidators: + 10: NotEmpty + 20: FormElementIdentifierWithinCurlyBracesInclusive + 300: + identifier: recipientAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.recipientAddress.label + propertyPath: options.recipientAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmail + 20: FormElementIdentifierWithinCurlyBracesExclusive + 400: + identifier: recipientName + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.recipientName.label + propertyPath: options.recipientName + enableFormelementSelectionButton: true + propertyValidators: + 10: FormElementIdentifierWithinCurlyBracesInclusive + 500: + identifier: senderAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.senderAddress.label + propertyPath: options.senderAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmail + 20: FormElementIdentifierWithinCurlyBracesExclusive + 600: + identifier: senderName + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.senderName.label + propertyPath: options.senderName + enableFormelementSelectionButton: true + propertyValidators: + 10: FormElementIdentifierWithinCurlyBracesInclusive + 700: + identifier: replyToAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.replyToAddress.label + propertyPath: options.replyToAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + 800: + identifier: carbonCopyAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.carbonCopyAddress.label + propertyPath: options.carbonCopyAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + 900: + identifier: blindCarbonCopyAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.blindCarbonCopyAddress.label + propertyPath: options.blindCarbonCopyAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + 1000: + identifier: format + templateName: Inspector-SingleSelectEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.format.label + propertyPath: options.format + selectOptions: + 10: + value: plaintext + label: formEditor.elements.Form.finisher.EmailToSender.editor.format.1 + 20: + value: html + label: formEditor.elements.Form.finisher.EmailToSender.editor.format.2 + 1100: + identifier: attachUploads + templateName: Inspector-CheckboxEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.attachUploads.label + propertyPath: options.attachUploads + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + identifier: EmailToSender + 20: + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.header.label + 200: + identifier: subject + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.subject.label + propertyPath: options.subject + enableFormelementSelectionButton: true + propertyValidators: + 10: NotEmpty + 20: FormElementIdentifierWithinCurlyBracesInclusive + 300: + identifier: recipientAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.recipientAddress.label + propertyPath: options.recipientAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmail + 20: FormElementIdentifierWithinCurlyBracesExclusive + 400: + identifier: recipientName + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.recipientName.label + propertyPath: options.recipientName + enableFormelementSelectionButton: true + propertyValidators: + 10: FormElementIdentifierWithinCurlyBracesInclusive + 500: + identifier: senderAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.senderAddress.label + propertyPath: options.senderAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmail + 20: FormElementIdentifierWithinCurlyBracesExclusive + 600: + identifier: senderName + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.senderName.label + propertyPath: options.senderName + enableFormelementSelectionButton: true + propertyValidators: + 10: FormElementIdentifierWithinCurlyBracesInclusive + 700: + identifier: replyToAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.replyToAddress.label + propertyPath: options.replyToAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + 800: + identifier: carbonCopyAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.carbonCopyAddress.label + propertyPath: options.carbonCopyAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + 900: + identifier: blindCarbonCopyAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.blindCarbonCopyAddress.label + propertyPath: options.blindCarbonCopyAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + 1000: + identifier: format + templateName: Inspector-SingleSelectEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.format.label + propertyPath: options.format + selectOptions: + 10: + value: plaintext + label: formEditor.elements.Form.finisher.EmailToSender.editor.format.1 + 20: + value: html + label: formEditor.elements.Form.finisher.EmailToSender.editor.format.2 + 1100: + identifier: attachUploads + templateName: Inspector-CheckboxEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.attachUploads.label + propertyPath: options.attachUploads + 1200: + identifier: language + templateName: Inspector-SingleSelectEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.language.label + propertyPath: options.translation.language + selectOptions: + 10: + value: default + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.language.1 + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + identifier: EmailToReceiver + 30: + identifier: Redirect + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.Redirect.editor.header.label + 200: + identifier: pageUid + templateName: Inspector-Typo3WinBrowserEditor + label: formEditor.elements.Form.finisher.Redirect.editor.pageUid.label + buttonLabel: formEditor.elements.Form.finisher.Redirect.editor.pageUid.buttonLabel + browsableType: pages + propertyPath: options.pageUid + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: additionalParameters + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.Redirect.editor.additionalParameters.label + propertyPath: options.additionalParameters + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 40: + identifier: DeleteUploads + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.DeleteUploads.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 50: + identifier: Confirmation + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.Confirmation.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 60: + identifier: Closure + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.Closure.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 70: + identifier: FlashMessage + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.FlashMessage.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 80: + identifier: SaveToDatabase + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.SaveToDatabase.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/_isCompositeFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/_isCompositeFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..6c3441aae15e1ca1a7209bbef8906e3171038faf --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/_isCompositeFormElement.rst @@ -0,0 +1,29 @@ +formEditor._isCompositeFormElement +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor._isCompositeFormElement + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + _isCompositeFormElement: false + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting to define that the form element contains child form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/_isTopLevelFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/_isTopLevelFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..60c0320a13a7d4c59a54c43e05a2c9b05f1baaee --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/_isTopLevelFormElement.rst @@ -0,0 +1,29 @@ +formEditor._isTopLevelFormElement +--------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor._isTopLevelFormElement + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + _isTopLevelFormElement: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting to define that the form element must not have a parent form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..d2bd5eb5f25ece92fe900e9fb4a66fe885494988 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/editors/100.rst @@ -0,0 +1,29 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Form: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..af616636f5871c592ef4c60be5834e672f940d8f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/editors/200.rst @@ -0,0 +1,31 @@ +formEditor.editors.200 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Form: + formEditor: + editors: + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.BaseFormElementMixin.editor.label.label + propertyPath: label diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..60ea32570ffef483da46a03eb7ad22d594a5510c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/editors/300.rst @@ -0,0 +1,31 @@ +formEditor.editors.300 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.editors.300 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Form: + formEditor: + editors: + 300: + identifier: 'submitButtonLabel' + templateName: 'Inspector-TextEditor' + label: 'formEditor.elements.Form.editor.submitButtonLabel.label' + propertyPath: 'renderingOptions.submitButtonLabel' diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/editors/900.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/editors/900.rst new file mode 100644 index 0000000000000000000000000000000000000000..1654a1c8c9a25ef9b81557e46af0f71824698c7a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/editors/900.rst @@ -0,0 +1,47 @@ +formEditor.editors.900 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.editors.900 + +:aspect:`Data type` + array/ :ref:`[FinishersEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.finisherseditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Form: + formEditor: + editors: + 900: + identifier: finishers + templateName: Inspector-FinishersEditor + label: formEditor.elements.Form.editor.finishers.label + selectOptions: + 10: + value: '' + label: formEditor.elements.Form.editor.finishers.EmptyValue.label + 20: + value: EmailToSender + label: formEditor.elements.Form.editor.finishers.EmailToSender.label + 30: + value: EmailToReceiver + label: formEditor.elements.Form.editor.finishers.EmailToReceiver.label + 40: + value: Redirect + label: formEditor.elements.Form.editor.finishers.Redirect.label + 50: + value: DeleteUploads + label: formEditor.elements.Form.editor.finishers.DeleteUploads.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..171ebbd99163366534b83045d4803668f8db217b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + iconIdentifier: content-elements-mailform + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/inspectorEditorFormElementSelectorNoElements.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/inspectorEditorFormElementSelectorNoElements.rst new file mode 100644 index 0000000000000000000000000000000000000000..2c59974f34d356ac9ceb8915e60e3a3bb6c1b7cf --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/inspectorEditorFormElementSelectorNoElements.rst @@ -0,0 +1,29 @@ +formEditor.inspectorEditorFormElementSelectorNoElements +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.inspectorEditorFormElementSelectorNoElements + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + inspectorEditorFormElementSelectorNoElements: formEditor.inspector.editor.formelement_selector.no_elements + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + Internal setting. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalCloseCancleButton.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalCloseCancleButton.rst new file mode 100644 index 0000000000000000000000000000000000000000..2b8e0ca0d6e32f0d5b86e0e68702ce013e9b003e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalCloseCancleButton.rst @@ -0,0 +1,29 @@ +formEditor.modalCloseCancleButton +--------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.modalCloseCancleButton + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + modalCloseCancleButton: formEditor.modals.close.cancleButton + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + Internal setting. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalCloseConfirmButton.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalCloseConfirmButton.rst new file mode 100644 index 0000000000000000000000000000000000000000..3bfb723d4e1cbabddc7d836b6f15baacf0cea8d5 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalCloseConfirmButton.rst @@ -0,0 +1,29 @@ +formEditor.modalCloseConfirmButton +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.modalCloseConfirmButton + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + modalCloseConfirmButton: formEditor.modals.close.confirmButton + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + Internal setting. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalCloseDialogMessage.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalCloseDialogMessage.rst new file mode 100644 index 0000000000000000000000000000000000000000..463f1e7f6849b08b1bb343f80492ad3554f3269b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalCloseDialogMessage.rst @@ -0,0 +1,29 @@ +formEditor.modalCloseDialogMessage +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.modalCloseDialogMessage + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + modalCloseDialogMessage: formEditor.modals.close.dialogMessage + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + Internal setting. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalCloseDialogTitle.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalCloseDialogTitle.rst new file mode 100644 index 0000000000000000000000000000000000000000..aea54025678f91f8c223d7a590a6823260cc92b9 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalCloseDialogTitle.rst @@ -0,0 +1,29 @@ +formEditor.modalCloseDialogTitle +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.modalCloseDialogTitle + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + modalCloseDialogTitle: formEditor.modals.close.dialogTitle + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + Internal setting. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalInsertElementsDialogTitle.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalInsertElementsDialogTitle.rst new file mode 100644 index 0000000000000000000000000000000000000000..e3c49c713daf4e7dc49c03f9cd84a1b99e6e04e5 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalInsertElementsDialogTitle.rst @@ -0,0 +1,29 @@ +formEditor.modalInsertPagesDialogTitle +-------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.modalInsertPagesDialogTitle + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + modalInsertElementsDialogTitle: formEditor.modals.insertElements.dialogTitle + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + Internal setting. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalInsertPagesDialogTitle.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalInsertPagesDialogTitle.rst new file mode 100644 index 0000000000000000000000000000000000000000..5a89bd31b44f0c012d2b78796c5fce30b58aa0dd --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalInsertPagesDialogTitle.rst @@ -0,0 +1,29 @@ +formEditor.modalInsertPagesDialogTitle +-------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.modalInsertPagesDialogTitle + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + modalInsertPagesDialogTitle: formEditor.modals.newPages.dialogTitle + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + Internal setting. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalRemoveElementCancleButton.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalRemoveElementCancleButton.rst new file mode 100644 index 0000000000000000000000000000000000000000..0dd2b80673bb551e04b4e54fd215e2cc259c339a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalRemoveElementCancleButton.rst @@ -0,0 +1,29 @@ +formEditor.modalRemoveElementCancleButton +----------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.modalRemoveElementCancleButton + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + modalRemoveElementCancleButton: formEditor.modals.removeElement.cancleButton + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + Internal setting. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalRemoveElementConfirmButton.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalRemoveElementConfirmButton.rst new file mode 100644 index 0000000000000000000000000000000000000000..ee3e19c79219b43b0b6ed87033acaf3a15512762 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalRemoveElementConfirmButton.rst @@ -0,0 +1,29 @@ +formEditor.modalRemoveElementConfirmButton +------------------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.modalRemoveElementConfirmButton + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + modalRemoveElementConfirmButton: formEditor.modals.removeElement.confirmButton + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + Internal setting. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalRemoveElementDialogMessage.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalRemoveElementDialogMessage.rst new file mode 100644 index 0000000000000000000000000000000000000000..f9cba8ddc322d22bf231ea454e081397e1c437b0 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalRemoveElementDialogMessage.rst @@ -0,0 +1,29 @@ +formEditor.modalRemoveElementDialogMessage +------------------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.modalRemoveElementDialogMessage + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + modalRemoveElementDialogMessage: formEditor.modals.removeElement.dialogMessage + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + Internal setting. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalRemoveElementDialogTitle.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalRemoveElementDialogTitle.rst new file mode 100644 index 0000000000000000000000000000000000000000..ecd21f3649ce5f7412b5e9eca379b41ab27cde14 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalRemoveElementDialogTitle.rst @@ -0,0 +1,29 @@ +formEditor.modalRemoveElementDialogTitle +---------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.modalRemoveElementDialogTitle + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + modalRemoveElementDialogTitle: formEditor.modals.removeElement.dialogTitle + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + Internal setting. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalRemoveElementLastAvailablePageFlashMessageMessage.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalRemoveElementLastAvailablePageFlashMessageMessage.rst new file mode 100644 index 0000000000000000000000000000000000000000..08627da65b529df004a4cf78a4d19634e23c8c30 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalRemoveElementLastAvailablePageFlashMessageMessage.rst @@ -0,0 +1,29 @@ +formEditor.modalRemoveElementLastAvailablePageFlashMessageMessage +----------------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.modalRemoveElementLastAvailablePageFlashMessageMessage + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + modalRemoveElementLastAvailablePageFlashMessageMessage: formEditor.modals.removeElement.lastAvailablePageFlashMessageMessage + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + Internal setting. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalRemoveElementLastAvailablePageFlashMessageTitle.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalRemoveElementLastAvailablePageFlashMessageTitle.rst new file mode 100644 index 0000000000000000000000000000000000000000..f17cbd50a53e5a8d47fcc75dc0b049ba35d4ca5d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalRemoveElementLastAvailablePageFlashMessageTitle.rst @@ -0,0 +1,29 @@ +formEditor.modalRemoveElementLastAvailablePageFlashMessageTitle +--------------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.modalRemoveElementLastAvailablePageFlashMessageTitle + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + modalRemoveElementLastAvailablePageFlashMessageTitle: formEditor.modals.removeElement.lastAvailablePageFlashMessageTitle + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + Internal setting. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalValidationErrorsConfirmButton.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalValidationErrorsConfirmButton.rst new file mode 100644 index 0000000000000000000000000000000000000000..75cc0effa2a4eaad5f4c56885b33d3762d19bf41 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalValidationErrorsConfirmButton.rst @@ -0,0 +1,29 @@ +formEditor.modalValidationErrorsConfirmButton +--------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.modalValidationErrorsConfirmButton + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + modalValidationErrorsConfirmButton: formEditor.modals.validationErrors.confirmButton + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + Internal setting. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalValidationErrorsDialogTitle.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalValidationErrorsDialogTitle.rst new file mode 100644 index 0000000000000000000000000000000000000000..f74deeb185b2d1bb84f197bc50fd83b30d0a363c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/modalValidationErrorsDialogTitle.rst @@ -0,0 +1,29 @@ +formEditor.modalValidationErrorsDialogTitle +------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.modalValidationErrorsDialogTitle + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + modalValidationErrorsDialogTitle: formEditor.modals.validationErrors.dialogTitle + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + Internal setting. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/paginationTitle.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/paginationTitle.rst new file mode 100644 index 0000000000000000000000000000000000000000..78c970d0e40ce04b55ede09d6f24f08b884b0a5a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/paginationTitle.rst @@ -0,0 +1,29 @@ +formEditor.paginationTitle +-------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.paginationTitle + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + paginationTitle: formEditor.pagination.title + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + Internal setting. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..de74e1e96b0254da9da835ccd83d71bcc7b68b3e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/predefinedDefaults.rst @@ -0,0 +1,31 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Form: + formEditor: + predefinedDefaults: + renderingOptions: + submitButtonLabel: 'formEditor.elements.Form.editor.submitButtonLabel.value' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10.rst new file mode 100644 index 0000000000000000000000000000000000000000..cd7c910f8b50613e394e394fb6eb46c3e33fb80d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10.rst @@ -0,0 +1,127 @@ +formEditor.propertyCollections.finishers.10 +------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.10 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Form: + formEditor: + propertyCollections: + finishers: + 10: + identifier: EmailToSender + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.header.label + 200: + identifier: subject + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.subject.label + propertyPath: options.subject + enableFormelementSelectionButton: true + propertyValidators: + 10: NotEmpty + 20: FormElementIdentifierWithinCurlyBracesInclusive + 300: + identifier: recipientAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.recipientAddress.label + propertyPath: options.recipientAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmail + 20: FormElementIdentifierWithinCurlyBracesExclusive + 400: + identifier: recipientName + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.recipientName.label + propertyPath: options.recipientName + enableFormelementSelectionButton: true + propertyValidators: + 10: FormElementIdentifierWithinCurlyBracesInclusive + 500: + identifier: senderAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.senderAddress.label + propertyPath: options.senderAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmail + 20: FormElementIdentifierWithinCurlyBracesExclusive + 600: + identifier: senderName + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.senderName.label + propertyPath: options.senderName + enableFormelementSelectionButton: true + propertyValidators: + 10: FormElementIdentifierWithinCurlyBracesInclusive + 700: + identifier: replyToAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.replyToAddress.label + propertyPath: options.replyToAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + 800: + identifier: carbonCopyAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.carbonCopyAddress.label + propertyPath: options.carbonCopyAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + 900: + identifier: blindCarbonCopyAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.blindCarbonCopyAddress.label + propertyPath: options.blindCarbonCopyAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + 1000: + identifier: format + templateName: Inspector-SingleSelectEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.format.label + propertyPath: options.format + selectOptions: + 10: + value: plaintext + label: formEditor.elements.Form.finisher.EmailToSender.editor.format.1 + 20: + value: html + label: formEditor.elements.Form.finisher.EmailToSender.editor.format.2 + 1100: + identifier: attachUploads + templateName: Inspector-CheckboxEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.attachUploads.label + propertyPath: options.attachUploads + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..6123d51883896a306b141e51002ea95ef71ca81d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.finishers.10.editors.100 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.10.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 10: + identifier: EmailToSender + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/1000.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/1000.rst new file mode 100644 index 0000000000000000000000000000000000000000..3f4b12bacc98f14c8983a8114d38c9199ce212fc --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/1000.rst @@ -0,0 +1,40 @@ +formEditor.propertyCollections.finishers.10.editors.1000 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.10.editors.1000 + +:aspect:`Data type` + array/ :ref:`[SingleSelectEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.singleselecteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 10: + identifier: EmailToSender + editors: + 1000: + identifier: format + templateName: Inspector-SingleSelectEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.format.label + propertyPath: options.format + selectOptions: + 10: + value: plaintext + label: formEditor.elements.Form.finisher.EmailToSender.editor.format.1 + 20: + value: html + label: formEditor.elements.Form.finisher.EmailToSender.editor.format.2 + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/1100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/1100.rst new file mode 100644 index 0000000000000000000000000000000000000000..7ef9b4c5b2eed616e8a7c8e3b631d4fa884191ae --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/1100.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.finishers.10.editors.1000 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.10.editors.1000 + +:aspect:`Data type` + array/ :ref:`[CheckboxEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.checkboxeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 10: + identifier: EmailToSender + editors: + 1100: + identifier: attachUploads + templateName: Inspector-CheckboxEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.attachUploads.label + propertyPath: options.attachUploads + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..610a151f1ef986f7096b1e7a46e1e8f197650ef5 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/200.rst @@ -0,0 +1,37 @@ +formEditor.propertyCollections.finishers.10.editors.200 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.10.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 10: + identifier: EmailToSender + editors: + 200: + identifier: subject + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.subject.label + propertyPath: options.subject + enableFormelementSelectionButton: true + propertyValidators: + 10: NotEmpty + 20: FormElementIdentifierWithinCurlyBracesInclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..4c3c5e0154c60231a45d5dedc15f51aacb16ae5b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/300.rst @@ -0,0 +1,38 @@ +formEditor.propertyCollections.finishers.10.editors.300 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.10.editors.300 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 10: + identifier: EmailToSender + editors: + 300: + identifier: recipientAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.recipientAddress.label + propertyPath: options.recipientAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmail + 20: FormElementIdentifierWithinCurlyBracesExclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/400.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/400.rst new file mode 100644 index 0000000000000000000000000000000000000000..f3c50d17d42df24e5313e1afb0fe4d2a352b6e19 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/400.rst @@ -0,0 +1,36 @@ +formEditor.propertyCollections.finishers.10.editors.400 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.10.editors.400 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 10: + identifier: EmailToSender + editors: + 400: + identifier: recipientName + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.recipientName.label + propertyPath: options.recipientName + enableFormelementSelectionButton: true + propertyValidators: + 10: FormElementIdentifierWithinCurlyBracesInclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/500.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/500.rst new file mode 100644 index 0000000000000000000000000000000000000000..3c7a44c39c4cb1dc64c39c79e0e05cd350308cf1 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/500.rst @@ -0,0 +1,38 @@ +formEditor.propertyCollections.finishers.10.editors.500 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.10.editors.500 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 10: + identifier: EmailToSender + editors: + 500: + identifier: senderAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.senderAddress.label + propertyPath: options.senderAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmail + 20: FormElementIdentifierWithinCurlyBracesExclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/600.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/600.rst new file mode 100644 index 0000000000000000000000000000000000000000..c371ebe24989b152ffe5ebcb54a47f82827785db --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/600.rst @@ -0,0 +1,36 @@ +formEditor.propertyCollections.finishers.10.editors.600 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.10.editors.600 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 10: + identifier: EmailToSender + editors: + 600: + identifier: senderName + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.senderName.label + propertyPath: options.senderName + enableFormelementSelectionButton: true + propertyValidators: + 10: FormElementIdentifierWithinCurlyBracesInclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/700.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/700.rst new file mode 100644 index 0000000000000000000000000000000000000000..3bb4a0fc6cb0f68c703ba7ebb4864765eaad926c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/700.rst @@ -0,0 +1,38 @@ +formEditor.propertyCollections.finishers.10.editors.700 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.10.editors.700 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 10: + identifier: EmailToSender + editors: + 700: + identifier: replyToAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.replyToAddress.label + propertyPath: options.replyToAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/800.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/800.rst new file mode 100644 index 0000000000000000000000000000000000000000..5a6bfd5aa035c6084c41cf6ac366ff55d9001745 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/800.rst @@ -0,0 +1,38 @@ +formEditor.propertyCollections.finishers.10.editors.800 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.10.editors.800 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 10: + identifier: EmailToSender + editors: + 800: + identifier: carbonCopyAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.carbonCopyAddress.label + propertyPath: options.carbonCopyAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/900.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/900.rst new file mode 100644 index 0000000000000000000000000000000000000000..e27bcee9916fa9d793bcf4167c25817985db3e58 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/900.rst @@ -0,0 +1,38 @@ +formEditor.propertyCollections.finishers.10.editors.900 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.10.editors.900 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 10: + identifier: EmailToSender + editors: + 900: + identifier: blindCarbonCopyAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.blindCarbonCopyAddress.label + propertyPath: options.blindCarbonCopyAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..68811e22cf8823005a06e0d5d675b909e369be43 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.finishers.10.editors.9999 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.10.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 10: + identifier: EmailToSender + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..d4a31be00ecf96d46c5ec648e8a67bba77c1139c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/10/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.finishers.10.identifier +------------------------------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.10.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Form: + formEditor: + propertyCollections: + finishers: + 10: + identifier: EmailToSender + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<finisherIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>>` + +:aspect:`Description` + Identifies the finisher which should be attached to the form definition. Must be equal to a existing ``<finisherIdentifier>``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20.rst new file mode 100644 index 0000000000000000000000000000000000000000..ae04a933c200e8dc12027754bf70e20622694532 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20.rst @@ -0,0 +1,136 @@ +formEditor.propertyCollections.finishers.20 +------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.20 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Form: + formEditor: + propertyCollections: + finishers: + 20: + identifier: EmailToReceiver + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.header.label + 200: + identifier: subject + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.subject.label + propertyPath: options.subject + enableFormelementSelectionButton: true + propertyValidators: + 10: NotEmpty + 20: FormElementIdentifierWithinCurlyBracesInclusive + 300: + identifier: recipientAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.recipientAddress.label + propertyPath: options.recipientAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmail + 20: FormElementIdentifierWithinCurlyBracesExclusive + 400: + identifier: recipientName + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.recipientName.label + propertyPath: options.recipientName + enableFormelementSelectionButton: true + propertyValidators: + 10: FormElementIdentifierWithinCurlyBracesInclusive + 500: + identifier: senderAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.senderAddress.label + propertyPath: options.senderAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmail + 20: FormElementIdentifierWithinCurlyBracesExclusive + 600: + identifier: senderName + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.senderName.label + propertyPath: options.senderName + enableFormelementSelectionButton: true + propertyValidators: + 10: FormElementIdentifierWithinCurlyBracesInclusive + 700: + identifier: replyToAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.replyToAddress.label + propertyPath: options.replyToAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + 800: + identifier: carbonCopyAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.carbonCopyAddress.label + propertyPath: options.carbonCopyAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + 900: + identifier: blindCarbonCopyAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.blindCarbonCopyAddress.label + propertyPath: options.blindCarbonCopyAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + 1000: + identifier: format + templateName: Inspector-SingleSelectEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.format.label + propertyPath: options.format + selectOptions: + 10: + value: plaintext + label: formEditor.elements.Form.finisher.EmailToSender.editor.format.1 + 20: + value: html + label: formEditor.elements.Form.finisher.EmailToSender.editor.format.2 + 1100: + identifier: attachUploads + templateName: Inspector-CheckboxEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.attachUploads.label + propertyPath: options.attachUploads + 1200: + identifier: language + templateName: Inspector-SingleSelectEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.language.label + propertyPath: options.translation.language + selectOptions: + 10: + value: default + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.language.1 + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..56da923e796b944cec1cd91116de2f35a0e19010 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.finishers.20.editors.100 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.20.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 20: + identifier: EmailToReceiver + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/1000.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/1000.rst new file mode 100644 index 0000000000000000000000000000000000000000..d69fea15880575580529f3bd1f03f28c50dae7bc --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/1000.rst @@ -0,0 +1,40 @@ +formEditor.propertyCollections.finishers.20.editors.1000 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.20.editors.1000 + +:aspect:`Data type` + array/ :ref:`[SingleSelectEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.singleselecteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 20: + identifier: EmailToReceiver + editors: + 1000: + identifier: format + templateName: Inspector-SingleSelectEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.format.label + propertyPath: options.format + selectOptions: + 10: + value: plaintext + label: formEditor.elements.Form.finisher.EmailToSender.editor.format.1 + 20: + value: html + label: formEditor.elements.Form.finisher.EmailToSender.editor.format.2 + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/1100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/1100.rst new file mode 100644 index 0000000000000000000000000000000000000000..066f1d44564083de2f2c4fbfb90cbac2e406cb5e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/1100.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.finishers.20.editors.1000 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.20.editors.1000 + +:aspect:`Data type` + array/ :ref:`[CheckboxEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.checkboxeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 20: + identifier: EmailToReceiver + editors: + 1100: + identifier: attachUploads + templateName: Inspector-CheckboxEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.attachUploads.label + propertyPath: options.attachUploads + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/1200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/1200.rst new file mode 100644 index 0000000000000000000000000000000000000000..57b79e01c34a2d38116fe0881397a0d19c6fe84a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/1200.rst @@ -0,0 +1,37 @@ +formEditor.propertyCollections.finishers.20.editors.1200 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.20.editors.1200 + +:aspect:`Data type` + array/ :ref:`[SingleSelectEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.singleselecteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 20: + identifier: EmailToReceiver + editors: + 1200: + identifier: language + templateName: Inspector-SingleSelectEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.language.label + propertyPath: options.translation.language + selectOptions: + 10: + value: default + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.language.1 + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..1eb70fe078cb4bd1c3e92bb344a5ab0aea96c8d3 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/200.rst @@ -0,0 +1,36 @@ +formEditor.propertyCollections.finishers.20.editors.200 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.20.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 20: + identifier: EmailToReceiver + editors: + 200: + identifier: subject + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.subject.label + propertyPath: options.subject + enableFormelementSelectionButton: true + propertyValidators: + 10: NotEmpty + 20: FormElementIdentifierWithinCurlyBracesInclusive diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..29977cd15171f5e5b3dd7ec1c019186e46ae124b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/300.rst @@ -0,0 +1,38 @@ +formEditor.propertyCollections.finishers.20.editors.300 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.20.editors.300 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 20: + identifier: EmailToReceiver + editors: + 300: + identifier: recipientAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.recipientAddress.label + propertyPath: options.recipientAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmail + 20: FormElementIdentifierWithinCurlyBracesExclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/400.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/400.rst new file mode 100644 index 0000000000000000000000000000000000000000..4563065b5fee3d97cbdd64048e907e8e5e07ff13 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/400.rst @@ -0,0 +1,36 @@ +formEditor.propertyCollections.finishers.20.editors.400 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.20.editors.400 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 20: + identifier: EmailToReceiver + editors: + 400: + identifier: recipientName + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToSender.editor.recipientName.label + propertyPath: options.recipientName + enableFormelementSelectionButton: true + propertyValidators: + 10: FormElementIdentifierWithinCurlyBracesInclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/500.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/500.rst new file mode 100644 index 0000000000000000000000000000000000000000..5201d13335d35b6ae0774787bbf21cabc99dba5d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/500.rst @@ -0,0 +1,38 @@ +formEditor.propertyCollections.finishers.20.editors.500 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.20.editors.500 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 20: + identifier: EmailToReceiver + editors: + 500: + identifier: senderAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.senderAddress.label + propertyPath: options.senderAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmail + 20: FormElementIdentifierWithinCurlyBracesExclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/600.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/600.rst new file mode 100644 index 0000000000000000000000000000000000000000..f03ac4221cd90b9fd8498ca439ad2652e23429a1 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/600.rst @@ -0,0 +1,36 @@ +formEditor.propertyCollections.finishers.20.editors.600 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.20.editors.600 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 20: + identifier: EmailToReceiver + editors: + 600: + identifier: senderName + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.senderName.label + propertyPath: options.senderName + enableFormelementSelectionButton: true + propertyValidators: + 10: FormElementIdentifierWithinCurlyBracesInclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/700.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/700.rst new file mode 100644 index 0000000000000000000000000000000000000000..4eb91f4706be9b5adfea480eb981fc8caaa0fd4f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/700.rst @@ -0,0 +1,38 @@ +formEditor.propertyCollections.finishers.20.editors.700 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.20.editors.700 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 20: + identifier: EmailToReceiver + editors: + 700: + identifier: replyToAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.replyToAddress.label + propertyPath: options.replyToAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/800.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/800.rst new file mode 100644 index 0000000000000000000000000000000000000000..a019779fad0a77b1ff7dccdee67fb2b2892ed662 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/800.rst @@ -0,0 +1,38 @@ +formEditor.propertyCollections.finishers.20.editors.800 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.20.editors.800 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 20: + identifier: EmailToReceiver + editors: + 800: + identifier: carbonCopyAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.carbonCopyAddress.label + propertyPath: options.carbonCopyAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/900.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/900.rst new file mode 100644 index 0000000000000000000000000000000000000000..239dd72e4eb7050410b3827412e2cfee915f5c73 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/900.rst @@ -0,0 +1,38 @@ +formEditor.propertyCollections.finishers.20.editors.900 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.20.editors.900 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 20: + identifier: EmailToReceiver + editors: + 900: + identifier: blindCarbonCopyAddress + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.EmailToReceiver.editor.blindCarbonCopyAddress.label + propertyPath: options.blindCarbonCopyAddress + enableFormelementSelectionButton: true + propertyValidatorsMode: OR + propertyValidators: + 10: NaiveEmailOrEmpty + 20: FormElementIdentifierWithinCurlyBracesExclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..d089793a7e877ac79abbe49f984486239c04b560 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.finishers.20.editors.9999 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.20.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 20: + identifier: EmailToReceiver + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..8809c9d024734a4bc296b246b5485c5a89c50861 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/20/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.finishers.20.identifier +------------------------------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.20.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Form: + formEditor: + propertyCollections: + finishers: + 20: + identifier: EmailToReceiver + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<finisherIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>>` + +:aspect:`Description` + Identifies the finisher which should be attached to the form definition. Must be equal to a existing ``<finisherIdentifier>``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/30.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/30.rst new file mode 100644 index 0000000000000000000000000000000000000000..1e11a183ed37ca2f40722069478fb610a4aadc60 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/30.rst @@ -0,0 +1,51 @@ +formEditor.propertyCollections.finishers.30 +------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.30 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Form: + formEditor: + propertyCollections: + finishers: + 30: + identifier: Redirect + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.Redirect.editor.header.label + 200: + identifier: pageUid + templateName: Inspector-Typo3WinBrowserEditor + label: formEditor.elements.Form.finisher.Redirect.editor.pageUid.label + buttonLabel: formEditor.elements.Form.finisher.Redirect.editor.pageUid.buttonLabel + browsableType: pages + propertyPath: options.pageUid + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: additionalParameters + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.Redirect.editor.additionalParameters.label + propertyPath: options.additionalParameters + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/30/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/30/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..7744c218afadcc7a0c4642f15c19fa8ae2253b43 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/30/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.finishers.30.editors.100 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.30.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 30: + identifier: Redirect + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.Redirect.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/30/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/30/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..a937e06bc5b751119a8acac795c14c2e424ddbb9 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/30/editors/200.rst @@ -0,0 +1,39 @@ +formEditor.propertyCollections.finishers.30.editors.200 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.30.editors.200 + +:aspect:`Data type` + array/ :ref:`[Typo3WinBrowserEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.typo3winbrowsereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 30: + identifier: Redirect + editors: + 200: + identifier: pageUid + templateName: Inspector-Typo3WinBrowserEditor + label: formEditor.elements.Form.finisher.Redirect.editor.pageUid.label + buttonLabel: formEditor.elements.Form.finisher.Redirect.editor.pageUid.buttonLabel + browsableType: pages + propertyPath: options.pageUid + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/30/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/30/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..b48a5849f5ac6eeaecb0c555a592a577acc75cb7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/30/editors/300.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.finishers.30.editors.300 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.30.editors.300 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 30: + identifier: Redirect + editors: + 300: + identifier: additionalParameters + templateName: Inspector-TextEditor + label: formEditor.elements.Form.finisher.Redirect.editor.additionalParameters.label + propertyPath: options.additionalParameters + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/30/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/30/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..72f694ec2f77e9f93334d0484b896d8115289454 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/30/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.finishers.30.editors.9999 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.30.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 30: + identifier: Redirect + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/30/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/30/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..f0fe2d34862d6085e7b3849f72362944241202f8 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/30/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.finishers.30.identifier +------------------------------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.30.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Form: + formEditor: + propertyCollections: + finishers: + 30: + identifier: Redirect + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<finisherIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>>` + +:aspect:`Description` + Identifies the finisher which should be attached to the form definition. Must be equal to a existing ``<finisherIdentifier>``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/40.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/40.rst new file mode 100644 index 0000000000000000000000000000000000000000..203e61b4fd2da9d3ac1738cf9751b9c3993addcd --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/40.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.finishers.40 +------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.40 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Form: + formEditor: + propertyCollections: + finishers: + 40: + identifier: DeleteUploads + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.DeleteUploads.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/40/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/40/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..ef7d064889e3c908b0c0bdcb8cb5e86c27832a08 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/40/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.finishers.40.editors.100 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.40.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 40: + identifier: DeleteUploads + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.DeleteUploads.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/40/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/40/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..dc1e19717392832d3876cc1d953afbfdce9d321a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/40/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.finishers.40.editors.9999 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.40.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 40: + identifier: DeleteUploads + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/40/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/40/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..39202cea925d5ec1d28cdb03d8eed8d853ce075b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/40/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.finishers.40.identifier +------------------------------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.40.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Form: + formEditor: + propertyCollections: + finishers: + 40: + identifier: DeleteUploads + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<finisherIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>>` + +:aspect:`Description` + Identifies the finisher which should be attached to the form definition. Must be equal to a existing ``<finisherIdentifier>``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/50.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/50.rst new file mode 100644 index 0000000000000000000000000000000000000000..f3f15d21039a40321178bdbf5d8d8aa861e16d27 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/50.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.finishers.50 +------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.50 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Form: + formEditor: + propertyCollections: + finishers: + 50: + identifier: Confirmation + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.Confirmation.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/50/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/50/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..d2f0c004d1be5786bb9b4335213706a0c09286f6 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/50/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.finishers.50.editors.100 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.50.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 50: + identifier: Confirmation + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.Confirmation.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/50/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/50/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..646d742d2ab9dd0f37f1df0ca659a7a2a33bdaac --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/50/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.finishers.50.editors.9999 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.50.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 50: + identifier: Confirmation + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/50/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/50/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..6a109a80cb5e8a644e1a5c53d2c421badf0696b3 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/50/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.finishers.50.identifier +------------------------------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.50.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Form: + formEditor: + propertyCollections: + finishers: + 50: + identifier: Confirmation + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<finisherIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>>` + +:aspect:`Description` + Identifies the finisher which should be attached to the form definition. Must be equal to a existing ``<finisherIdentifier>``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/60.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/60.rst new file mode 100644 index 0000000000000000000000000000000000000000..98aeff6ed09e649996adf8a3635fb3427441b8bd --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/60.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.finishers.60 +------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.60 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Form: + formEditor: + propertyCollections: + finishers: + 60: + identifier: Closure + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.Closure.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/60/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/60/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..e2b8b9ff24020c67df7677a86e03c87e5a7cd004 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/60/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.finishers.60.editors.100 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.60.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 60: + identifier: Closure + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.Closure.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/60/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/60/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..071f0bafd20650658c0504c6027c6910f76bcf9f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/60/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.finishers.60.editors.9999 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.60.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 60: + identifier: Closure + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/60/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/60/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..6d73e596685005e332390aec07b9e0e1951a16ca --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/60/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.finishers.60.identifier +------------------------------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.60.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Form: + formEditor: + propertyCollections: + finishers: + 60: + identifier: Closure + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<finisherIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>>` + +:aspect:`Description` + Identifies the finisher which should be attached to the form definition. Must be equal to a existing ``<finisherIdentifier>``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/70.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/70.rst new file mode 100644 index 0000000000000000000000000000000000000000..84b6930019df21c8ba2e2f3724c6490123f4d9fe --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/70.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.finishers.70 +------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.70 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Form: + formEditor: + propertyCollections: + finishers: + 70: + identifier: FlashMessage + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.FlashMessage.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/70/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/70/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..356e5cc2a0c34a7035969ad2131a465dbb81a972 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/70/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.finishers.70.editors.100 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.70.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 70: + identifier: FlashMessage + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.FlashMessage.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/70/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/70/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..8e238a9d9cdfe5f5104e7a53ebecf7429bb1961c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/70/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.finishers.70.editors.9999 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.70.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 70: + identifier: FlashMessage + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/70/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/70/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..e9a01f7b814000997a227a647f0c28cb8a64ea94 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/70/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.finishers.70.identifier +------------------------------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.70.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Form: + formEditor: + propertyCollections: + finishers: + 70: + identifier: FlashMessage + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<finisherIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>>` + +:aspect:`Description` + Identifies the finisher which should be attached to the form definition. Must be equal to a existing ``<finisherIdentifier>``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/80.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/80.rst new file mode 100644 index 0000000000000000000000000000000000000000..d648c02227b1c80eb03910f49c2752ae6d87feff --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/80.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.finishers.80 +------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.80 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Form: + formEditor: + propertyCollections: + finishers: + 80: + identifier: SaveToDatabase + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.SaveToDatabase.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/80/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/80/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..19ac618bff34498f23bb8a5a59f1f2d02d061438 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/80/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.finishers.80.editors.100 +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.80.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 80: + identifier: SaveToDatabase + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.Form.finisher.SaveToDatabase.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/80/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/80/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..1cda8910b23fdc3abe40becafaacff22e948331c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/80/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.finishers.80.editors.9999 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.80.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Form: + formEditor: + propertyCollections: + finishers: + 80: + identifier: SaveToDatabase + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/80/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/80/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..c039d8537f8fd12fe84046e3aa18e4b4e40bf3dc --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/propertyCollections/finishers/80/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.finishers.80.identifier +------------------------------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.propertyCollections.finishers.80.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Form: + formEditor: + propertyCollections: + finishers: + 80: + identifier: SaveToDatabase + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<finisherIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>>` + +:aspect:`Description` + Identifies the finisher which should be attached to the form definition. Must be equal to a existing ``<finisherIdentifier>``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/saveSuccessFlashMessageMessage.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/saveSuccessFlashMessageMessage.rst new file mode 100644 index 0000000000000000000000000000000000000000..de5d716d9f3e09980d0564d73e33b1b52b19a9a7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/saveSuccessFlashMessageMessage.rst @@ -0,0 +1,29 @@ +formEditor.saveSuccessFlashMessageMessage +----------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.saveSuccessFlashMessageMessage + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + saveSuccessFlashMessageMessage: formEditor.elements.Form.saveSuccessFlashMessageMessage + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + Internal setting. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/saveSuccessFlashMessageTitle.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/saveSuccessFlashMessageTitle.rst new file mode 100644 index 0000000000000000000000000000000000000000..bcfb594a35d5cd1c1d4e7528527370eb97c532d3 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/formEditor/saveSuccessFlashMessageTitle.rst @@ -0,0 +1,29 @@ +formEditor.saveSuccessFlashMessageTitle +--------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.formEditor.saveSuccessFlashMessageTitle + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Form: + formEditor: + saveSuccessFlashMessageTitle: formEditor.elements.Form.saveSuccessFlashMessageTitle + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + Internal setting. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/_isCompositeFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/_isCompositeFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..e4eeb40773c9be555cad0f46a067e2fbf43ff196 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/_isCompositeFormElement.rst @@ -0,0 +1,55 @@ +renderingOptions._isCompositeFormElement +---------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions._isCompositeFormElement + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 17 + + Form: + renderingOptions: + translation: + translationFile: 'EXT:form/Resources/Private/Language/locallang.xlf' + templateRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Templates/' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Partials/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Layouts/' + addQueryString: false + argumentsToBeExcludedFromQueryString: { } + additionalParams: { } + controllerAction: perform + httpMethod: post + httpEnctype: multipart/form-data + _isCompositeFormElement: false + _isTopLevelFormElement: true + honeypot: + enable: true + formElementToUse: Honeypot + submitButtonLabel: Submit + skipUnknownElements: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting to define that the form element contains child form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/_isTopLevelFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/_isTopLevelFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..e33a7a167b21794041eacaa241e0d5df6ca4635e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/_isTopLevelFormElement.rst @@ -0,0 +1,55 @@ +renderingOptions._isTopLevelFormElement +--------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions._isTopLevelFormElement + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 18 + + Form: + renderingOptions: + translation: + translationFile: 'EXT:form/Resources/Private/Language/locallang.xlf' + templateRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Templates/' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Partials/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Layouts/' + addQueryString: false + argumentsToBeExcludedFromQueryString: { } + additionalParams: { } + controllerAction: perform + httpMethod: post + httpEnctype: multipart/form-data + _isCompositeFormElement: false + _isTopLevelFormElement: true + honeypot: + enable: true + formElementToUse: Honeypot + submitButtonLabel: Submit + skipUnknownElements: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting to define that the form element must not have a parent form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/addQueryString.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/addQueryString.rst new file mode 100644 index 0000000000000000000000000000000000000000..f79a8edcc4a05ed8740b195aa2ae16aabddbf950 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/addQueryString.rst @@ -0,0 +1,55 @@ +renderingOptions.addQueryString +------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.addQueryString + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 11 + + Form: + renderingOptions: + translation: + translationFile: 'EXT:form/Resources/Private/Language/locallang.xlf' + templateRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Templates/' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Partials/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Layouts/' + addQueryString: false + argumentsToBeExcludedFromQueryString: { } + additionalParams: { } + controllerAction: perform + httpMethod: post + httpEnctype: multipart/form-data + _isCompositeFormElement: false + _isTopLevelFormElement: true + honeypot: + enable: true + formElementToUse: Honeypot + submitButtonLabel: Submit + skipUnknownElements: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Fluid f:form viewHelper option ``addQueryString`` \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/additionalParams.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/additionalParams.rst new file mode 100644 index 0000000000000000000000000000000000000000..a855190a0e933cb0bbf161403ef1de15f68b876b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/additionalParams.rst @@ -0,0 +1,55 @@ +renderingOptions.additionalParams +--------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.additionalParams + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 13 + + Form: + renderingOptions: + translation: + translationFile: 'EXT:form/Resources/Private/Language/locallang.xlf' + templateRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Templates/' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Partials/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Layouts/' + addQueryString: false + argumentsToBeExcludedFromQueryString: { } + additionalParams: { } + controllerAction: perform + httpMethod: post + httpEnctype: multipart/form-data + _isCompositeFormElement: false + _isTopLevelFormElement: true + honeypot: + enable: true + formElementToUse: Honeypot + submitButtonLabel: Submit + skipUnknownElements: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Fluid f:form viewHelper option ``additionalParams``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/argumentsToBeExcludedFromQueryString.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/argumentsToBeExcludedFromQueryString.rst new file mode 100644 index 0000000000000000000000000000000000000000..9279bec14e96f98fce08a5fc8f879f62400772dc --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/argumentsToBeExcludedFromQueryString.rst @@ -0,0 +1,55 @@ +renderingOptions.argumentsToBeExcludedFromQueryString +----------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.argumentsToBeExcludedFromQueryString + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 12 + + Form: + renderingOptions: + translation: + translationFile: 'EXT:form/Resources/Private/Language/locallang.xlf' + templateRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Templates/' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Partials/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Layouts/' + addQueryString: false + argumentsToBeExcludedFromQueryString: { } + additionalParams: { } + controllerAction: perform + httpMethod: post + httpEnctype: multipart/form-data + _isCompositeFormElement: false + _isTopLevelFormElement: true + honeypot: + enable: true + formElementToUse: Honeypot + submitButtonLabel: Submit + skipUnknownElements: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Fluid f:form viewHelper option ``argumentsToBeExcludedFromQueryString``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/controllerAction.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/controllerAction.rst new file mode 100644 index 0000000000000000000000000000000000000000..c0ff6081b212e7e1368476e805b4836edb482706 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/controllerAction.rst @@ -0,0 +1,55 @@ +renderingOptions.controllerAction +--------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.controllerAction + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 14 + + Form: + renderingOptions: + translation: + translationFile: 'EXT:form/Resources/Private/Language/locallang.xlf' + templateRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Templates/' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Partials/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Layouts/' + addQueryString: false + argumentsToBeExcludedFromQueryString: { } + additionalParams: { } + controllerAction: perform + httpMethod: post + httpEnctype: multipart/form-data + _isCompositeFormElement: false + _isTopLevelFormElement: true + honeypot: + enable: true + formElementToUse: Honeypot + submitButtonLabel: Submit + skipUnknownElements: true + +:aspect:`Good to know` + - :ref:`"Render within your own Extbase extension"<concepts-frontendrendering-extbase>` + +:aspect:`Description` + Fluid f:form viewHelper option ``action``. This is usefull if you want to render your form within your own extbase extension. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/honeypot/enable.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/honeypot/enable.rst new file mode 100644 index 0000000000000000000000000000000000000000..d4cd077ed1d29cfafc11379c711c7f0d15b02437 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/honeypot/enable.rst @@ -0,0 +1,55 @@ +renderingOptions.honeypot.enable +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.honeypot.enable + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 20 + + Form: + renderingOptions: + translation: + translationFile: 'EXT:form/Resources/Private/Language/locallang.xlf' + templateRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Templates/' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Partials/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Layouts/' + addQueryString: false + argumentsToBeExcludedFromQueryString: { } + additionalParams: { } + controllerAction: perform + httpMethod: post + httpEnctype: multipart/form-data + _isCompositeFormElement: false + _isTopLevelFormElement: true + honeypot: + enable: true + formElementToUse: Honeypot + submitButtonLabel: Submit + skipUnknownElements: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Enable or disable the honeypot feature. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/honeypot/formElementToUse.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/honeypot/formElementToUse.rst new file mode 100644 index 0000000000000000000000000000000000000000..ebade38240076928e5430a71ce2dfa17e5181662 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/honeypot/formElementToUse.rst @@ -0,0 +1,55 @@ +renderingOptions.honeypot.formElementToUse +------------------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.honeypot.formElementToUse + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 21 + + Form: + renderingOptions: + translation: + translationFile: 'EXT:form/Resources/Private/Language/locallang.xlf' + templateRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Templates/' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Partials/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Layouts/' + addQueryString: false + argumentsToBeExcludedFromQueryString: { } + additionalParams: { } + controllerAction: perform + httpMethod: post + httpEnctype: multipart/form-data + _isCompositeFormElement: false + _isTopLevelFormElement: true + honeypot: + enable: true + formElementToUse: Honeypot + submitButtonLabel: Submit + skipUnknownElements: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Define which ``<formElementIdentifier>`` should be used to render the honeypot. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/httpEnctype.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/httpEnctype.rst new file mode 100644 index 0000000000000000000000000000000000000000..bc4cb7bbcf009405bc0f09bd30fd5b4ea4c10883 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/httpEnctype.rst @@ -0,0 +1,55 @@ +renderingOptions.httpEnctype +---------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.httpEnctype + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 16 + + Form: + renderingOptions: + translation: + translationFile: 'EXT:form/Resources/Private/Language/locallang.xlf' + templateRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Templates/' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Partials/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Layouts/' + addQueryString: false + argumentsToBeExcludedFromQueryString: { } + additionalParams: { } + controllerAction: perform + httpMethod: post + httpEnctype: multipart/form-data + _isCompositeFormElement: false + _isTopLevelFormElement: true + honeypot: + enable: true + formElementToUse: Honeypot + submitButtonLabel: Submit + skipUnknownElements: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Fluid f:form viewHelper option ``enctype``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/httpMethod.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/httpMethod.rst new file mode 100644 index 0000000000000000000000000000000000000000..f5853c23c6adc026b5c26e8491e8efb458a2a7ef --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/httpMethod.rst @@ -0,0 +1,55 @@ +renderingOptions.httpMethod +--------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.httpMethod + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 15 + + Form: + renderingOptions: + translation: + translationFile: 'EXT:form/Resources/Private/Language/locallang.xlf' + templateRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Templates/' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Partials/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Layouts/' + addQueryString: false + argumentsToBeExcludedFromQueryString: { } + additionalParams: { } + controllerAction: perform + httpMethod: post + httpEnctype: multipart/form-data + _isCompositeFormElement: false + _isTopLevelFormElement: true + honeypot: + enable: true + formElementToUse: Honeypot + submitButtonLabel: Submit + skipUnknownElements: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Fluid f:form viewHelper option ``method``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/layoutRootPaths.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/layoutRootPaths.rst new file mode 100644 index 0000000000000000000000000000000000000000..f53262570a0567531e0e4573c0adb65bd698e7de --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/layoutRootPaths.rst @@ -0,0 +1,55 @@ +renderingOptions.layoutRootPaths +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.layoutRootPaths + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 9-10 + + Form: + renderingOptions: + translation: + translationFile: 'EXT:form/Resources/Private/Language/locallang.xlf' + templateRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Templates/' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Partials/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Layouts/' + addQueryString: false + argumentsToBeExcludedFromQueryString: { } + additionalParams: { } + controllerAction: perform + httpMethod: post + httpEnctype: multipart/form-data + _isCompositeFormElement: false + _isTopLevelFormElement: true + honeypot: + enable: true + formElementToUse: Honeypot + submitButtonLabel: Submit + skipUnknownElements: true + +:aspect:`Good to know` + - :ref:`"Custom templates"<concepts-frontendrendering-templates-customtemplates>` + +:aspect:`Description` + Please read the section :ref:`layoutRootPaths<apireference-frontendrendering-fluidformrenderer-options-layoutrootpaths>`. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/partialRootPaths.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/partialRootPaths.rst new file mode 100644 index 0000000000000000000000000000000000000000..418efc43c545318bf4c365669bf3545faa45dff4 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/partialRootPaths.rst @@ -0,0 +1,55 @@ +renderingOptions.partialRootPaths +--------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.partialRootPaths + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 7-8 + + Form: + renderingOptions: + translation: + translationFile: 'EXT:form/Resources/Private/Language/locallang.xlf' + templateRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Templates/' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Partials/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Layouts/' + addQueryString: false + argumentsToBeExcludedFromQueryString: { } + additionalParams: { } + controllerAction: perform + httpMethod: post + httpEnctype: multipart/form-data + _isCompositeFormElement: false + _isTopLevelFormElement: true + honeypot: + enable: true + formElementToUse: Honeypot + submitButtonLabel: Submit + skipUnknownElements: true + +:aspect:`Good to know` + - :ref:`"Custom templates"<concepts-frontendrendering-templates-customtemplates>` + +:aspect:`partialRootPaths` + Please read the section :ref:`templateRootPaths<apireference-frontendrendering-fluidformrenderer-options-partialrootpaths>`. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/skipUnknownElements.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/skipUnknownElements.rst new file mode 100644 index 0000000000000000000000000000000000000000..bba1c22a1bc83cf196411754f1d65b65ae99721a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/skipUnknownElements.rst @@ -0,0 +1,55 @@ +renderingOptions.skipUnknownElements +------------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.skipUnknownElements + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 23 + + Form: + renderingOptions: + translation: + translationFile: 'EXT:form/Resources/Private/Language/locallang.xlf' + templateRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Templates/' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Partials/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Layouts/' + addQueryString: false + argumentsToBeExcludedFromQueryString: { } + additionalParams: { } + controllerAction: perform + httpMethod: post + httpEnctype: multipart/form-data + _isCompositeFormElement: false + _isTopLevelFormElement: true + honeypot: + enable: true + formElementToUse: Honeypot + submitButtonLabel: Submit + skipUnknownElements: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + If set, every unknown ``<formElementIdentifier>`` will not be rendered. If set to false an exeption will be thrown. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/submitButtonLabel.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/submitButtonLabel.rst new file mode 100644 index 0000000000000000000000000000000000000000..3f193ba81336a8f5beeebe9f55e8d55d27ecc56b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/submitButtonLabel.rst @@ -0,0 +1,55 @@ +renderingOptions.submitButtonLabel +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.submitButtonLabel + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + Yes + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 22 + + Form: + renderingOptions: + translation: + translationFile: 'EXT:form/Resources/Private/Language/locallang.xlf' + templateRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Templates/' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Partials/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Layouts/' + addQueryString: false + argumentsToBeExcludedFromQueryString: { } + additionalParams: { } + controllerAction: perform + httpMethod: post + httpEnctype: multipart/form-data + _isCompositeFormElement: false + _isTopLevelFormElement: true + honeypot: + enable: true + formElementToUse: Honeypot + submitButtonLabel: Submit + skipUnknownElements: true + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + The submit Button label. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/templateRootPaths.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/templateRootPaths.rst new file mode 100644 index 0000000000000000000000000000000000000000..3435f000dad4adb89ab9acfb48f1e0b27702ebff --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/templateRootPaths.rst @@ -0,0 +1,55 @@ +renderingOptions.templateRootPaths +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.templateRootPaths + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5-6 + + Form: + renderingOptions: + translation: + translationFile: 'EXT:form/Resources/Private/Language/locallang.xlf' + templateRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Templates/' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Partials/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Layouts/' + addQueryString: false + argumentsToBeExcludedFromQueryString: { } + additionalParams: { } + controllerAction: perform + httpMethod: post + httpEnctype: multipart/form-data + _isCompositeFormElement: false + _isTopLevelFormElement: true + honeypot: + enable: true + formElementToUse: Honeypot + submitButtonLabel: Submit + skipUnknownElements: true + +:aspect:`Good to know` + - :ref:`"Custom templates"<concepts-frontendrendering-templates-customtemplates>` + +:aspect:`Description` + Please read the section :ref:`templateRootPaths<apireference-frontendrendering-fluidformrenderer-options-templaterootpaths>`. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/translation/translationFile.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/translation/translationFile.rst new file mode 100644 index 0000000000000000000000000000000000000000..6fa7927ccaed36d3abb8904ba82dddce78e9f5de --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Form/renderingOptions/translation/translationFile.rst @@ -0,0 +1,56 @@ +renderingOptions.translation.translationFile +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.translation.translationFile + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + Form: + renderingOptions: + translation: + translationFile: 'EXT:form/Resources/Private/Language/locallang.xlf' + templateRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Templates/' + partialRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Partials/' + layoutRootPaths: + 10: 'EXT:form/Resources/Private/Frontend/Layouts/' + addQueryString: false + argumentsToBeExcludedFromQueryString: { } + additionalParams: { } + controllerAction: perform + httpMethod: post + httpEnctype: multipart/form-data + _isCompositeFormElement: false + _isTopLevelFormElement: true + honeypot: + enable: true + formElementToUse: Honeypot + submitButtonLabel: Submit + skipUnknownElements: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Filesystem path(s) to translation files which should be searched for form element property translations. + If ``translationFile`` is undefined, - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.translation.translationFile"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.translation.translationfile>` will be used. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer.rst new file mode 100644 index 0000000000000000000000000000000000000000..1be21ebb2f9e96442758f72e89cf6f1b1af18ffa --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer.rst @@ -0,0 +1,73 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.gridcontainer: + +=============== +[GridContainer] +=============== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.gridcontainer-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridcontainer.implementationclassname: +.. include:: GridContainer/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridcontainer.properties.containerclassattribute: +.. include:: GridContainer/properties/containerClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridcontainer.properties.elementclassattribute: +.. include:: GridContainer/properties/elementClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridcontainer.properties.elementerrorclassattribute: +.. include:: GridContainer/properties/elementErrorClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridcontainer.properties.gridcolumnclassautoconfiguration.gridsize: +.. include:: GridContainer/properties/gridColumnClassAutoConfiguration/gridSize.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridcontainer.properties.gridcolumnclassautoconfiguration.viewports: +.. include:: GridContainer/properties/gridColumnClassAutoConfiguration/viewPorts.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridcontainer.properties.gridcolumnclassautoconfiguration.viewports.*.classpattern: +.. include:: GridContainer/properties/gridColumnClassAutoConfiguration/viewPorts/classPattern.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridcontainer.renderingoptions._iscompositeformelement: +.. include:: GridContainer/renderingOptions/_isCompositeFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridcontainer.renderingoptions._isgridcontainerformelement: +.. include:: GridContainer/renderingOptions/_isGridContainerFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridcontainer.formeditor: +.. include:: GridContainer/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridcontainer.formeditor.editors.100: +.. include:: GridContainer/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridcontainer.formeditor.editors.200: +.. include:: GridContainer/formEditor/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridcontainer.formeditor.editors.9999: +.. include:: GridContainer/formEditor/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridcontainer.formeditor.predefineddefaults: +.. include:: GridContainer/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridcontainer.formeditor._iscompositeformelement: +.. include:: GridContainer/formEditor/_isCompositeFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridcontainer.formeditor._isgridcontainerformelement: +.. include:: GridContainer/formEditor/_isGridContainerFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridcontainer.formeditor.label: +.. include:: GridContainer/formEditor/label.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridcontainer.formeditor.group: +.. include:: GridContainer/formEditor/group.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridcontainer.formeditor.groupsorting: +.. include:: GridContainer/formEditor/groupSorting.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridcontainer.formeditor.iconidentifier: +.. include:: GridContainer/formEditor/iconIdentifier.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..62ac5ea2f428f10d5544e60171182b6d39b73251 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor.rst @@ -0,0 +1,41 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + GridContainer: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.GridContainer.editor.label.label + propertyPath: label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: { } + label: formEditor.elements.GridContainer.label + group: container + groupSorting: 200 + _isCompositeFormElement: true + _isGridContainerFormElement: true + iconIdentifier: t3-form-icon-gridcontainer diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/_isCompositeFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/_isCompositeFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..280f7fca95263c6f518e45a07a9821d77efde8e5 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/_isCompositeFormElement.rst @@ -0,0 +1,29 @@ +formEditor._isCompositeFormElement +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.formEditor._isCompositeFormElement + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + GridContainer: + formEditor: + _isCompositeFormElement: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting to define that the form element contains child form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/_isGridContainerFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/_isGridContainerFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..fe5433b1ab69d52e0198caf88de53bd0b2e96684 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/_isGridContainerFormElement.rst @@ -0,0 +1,29 @@ +formEditor._isGridContainerFormElement +-------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.formEditor._isGridContainerFormElement + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + GridContainer: + formEditor: + _isGridContainerFormElement: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..6f32af192efcf1ebd97e7fc6800eb2e072fd47e4 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/editors/100.rst @@ -0,0 +1,29 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + GridContainer: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..cf8d1e19597aa0cecd393e88f1a61e590905de0b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/editors/200.rst @@ -0,0 +1,31 @@ +formEditor.editors.200 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.formEditor.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + GridContainer: + formEditor: + editors: + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.GridContainer.editor.label.label + propertyPath: label diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..36a1d1a1b1fee1b387dab204e671d72fd153354d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/editors/9999.rst @@ -0,0 +1,30 @@ +formEditor.editors.9999 +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.formEditor.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + GridContainer: + formEditor: + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/group.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/group.rst new file mode 100644 index 0000000000000000000000000000000000000000..381ba350403827af952c57fe0cc828059c85c42d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/group.rst @@ -0,0 +1,30 @@ +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + GridContainer: + formEditor: + group: container + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/groupSorting.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/groupSorting.rst new file mode 100644 index 0000000000000000000000000000000000000000..1ce362bf67a0dd07545294a7bd6ab7ee2e8e7299 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/groupSorting.rst @@ -0,0 +1,29 @@ +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + GridContainer: + formEditor: + groupSorting: 200 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..0faf8bfe88342aee9482816644b0ec8db6203078 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + GridContainer: + formEditor: + iconIdentifier: t3-form-icon-gridcontainer + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..e2035bff94b3778b303b28a46114c2cd0dafc36c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/label.rst @@ -0,0 +1,29 @@ +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + GridContainer: + formEditor: + label: formEditor.elements.GridContainer.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..79183ddee195b5b7c698666218023ee69bcabc9b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/formEditor/predefinedDefaults.rst @@ -0,0 +1,29 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + GridContainer: + formEditor: + predefinedDefaults: { } + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..719854c583921115306678a6f96afc551d79d09f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + GridContainer: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GridContainer + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/properties/containerClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/properties/containerClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..c6ab715cbc5343490b5f704da6b86a78762984cc --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/properties/containerClassAttribute.rst @@ -0,0 +1,48 @@ +properties.containerClassAttribute +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.properties.containerClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + GridContainer: + properties: + containerClassAttribute: input + elementClassAttribute: container + elementErrorClassAttribute: error + gridColumnClassAutoConfiguration: + gridSize: 12 + viewPorts: + xs: + classPattern: 'col-xs-{@numbersOfColumnsToUse}' + sm: + classPattern: 'col-sm-{@numbersOfColumnsToUse}' + md: + classPattern: 'col-md-{@numbersOfColumnsToUse}' + lg: + classPattern: 'col-lg-{@numbersOfColumnsToUse}' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is typically wrapped around the form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/properties/elementClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/properties/elementClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..c7c09cc9b03787214536cf0ba0ed2b7ac7696349 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/properties/elementClassAttribute.rst @@ -0,0 +1,48 @@ +properties.elementClassAttribute +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.properties.elementClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + GridContainer: + properties: + containerClassAttribute: input + elementClassAttribute: container + elementErrorClassAttribute: error + gridColumnClassAutoConfiguration: + gridSize: 12 + viewPorts: + xs: + classPattern: 'col-xs-{@numbersOfColumnsToUse}' + sm: + classPattern: 'col-sm-{@numbersOfColumnsToUse}' + md: + classPattern: 'col-md-{@numbersOfColumnsToUse}' + lg: + classPattern: 'col-lg-{@numbersOfColumnsToUse}' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class written to the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/properties/elementErrorClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/properties/elementErrorClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..c2c1cfca66f12b979c11e38df98e7de331e8816c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/properties/elementErrorClassAttribute.rst @@ -0,0 +1,48 @@ +properties.elementErrorClassAttribute +------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.properties.elementErrorClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + GridContainer: + properties: + containerClassAttribute: input + elementClassAttribute: container + elementErrorClassAttribute: error + gridColumnClassAutoConfiguration: + gridSize: 12 + viewPorts: + xs: + classPattern: 'col-xs-{@numbersOfColumnsToUse}' + sm: + classPattern: 'col-sm-{@numbersOfColumnsToUse}' + md: + classPattern: 'col-md-{@numbersOfColumnsToUse}' + lg: + classPattern: 'col-lg-{@numbersOfColumnsToUse}' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is written to the form element if validation errors exists. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/properties/gridColumnClassAutoConfiguration/gridSize.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/properties/gridColumnClassAutoConfiguration/gridSize.rst new file mode 100644 index 0000000000000000000000000000000000000000..712b5b4424a561fb9017f0bfa7f4919c759b1c47 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/properties/gridColumnClassAutoConfiguration/gridSize.rst @@ -0,0 +1,48 @@ +properties.gridColumnClassAutoConfiguration.gridSize +---------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.properties.gridColumnClassAutoConfiguration.gridSize + +:aspect:`Data type` + int + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 7 + + GridContainer: + properties: + containerClassAttribute: input + elementClassAttribute: container + elementErrorClassAttribute: error + gridColumnClassAutoConfiguration: + gridSize: 12 + viewPorts: + xs: + classPattern: 'col-xs-{@numbersOfColumnsToUse}' + sm: + classPattern: 'col-sm-{@numbersOfColumnsToUse}' + md: + classPattern: 'col-md-{@numbersOfColumnsToUse}' + lg: + classPattern: 'col-lg-{@numbersOfColumnsToUse}' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The grid size of the CSS grid system (bootstrap by default). \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/properties/gridColumnClassAutoConfiguration/viewPorts.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/properties/gridColumnClassAutoConfiguration/viewPorts.rst new file mode 100644 index 0000000000000000000000000000000000000000..c39a9fa893461bc416bc0aac2d81c5a5cfbbb110 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/properties/gridColumnClassAutoConfiguration/viewPorts.rst @@ -0,0 +1,48 @@ +properties.gridColumnClassAutoConfiguration.viewPorts +----------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.properties.gridColumnClassAutoConfiguration.viewPorts + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + GridContainer: + properties: + containerClassAttribute: input + elementClassAttribute: container + elementErrorClassAttribute: error + gridColumnClassAutoConfiguration: + gridSize: 12 + viewPorts: + xs: + classPattern: 'col-xs-{@numbersOfColumnsToUse}' + sm: + classPattern: 'col-sm-{@numbersOfColumnsToUse}' + md: + classPattern: 'col-md-{@numbersOfColumnsToUse}' + lg: + classPattern: 'col-lg-{@numbersOfColumnsToUse}' + +:aspect:`Related options` + - :ref:`"properties.gridColumnClassAutoConfiguration"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.\<formelementtypeidentifier>.properties.gridcolumnclassautoconfiguration>` + +:aspect:`Description` + Each configuration key within `properties.gridColumnClassAutoConfiguration.viewPorts` represents an viewport of the CSS grid system (bootstrap by default). \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/properties/gridColumnClassAutoConfiguration/viewPorts/classPattern.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/properties/gridColumnClassAutoConfiguration/viewPorts/classPattern.rst new file mode 100644 index 0000000000000000000000000000000000000000..1c26ba52a573bb5a10de1077dde23c658215ae86 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/properties/gridColumnClassAutoConfiguration/viewPorts/classPattern.rst @@ -0,0 +1,52 @@ +properties.gridColumnClassAutoConfiguration.viewPorts.[*].classPattern +---------------------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.properties.gridColumnClassAutoConfiguration.viewPorts.<gridColumnClassAutoConfigurationViewPortIdentifier>.classPattern + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 10, 12, 14, 16 + + GridContainer: + properties: + containerClassAttribute: input + elementClassAttribute: container + elementErrorClassAttribute: error + gridColumnClassAutoConfiguration: + gridSize: 12 + viewPorts: + xs: + classPattern: 'col-xs-{@numbersOfColumnsToUse}' + sm: + classPattern: 'col-sm-{@numbersOfColumnsToUse}' + md: + classPattern: 'col-md-{@numbersOfColumnsToUse}' + lg: + classPattern: 'col-lg-{@numbersOfColumnsToUse}' + +:aspect:`Related options` + - :ref:`"properties.gridColumnClassAutoConfiguration"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.\<formelementtypeidentifier>.properties.gridcolumnclassautoconfiguration>` + +:aspect:`Description` + Defines the CSS class pattern for the CSS grid system. + Each viewport `classPattern` will be wrapped around a form element within a grid row. + The `{@numbersOfColumnsToUse}` placeholder will be replaced by the number of columns which the respective form element should occupy. + The number of columns which the respective form element should occupy has to defined within the respective form elements within a GridRow. + If a form element has no number of columns defined, the ``{@numbersOfColumnsToUse}`` are calculated automatically. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/renderingOptions/_isCompositeFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/renderingOptions/_isCompositeFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..e8721a91ed35c9579277c4b8836aec58825f51eb --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/renderingOptions/_isCompositeFormElement.rst @@ -0,0 +1,36 @@ +renderingOptions._isCompositeFormElement +---------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.renderingOptions._isCompositeFormElement + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + GridContainer: + renderingOptions: + _isCompositeFormElement: true + _isGridContainerFormElement: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting to define that the form element contains child form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/renderingOptions/_isGridContainerFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/renderingOptions/_isGridContainerFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..dc4b81edcdeafe9844131dfaf2172258e106d34e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridContainer/renderingOptions/_isGridContainerFormElement.rst @@ -0,0 +1,36 @@ +renderingOptions._isGridContainerFormElement +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.renderingOptions._isGridContainerFormElement + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + GridContainer: + renderingOptions: + _isCompositeFormElement: true + _isGridContainerFormElement: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow.rst new file mode 100644 index 0000000000000000000000000000000000000000..225a1dce61d993f950aa790de7bc3d90a052bc7c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow.rst @@ -0,0 +1,76 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.gridrow: + +========= +[GridRow] +========= + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.gridrow-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.implementationclassname: +.. include:: GridRow/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.properties.containerclassattribute: +.. include:: GridRow/properties/containerClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.properties.elementclassattribute: +.. include:: GridRow/properties/elementClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.properties.elementerrorclassattribute: +.. include:: GridRow/properties/elementErrorClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.properties.gridcolumnclassautoconfiguration.gridsize: +.. include:: GridRow/properties/gridColumnClassAutoConfiguration/gridSize.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.properties.gridcolumnclassautoconfiguration.viewports: +.. include:: GridRow/properties/gridColumnClassAutoConfiguration/viewPorts.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.properties.gridcolumnclassautoconfiguration.viewports.*.classpattern: +.. include:: GridRow/properties/gridColumnClassAutoConfiguration/viewPorts/classPattern.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.renderingoptions._iscompositeformelement: +.. include:: GridRow/renderingOptions/_isCompositeFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.renderingoptions._isgridrowformelement: +.. include:: GridRow/renderingOptions/_isGridRowFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.formeditor: +.. include:: GridRow/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.formeditor.editors.100: +.. include:: GridRow/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.formeditor.editors.200: +.. include:: GridRow/formEditor/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.formeditor.editors.700: +.. include:: GridRow/formEditor/editors/700.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.formeditor.editors.9999: +.. include:: GridRow/formEditor/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.formeditor.predefineddefaults: +.. include:: GridRow/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.formeditor._iscompositeformelement: +.. include:: GridRow/formEditor/_isCompositeFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.formeditor._isgridrowformelement: +.. include:: GridRow/formEditor/_isGridRowFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.formeditor.label: +.. include:: GridRow/formEditor/label.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.formeditor.group: +.. include:: GridRow/formEditor/group.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.formeditor.groupsorting: +.. include:: GridRow/formEditor/groupSorting.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.gridrow.formeditor.iconidentifier: +.. include:: GridRow/formEditor/iconIdentifier.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..0e9d9f02d3e851381ce94e5cca35fc82203092f7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor.rst @@ -0,0 +1,63 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + GridRow: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.GridRow.editor.label.label + propertyPath: label + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: { } + label: formEditor.elements.GridRow.label + group: container + groupSorting: 300 + _isCompositeFormElement: true + _isGridRowFormElement: true + iconIdentifier: t3-form-icon-gridrow diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/_isCompositeFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/_isCompositeFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..4da261dd1d2d0a180d0403cba710ae1944650062 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/_isCompositeFormElement.rst @@ -0,0 +1,29 @@ +formEditor._isCompositeFormElement +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.formEditor._isCompositeFormElement + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + GridRow: + formEditor: + _isCompositeFormElement: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting to define that the form element contains child form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/_isGridRowFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/_isGridRowFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..040977afe693497dbe93a94ba0381aa60f4cb9af --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/_isGridRowFormElement.rst @@ -0,0 +1,29 @@ +formEditor._isGridRowFormElement +-------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridContainer.formEditor._isGridRowFormElement + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + GridContainer: + formEditor: + _isGridRowFormElement: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + todo diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..fffe08215968161d20a0da86e7dd4db177415549 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/editors/100.rst @@ -0,0 +1,29 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + GridRow: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..33866aba148f555b9a12fd1c375be034b1b31afd --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/editors/200.rst @@ -0,0 +1,31 @@ +formEditor.editors.200 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.formEditor.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + GridRow: + formEditor: + editors: + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.GridRow.editor.label.label + propertyPath: label diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/editors/700.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/editors/700.rst new file mode 100644 index 0000000000000000000000000000000000000000..cb703cf1bc087a5a703eb7943e9bfc3879e52890 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/editors/700.rst @@ -0,0 +1,49 @@ +formEditor.editors.700 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.formEditor.editors.700 + +:aspect:`Data type` + array/ :ref:`[GridColumnViewPortConfigurationEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + GridRow: + formEditor: + editors: + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..2c20f276bf8573e8aac698020909d830232e4de6 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/editors/9999.rst @@ -0,0 +1,30 @@ +formEditor.editors.9999 +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.formEditor.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + GridRow: + formEditor: + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/group.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/group.rst new file mode 100644 index 0000000000000000000000000000000000000000..5491afd505ea670705625e6235b50fa963703bb0 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/group.rst @@ -0,0 +1,30 @@ +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + GridRow: + formEditor: + group: container + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/groupSorting.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/groupSorting.rst new file mode 100644 index 0000000000000000000000000000000000000000..c2b0ab8ab0eda7fd11de753caee0d1e775598901 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/groupSorting.rst @@ -0,0 +1,29 @@ +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + GridRow: + formEditor: + groupSorting: 300 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..523c888b5e132a126f01f162f37d079fe059db5c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + GridRow: + formEditor: + iconIdentifier: t3-form-icon-gridrow + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..35e8c9b9131016b513b3f9e95645579b29882686 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/label.rst @@ -0,0 +1,29 @@ +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + GridRow: + formEditor: + label: formEditor.elements.GridRow.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..aac4b024c34cae0cb37e0401c258c85afa8aeb3a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/formEditor/predefinedDefaults.rst @@ -0,0 +1,29 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + GridRow: + formEditor: + predefinedDefaults: { } + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..371b2364e7d32f0d787924a40411a94795d52053 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + GridRow: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GridRow + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/properties/containerClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/properties/containerClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..67e1ca28cc39606502de1d8ba4144836ff4b5675 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/properties/containerClassAttribute.rst @@ -0,0 +1,48 @@ +properties.containerClassAttribute +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.properties.containerClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + GridRow: + properties: + containerClassAttribute: input + elementClassAttribute: row + elementErrorClassAttribute: error + gridColumnClassAutoConfiguration: + gridSize: 12 + viewPorts: + xs: + classPattern: 'col-xs-{@numbersOfColumnsToUse}' + sm: + classPattern: 'col-sm-{@numbersOfColumnsToUse}' + md: + classPattern: 'col-md-{@numbersOfColumnsToUse}' + lg: + classPattern: 'col-lg-{@numbersOfColumnsToUse}' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is typically wrapped around the form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/properties/elementClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/properties/elementClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..0880b145ec0b3e35a10a2ec42c13d912537eb845 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/properties/elementClassAttribute.rst @@ -0,0 +1,48 @@ +properties.elementClassAttribute +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.properties.elementClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + GridRow: + properties: + containerClassAttribute: input + elementClassAttribute: row + elementErrorClassAttribute: error + gridColumnClassAutoConfiguration: + gridSize: 12 + viewPorts: + xs: + classPattern: 'col-xs-{@numbersOfColumnsToUse}' + sm: + classPattern: 'col-sm-{@numbersOfColumnsToUse}' + md: + classPattern: 'col-md-{@numbersOfColumnsToUse}' + lg: + classPattern: 'col-lg-{@numbersOfColumnsToUse}' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class written to the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/properties/elementErrorClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/properties/elementErrorClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..068cd75b785827c29efac9f57ed5016ebfb813cc --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/properties/elementErrorClassAttribute.rst @@ -0,0 +1,48 @@ +properties.elementErrorClassAttribute +------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.properties.elementErrorClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + GridRow: + properties: + containerClassAttribute: input + elementClassAttribute: row + elementErrorClassAttribute: error + gridColumnClassAutoConfiguration: + gridSize: 12 + viewPorts: + xs: + classPattern: 'col-xs-{@numbersOfColumnsToUse}' + sm: + classPattern: 'col-sm-{@numbersOfColumnsToUse}' + md: + classPattern: 'col-md-{@numbersOfColumnsToUse}' + lg: + classPattern: 'col-lg-{@numbersOfColumnsToUse}' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is written to the form element if validation errors exists. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/properties/gridColumnClassAutoConfiguration/gridSize.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/properties/gridColumnClassAutoConfiguration/gridSize.rst new file mode 100644 index 0000000000000000000000000000000000000000..e56c3f6b50780abb63e5e0ba5866abe2dbcde37b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/properties/gridColumnClassAutoConfiguration/gridSize.rst @@ -0,0 +1,48 @@ +properties.gridColumnClassAutoConfiguration.gridSize +---------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.properties.gridColumnClassAutoConfiguration.gridSize + +:aspect:`Data type` + int + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 7 + + GridRow: + properties: + containerClassAttribute: input + elementClassAttribute: row + elementErrorClassAttribute: error + gridColumnClassAutoConfiguration: + gridSize: 12 + viewPorts: + xs: + classPattern: 'col-xs-{@numbersOfColumnsToUse}' + sm: + classPattern: 'col-sm-{@numbersOfColumnsToUse}' + md: + classPattern: 'col-md-{@numbersOfColumnsToUse}' + lg: + classPattern: 'col-lg-{@numbersOfColumnsToUse}' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The grid size of the CSS grid system (bootstrap by default). \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/properties/gridColumnClassAutoConfiguration/viewPorts.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/properties/gridColumnClassAutoConfiguration/viewPorts.rst new file mode 100644 index 0000000000000000000000000000000000000000..81811426a03969cc5dfcac1d4a1a984e10c16455 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/properties/gridColumnClassAutoConfiguration/viewPorts.rst @@ -0,0 +1,48 @@ +properties.gridColumnClassAutoConfiguration.viewPorts +----------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.properties.gridColumnClassAutoConfiguration.viewPorts + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + GridRow: + properties: + containerClassAttribute: input + elementClassAttribute: row + elementErrorClassAttribute: error + gridColumnClassAutoConfiguration: + gridSize: 12 + viewPorts: + xs: + classPattern: 'col-xs-{@numbersOfColumnsToUse}' + sm: + classPattern: 'col-sm-{@numbersOfColumnsToUse}' + md: + classPattern: 'col-md-{@numbersOfColumnsToUse}' + lg: + classPattern: 'col-lg-{@numbersOfColumnsToUse}' + +:aspect:`Related options` + - :ref:`"properties.gridColumnClassAutoConfiguration"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.\<formelementtypeidentifier>.properties.gridcolumnclassautoconfiguration>` + +:aspect:`Description` + Each configuration key within `properties.gridColumnClassAutoConfiguration.viewPorts` represents an viewport of the CSS grid system (bootstrap by default). \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/properties/gridColumnClassAutoConfiguration/viewPorts/classPattern.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/properties/gridColumnClassAutoConfiguration/viewPorts/classPattern.rst new file mode 100644 index 0000000000000000000000000000000000000000..b6983eae9eba308bf8353514d02f455b9205cba9 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/properties/gridColumnClassAutoConfiguration/viewPorts/classPattern.rst @@ -0,0 +1,52 @@ +properties.gridColumnClassAutoConfiguration.viewPorts.[*].classPattern +---------------------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.properties.gridColumnClassAutoConfiguration.viewPorts.<gridColumnClassAutoConfigurationViewPortIdentifier>.classPattern + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 10, 12, 14, 16 + + GridRow: + properties: + containerClassAttribute: input + elementClassAttribute: row + elementErrorClassAttribute: error + gridColumnClassAutoConfiguration: + gridSize: 12 + viewPorts: + xs: + classPattern: 'col-xs-{@numbersOfColumnsToUse}' + sm: + classPattern: 'col-sm-{@numbersOfColumnsToUse}' + md: + classPattern: 'col-md-{@numbersOfColumnsToUse}' + lg: + classPattern: 'col-lg-{@numbersOfColumnsToUse}' + +:aspect:`Related options` + - :ref:`"properties.gridColumnClassAutoConfiguration"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.\<formelementtypeidentifier>.properties.gridcolumnclassautoconfiguration>` + +:aspect:`Description` + Defines the CSS class pattern for the CSS grid system. + Each viewport `classPattern` will be wrapped around a form element within a grid row. + The `{@numbersOfColumnsToUse}` placeholder will be replaced by the number of columns which the respective form element should occupy. + The number of columns which the respective form element should occupy has to defined within the respective form elements within a GridRow. + If a form element has no number of columns defined, the ``{@numbersOfColumnsToUse}`` are calculated automatically. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/renderingOptions/_isCompositeFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/renderingOptions/_isCompositeFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..a85a1894dffabb780f410803f5f5ed26406a0137 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/renderingOptions/_isCompositeFormElement.rst @@ -0,0 +1,36 @@ +renderingOptions._isCompositeFormElement +---------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.renderingOptions._isCompositeFormElement + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + GridRow: + renderingOptions: + _isCompositeFormElement: true + _isGridRowFormElement: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting to define that the form element contains child form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/renderingOptions/_isGridRowFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/renderingOptions/_isGridRowFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..b98a6e29f39068fc4a687215def91c8563e7784a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/GridRow/renderingOptions/_isGridRowFormElement.rst @@ -0,0 +1,36 @@ +renderingOptions._isGridRowFormElement +-------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.renderingOptions._isGridRowFormElement + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + GridRow: + renderingOptions: + _isCompositeFormElement: true + _isGridRowFormElement: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden.rst new file mode 100644 index 0000000000000000000000000000000000000000..98b775ca30b87338b68a99691c55083a03bdd024 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden.rst @@ -0,0 +1,59 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.hidden: + +======== +[Hidden] +======== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.hidden-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.hidden.implementationclassname: +.. include:: Hidden/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.hidden.properties.containerclassattribute: +.. include:: Hidden/properties/containerClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.hidden.properties.elementclassattribute: +.. include:: Hidden/properties/elementClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.hidden.properties.elementerrorclassattribute: +.. include:: Hidden/properties/elementErrorClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.hidden.formeditor: +.. include:: Hidden/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.hidden.formeditor.editors.100: +.. include:: Hidden/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.hidden.formeditor.editors.200: +.. include:: Hidden/formEditor/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.hidden.formeditor.editors.300: +.. include:: Hidden/formEditor/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.hidden.formeditor.editors.700: +.. include:: Hidden/formEditor/editors/700.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.hidden.formeditor.editors.9999: +.. include:: Hidden/formEditor/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.hidden.formeditor.predefineddefaults: +.. include:: Hidden/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.hidden.formeditor.label: +.. include:: Hidden/formEditor/label.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.hidden.formeditor.group: +.. include:: Hidden/formEditor/group.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.hidden.formeditor.groupsorting: +.. include:: Hidden/formEditor/groupSorting.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.hidden.formeditor.iconidentifier: +.. include:: Hidden/formEditor/iconIdentifier.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..0428983f176209b16bdaa02f3bc138af253f2cb6 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor.rst @@ -0,0 +1,67 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Hidden.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + Hidden: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 300: + identifier: defaultValue + templateName: Inspector-TextEditor + label: formEditor.elements.Hidden.editor.defaultValue.label + propertyPath: defaultValue + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + defaultValue: '' + label: formEditor.elements.Hidden.label + group: custom + groupSorting: 300 + iconIdentifier: t3-form-icon-hidden diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..0b60a5f1e51915fd84f84ccb64316b5732d81488 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/editors/100.rst @@ -0,0 +1,29 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Hidden.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Hidden: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..eba5971725676ac8db0bc9cbfb75749983fa45e4 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/editors/200.rst @@ -0,0 +1,31 @@ +formEditor.editors.200 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Hidden.formEditor.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Hidden: + formEditor: + editors: + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..398984c618e23d165d09fa294d401352fd2ff323 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/editors/300.rst @@ -0,0 +1,31 @@ +formEditor.editors.300 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Hidden.formEditor.editors.300 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Hidden: + formEditor: + editors: + 300: + identifier: defaultValue + templateName: Inspector-TextEditor + label: formEditor.elements.Hidden.editor.defaultValue.label + propertyPath: defaultValue diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/editors/700.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/editors/700.rst new file mode 100644 index 0000000000000000000000000000000000000000..f33be242adc32356fc86b7bc69299b232cef3eef --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/editors/700.rst @@ -0,0 +1,49 @@ +formEditor.editors.700 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Hidden.formEditor.editors.700 + +:aspect:`Data type` + array/ :ref:`[GridColumnViewPortConfigurationEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Hidden: + formEditor: + editors: + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..9727cf75ace951e4667809f409425a14b46ac440 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/editors/9999.rst @@ -0,0 +1,30 @@ +formEditor.editors.9999 +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Hidden.formEditor.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Hidden: + formEditor: + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/group.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/group.rst new file mode 100644 index 0000000000000000000000000000000000000000..2a8ba6a36ef2d7d765111bef4b92c32e45e0440e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/group.rst @@ -0,0 +1,30 @@ +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Hidden.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Hidden: + formEditor: + group: custom + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/groupSorting.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/groupSorting.rst new file mode 100644 index 0000000000000000000000000000000000000000..13b48f09b895b02c75f060630fb4ecbe6ec1d7f0 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/groupSorting.rst @@ -0,0 +1,29 @@ +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Hidden.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Hidden: + formEditor: + groupSorting: 300 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..6015f1595c4b4f94cc35523ac015ec00791171db --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Hidden.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Hidden: + formEditor: + iconIdentifier: t3-form-icon-hidden + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..9b24907cb245a9f32b1e32094afd0534aa0d7b2a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/label.rst @@ -0,0 +1,29 @@ +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Hidden.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Hidden: + formEditor: + label: formEditor.elements.Hidden.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..12a8524bb45053367b3ab53b0963322b73cc1c07 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/formEditor/predefinedDefaults.rst @@ -0,0 +1,30 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Hidden.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Hidden: + formEditor: + predefinedDefaults: + defaultValue: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..23feaae8171e771c127f42b2c1296840c1c36965 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Hidden.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + Hidden: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/properties/containerClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/properties/containerClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..421ba1f718859979bbce867689cefbda48433636 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/properties/containerClassAttribute.rst @@ -0,0 +1,37 @@ +properties.containerClassAttribute +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Hidden.properties.containerClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Hidden: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is typically wrapped around the form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/properties/elementClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/properties/elementClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..aa7ae2864217034c6e6f04e293d3803f0929c18d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/properties/elementClassAttribute.rst @@ -0,0 +1,37 @@ +properties.elementClassAttribute +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Hidden.properties.elementClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + Hidden: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class written to the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/properties/elementErrorClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/properties/elementErrorClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..89324042581f5255df5099207e73b1479391701d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Hidden/properties/elementErrorClassAttribute.rst @@ -0,0 +1,37 @@ +properties.elementErrorClassAttribute +------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Hidden.properties.elementErrorClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + Hidden: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is written to the form element if validation errors exists. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot.rst new file mode 100644 index 0000000000000000000000000000000000000000..e0a691ea65bc45c91281354babc8770ea221fc79 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot.rst @@ -0,0 +1,31 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.honeypot: + +========== +[Honeypot] +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.honeypot-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.honeypot.implementationclassname: +.. include:: Honeypot/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.honeypot.properties.containerclassattribute: +.. include:: Honeypot/properties/containerClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.honeypot.properties.elementclassattribute: +.. include:: Honeypot/properties/elementClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.honeypot.properties.elementerrorclassattribute: +.. include:: Honeypot/properties/elementErrorClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.honeypot.properties.renderashiddenfield: +.. include:: Honeypot/properties/renderAsHiddenField.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.honeypot.properties.styleattribute: +.. include:: Honeypot/properties/styleAttribute.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..cd197b195fb93fcf1cc804924c795947a56cb19e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Honeypot.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + Honeypot: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot/properties/containerClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot/properties/containerClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..afb05eb2e21f9ae7c961f0db78f1f816f5248200 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot/properties/containerClassAttribute.rst @@ -0,0 +1,39 @@ +properties.containerClassAttribute +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Honeypot.properties.containerClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Honeypot: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + renderAsHiddenField: false + styleAttribute: 'position:absolute; margin:0 0 0 -999em;' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is typically wrapped around the form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot/properties/elementClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot/properties/elementClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..17c3f94a231b2be947b03c5db3aac58eb621fdb1 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot/properties/elementClassAttribute.rst @@ -0,0 +1,39 @@ +properties.elementClassAttribute +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Honeypot.properties.elementClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + Honeypot: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + renderAsHiddenField: false + styleAttribute: 'position:absolute; margin:0 0 0 -999em;' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class written to the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot/properties/elementErrorClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot/properties/elementErrorClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..be59e754304a91f1268d5f98e9ea34a914624589 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot/properties/elementErrorClassAttribute.rst @@ -0,0 +1,39 @@ +properties.elementErrorClassAttribute +------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Honeypot.properties.elementErrorClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + Honeypot: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + renderAsHiddenField: false + styleAttribute: 'position:absolute; margin:0 0 0 -999em;' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is written to the form element if validation errors exists. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot/properties/renderAsHiddenField.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot/properties/renderAsHiddenField.rst new file mode 100644 index 0000000000000000000000000000000000000000..628cff8a9f4f2b4cf4c3a8507118df9910634e57 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot/properties/renderAsHiddenField.rst @@ -0,0 +1,39 @@ +properties.renderAsHiddenField +------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Honeypot.properties.renderAsHiddenField + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Honeypot: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + renderAsHiddenField: false + styleAttribute: 'position:absolute; margin:0 0 0 -999em;' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + By default the honeypot will be rendered as a regular text form element (input type "text"). ``renderAsHiddenField`` renders the honeypot as a hidden form element (input type "hidden"). \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot/properties/styleAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot/properties/styleAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..b6c40e842de8d5601917603ce10a3c57f0ca7066 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Honeypot/properties/styleAttribute.rst @@ -0,0 +1,39 @@ +properties.styleAttribute +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Honeypot.properties.styleAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 7 + + Honeypot: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + renderAsHiddenField: false + styleAttribute: 'position:absolute; margin:0 0 0 -999em;' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + By default the honeypot will be rendered as a regular text form element (input type "text"). The ``styleAttribute`` is written to the honeypot form element to make it "invisible" for humans. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload.rst new file mode 100644 index 0000000000000000000000000000000000000000..a93322cee6026623b38e312e46eab40786669f67 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload.rst @@ -0,0 +1,79 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.imageupload: + +============= +[ImageUpload] +============= + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.imageupload-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.implementationclassname: +.. include:: ImageUpload/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.properties.containerclassattribute: +.. include:: ImageUpload/properties/containerClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.properties.elementclassattribute: +.. include:: ImageUpload/properties/elementClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.properties.elementerrorclassattribute: +.. include:: ImageUpload/properties/elementErrorClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.properties.savetofilemount: +.. include:: ImageUpload/properties/saveToFileMount.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.properties.allowedmimetypes: +.. include:: ImageUpload/properties/allowedMimeTypes.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.properties.imagelinkmaxwidth: +.. include:: ImageUpload/properties/imageLinkMaxWidth.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.properties.imagemaxwidth: +.. include:: ImageUpload/properties/imageMaxWidth.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.properties.imagemaxheight: +.. include:: ImageUpload/properties/imageMaxHeight.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.formeditor: +.. include:: ImageUpload/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.formeditor.editors.100: +.. include:: ImageUpload/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.formeditor.editors.200: +.. include:: ImageUpload/formEditor/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.formeditor.editors.300: +.. include:: ImageUpload/formEditor/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.formeditor.editors.400: +.. include:: ImageUpload/formEditor/editors/400.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.formeditor.editors.700: +.. include:: ImageUpload/formEditor/editors/700.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.formeditor.editors.800: +.. include:: ImageUpload/formEditor/editors/800.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.formeditor.editors.9999: +.. include:: ImageUpload/formEditor/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.formeditor.predefineddefaults: +.. include:: ImageUpload/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.formeditor.label: +.. include:: ImageUpload/formEditor/label.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.formeditor.group: +.. include:: ImageUpload/formEditor/group.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.formeditor.groupsorting: +.. include:: ImageUpload/formEditor/groupSorting.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.imageupload.formeditor.iconidentifier: +.. include:: ImageUpload/formEditor/iconIdentifier.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..22df255f0848f2ce684ba0c90f56eae8066452c4 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor.rst @@ -0,0 +1,96 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + ImageUpload: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 300: + identifier: allowedMimeTypes + templateName: Inspector-MultiSelectEditor + label: formEditor.elements.ImageUpload.editor.allowedMimeTypes.label + propertyPath: properties.allowedMimeTypes + selectOptions: + 10: + value: image/jpeg + label: formEditor.elements.ImageUpload.editor.allowedMimeTypes.jpg + 20: + value: image/png + label: formEditor.elements.ImageUpload.editor.allowedMimeTypes.png + 30: + value: image/bmp + label: formEditor.elements.ImageUpload.editor.allowedMimeTypes.bmp + 400: + identifier: saveToFileMount + templateName: Inspector-SingleSelectEditor + label: formEditor.elements.FileUploadMixin.editor.saveToFileMount.label + propertyPath: properties.saveToFileMount + selectOptions: + 10: + value: '1:/user_upload/' + label: '1:/user_upload/' + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + properties: + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - image/jpeg + label: formEditor.elements.ImageUpload.label + group: custom + groupSorting: 400 + iconIdentifier: t3-form-icon-image-upload diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..c00530037346d9c6b499ec1509d489fe77bf20e5 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/100.rst @@ -0,0 +1,29 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + ImageUpload: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..bc07871452df95e2d84a2cd9c24aff3ba0ce94f2 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/200.rst @@ -0,0 +1,31 @@ +formEditor.editors.200 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.formEditor.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + ImageUpload: + formEditor: + editors: + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..b59d331ca7ec66346387ab49bb9c7720122bb791 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/300.rst @@ -0,0 +1,41 @@ +formEditor.editors.300 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.formEditor.editors.300 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + ImageUpload: + formEditor: + editors: + 300: + identifier: allowedMimeTypes + templateName: Inspector-MultiSelectEditor + label: formEditor.elements.ImageUpload.editor.allowedMimeTypes.label + propertyPath: properties.allowedMimeTypes + selectOptions: + 10: + value: image/jpeg + label: formEditor.elements.ImageUpload.editor.allowedMimeTypes.jpg + 20: + value: image/png + label: formEditor.elements.ImageUpload.editor.allowedMimeTypes.png + 30: + value: image/bmp + label: formEditor.elements.ImageUpload.editor.allowedMimeTypes.bmp diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/400.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/400.rst new file mode 100644 index 0000000000000000000000000000000000000000..8edd1ed2efa9ba619b67fbe9d3f8a2e473f6fbb0 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/400.rst @@ -0,0 +1,36 @@ +formEditor.editors.400 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.formEditor.editors.400 + +:aspect:`Data type` + array/ :ref:`[SingleSelectEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.singleselecteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + ImageUpload: + formEditor: + editors: + 400: + identifier: saveToFileMount + templateName: Inspector-SingleSelectEditor + label: formEditor.elements.FileUploadMixin.editor.saveToFileMount.label + propertyPath: properties.saveToFileMount + selectOptions: + 10: + value: '1:/user_upload/' + label: '1:/user_upload/' + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/700.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/700.rst new file mode 100644 index 0000000000000000000000000000000000000000..9196bd0046dd8492d8b13bfe0d42d5cc4bf7339d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/700.rst @@ -0,0 +1,49 @@ +formEditor.editors.700 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.formEditor.editors.700 + +:aspect:`Data type` + array/ :ref:`[GridColumnViewPortConfigurationEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + ImageUpload: + formEditor: + editors: + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/800.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/800.rst new file mode 100644 index 0000000000000000000000000000000000000000..f5391a8816d5b9248e587545a5d3389673c43e10 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/800.rst @@ -0,0 +1,35 @@ +formEditor.editors.800 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.formEditor.editors.800 + +:aspect:`Data type` + array/ :ref:`[RequiredValidatorEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + ImageUpload: + formEditor: + editors: + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..9a5099ff4c1ac02bafa43f67e8648fc39367c62b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/editors/9999.rst @@ -0,0 +1,30 @@ +formEditor.editors.9999 +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.formEditor.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + ImageUpload: + formEditor: + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/group.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/group.rst new file mode 100644 index 0000000000000000000000000000000000000000..6b865c68355c1b4a8cd4b0d94dbd617d7dd24fcb --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/group.rst @@ -0,0 +1,30 @@ +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + ImageUpload: + formEditor: + group: custom + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/groupSorting.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/groupSorting.rst new file mode 100644 index 0000000000000000000000000000000000000000..7db474731157cc58115e18312dc2a92aefa3fd1c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/groupSorting.rst @@ -0,0 +1,29 @@ +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + ImageUpload: + formEditor: + groupSorting: 400 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..bf08c5e7381144df752e6041165cbeae0a3b1bff --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + ImageUpload: + formEditor: + iconIdentifier: t3-form-icon-image-upload + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..03d0611e8dbf18bfc807ae1960facadc0366eed9 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/label.rst @@ -0,0 +1,29 @@ +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + ImageUpload: + formEditor: + label: formEditor.elements.ImageUpload.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..e2dda4f9d7e60d52a315c651c56a52a7c6a05f69 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/formEditor/predefinedDefaults.rst @@ -0,0 +1,33 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + ImageUpload: + formEditor: + predefinedDefaults: + properties: + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - image/jpeg + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..a0d7dc55c613f2ae1cdaac6211ceb8c8a61f4b5b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + ImageUpload: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\FileUpload + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/allowedMimeTypes.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/allowedMimeTypes.rst new file mode 100644 index 0000000000000000000000000000000000000000..d30b0369f820be50db76a79390aeb22aad28459c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/allowedMimeTypes.rst @@ -0,0 +1,45 @@ +properties.allowedMimeTypes +--------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.properties.allowedMimeTypes + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + Yes + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 7-10 + + ImageUpload: + properties: + containerClassAttribute: input + elementClassAttribute: lightbox + elementErrorClassAttribute: error + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - image/jpeg + - image/png + - image/bmp + imageLinkMaxWidth: 500 + imageMaxWidth: 500 + imageMaxHeight: 500 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The allowed mime types for the image uploads. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/containerClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/containerClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..0e25051f1ab1d015b88bf78e7b628b05dd626c58 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/containerClassAttribute.rst @@ -0,0 +1,45 @@ +properties.containerClassAttribute +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.properties.containerClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + ImageUpload: + properties: + containerClassAttribute: input + elementClassAttribute: lightbox + elementErrorClassAttribute: error + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - image/jpeg + - image/png + - image/bmp + imageLinkMaxWidth: 500 + imageMaxWidth: 500 + imageMaxHeight: 500 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is typically wrapped around the form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/elementClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/elementClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..18003be84d8f58d58dd71de76a1c24c50fcb1f13 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/elementClassAttribute.rst @@ -0,0 +1,45 @@ +properties.elementClassAttribute +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.properties.elementClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + ImageUpload: + properties: + containerClassAttribute: input + elementClassAttribute: lightbox + elementErrorClassAttribute: error + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - image/jpeg + - image/png + - image/bmp + imageLinkMaxWidth: 500 + imageMaxWidth: 500 + imageMaxHeight: 500 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class written to the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/elementErrorClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/elementErrorClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..d7ec00abf0aa5aff5f984fc0fc08b968bf35575d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/elementErrorClassAttribute.rst @@ -0,0 +1,45 @@ +properties.elementErrorClassAttribute +------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.properties.elementErrorClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + ImageUpload: + properties: + containerClassAttribute: input + elementClassAttribute: lightbox + elementErrorClassAttribute: error + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - image/jpeg + - image/png + - image/bmp + imageLinkMaxWidth: 500 + imageMaxWidth: 500 + imageMaxHeight: 500 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is written to the form element if validation errors exists. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/imageLinkMaxWidth.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/imageLinkMaxWidth.rst new file mode 100644 index 0000000000000000000000000000000000000000..642b7cbc66b2f4c6aaf04639f912e4b9765d744d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/imageLinkMaxWidth.rst @@ -0,0 +1,45 @@ +properties.imageLinkMaxWidth +---------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.properties.imageLinkMaxWidth + +:aspect:`Data type` + int + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 11 + + ImageUpload: + properties: + containerClassAttribute: input + elementClassAttribute: lightbox + elementErrorClassAttribute: error + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - image/jpeg + - image/png + - image/bmp + imageLinkMaxWidth: 500 + imageMaxWidth: 500 + imageMaxHeight: 500 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The max width for the uploaded image preview link. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/imageMaxHeight.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/imageMaxHeight.rst new file mode 100644 index 0000000000000000000000000000000000000000..f744dbb05d7a6f20aa32a61f41ae6582501c6ee1 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/imageMaxHeight.rst @@ -0,0 +1,45 @@ +properties.imageMaxHeight +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.properties.imageMaxHeight + +:aspect:`Data type` + int + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 13 + + ImageUpload: + properties: + containerClassAttribute: input + elementClassAttribute: lightbox + elementErrorClassAttribute: error + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - image/jpeg + - image/png + - image/bmp + imageLinkMaxWidth: 500 + imageMaxWidth: 500 + imageMaxHeight: 500 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The max height for the uploaded image preview. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/imageMaxWidth.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/imageMaxWidth.rst new file mode 100644 index 0000000000000000000000000000000000000000..0ebe1049d26e2f57b38c9f054efc36c842c0edf7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/imageMaxWidth.rst @@ -0,0 +1,45 @@ +properties.imageMaxWidth +------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.properties.imageMaxWidth + +:aspect:`Data type` + int + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 12 + + ImageUpload: + properties: + containerClassAttribute: input + elementClassAttribute: lightbox + elementErrorClassAttribute: error + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - image/jpeg + - image/png + - image/bmp + imageLinkMaxWidth: 500 + imageMaxWidth: 500 + imageMaxHeight: 500 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The max width for the uploaded image preview. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/saveToFileMount.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/saveToFileMount.rst new file mode 100644 index 0000000000000000000000000000000000000000..b8872fe21264569545ec16ad7a41327835c10217 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/ImageUpload/properties/saveToFileMount.rst @@ -0,0 +1,49 @@ +properties.saveToFileMount +-------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.ImageUpload.properties.saveToFileMount + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + Yes + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + ImageUpload: + properties: + containerClassAttribute: input + elementClassAttribute: lightbox + elementErrorClassAttribute: error + saveToFileMount: '1:/user_upload/' + allowedMimeTypes: + - image/jpeg + - image/png + - image/bmp + imageLinkMaxWidth: 500 + imageMaxWidth: 500 + imageMaxHeight: 500 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The location (file mount) for the uploaded images. + If this file mount or the property "saveToFileMount" does not exist + the folder in which the form definition lies (persistence identifier) will be used. + If the form is generated programmatically and therefore no persistence identifier exist + the default storage "1:/user_upload/" will be used. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox.rst new file mode 100644 index 0000000000000000000000000000000000000000..0423b72ead531766638c77e147fc02789a8bb32c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox.rst @@ -0,0 +1,82 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.multicheckbox: + +=============== +[MultiCheckbox] +=============== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.multicheckbox-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.implementationclassname: +.. include:: MultiCheckbox/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.properties.containerclassattribute: +.. include:: MultiCheckbox/properties/containerClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.properties.elementclassattribute: +.. include:: MultiCheckbox/properties/elementClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.properties.elementerrorclassattribute: +.. include:: MultiCheckbox/properties/elementErrorClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor: +.. include:: MultiCheckbox/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.editors.100: +.. include:: MultiCheckbox/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.editors.200: +.. include:: MultiCheckbox/formEditor/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.editors.300: +.. include:: MultiCheckbox/formEditor/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.editors.700: +.. include:: MultiCheckbox/formEditor/editors/700.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.editors.800: +.. include:: MultiCheckbox/formEditor/editors/800.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.editors.900: +.. include:: MultiCheckbox/formEditor/editors/900.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.editors.9999: +.. include:: MultiCheckbox/formEditor/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.predefineddefaults: +.. include:: MultiCheckbox/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.propertycollections.validators.10: +.. include:: MultiCheckbox/formEditor/propertyCollections/validators/10.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.propertycollections.validators.10.identifier: +.. include:: MultiCheckbox/formEditor/propertyCollections/validators/10/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.propertycollections.validators.10.editors.100: +.. include:: MultiCheckbox/formEditor/propertyCollections/validators/10/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.propertycollections.validators.10.editors.200: +.. include:: MultiCheckbox/formEditor/propertyCollections/validators/10/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.propertycollections.validators.10.editors.300: +.. include:: MultiCheckbox/formEditor/propertyCollections/validators/10/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.propertycollections.validators.10.editors.9999: +.. include:: MultiCheckbox/formEditor/propertyCollections/validators/10/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.label: +.. include:: MultiCheckbox/formEditor/label.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.group: +.. include:: MultiCheckbox/formEditor/group.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.groupsorting: +.. include:: MultiCheckbox/formEditor/groupSorting.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.iconidentifier: +.. include:: MultiCheckbox/formEditor/iconIdentifier.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..9b6aa92d2f557558f1594ae0eb9fa4cd727db52f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor.rst @@ -0,0 +1,121 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + MultiCheckbox: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 300: + identifier: options + templateName: Inspector-PropertyGridEditor + label: formEditor.elements.SelectionMixin.editor.options.label + propertyPath: properties.options + isSortable: true + enableAddRow: true + enableDeleteRow: true + removeLastAvailableRowFlashMessageTitle: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageTitle + removeLastAvailableRowFlashMessageMessage: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageMessage + shouldShowPreselectedValueColumn: multiple + multiSelection: true + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.MultiSelectionMixin.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.MultiSelectionMixin.editor.validators.EmptyValue.label + 20: + value: Count + label: formEditor.elements.MultiSelectionMixin.editor.validators.Count.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + properties: + options: { } + propertyCollections: + validators: + 10: + identifier: Count + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.MultiSelectionMixin.validators.Count.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + label: formEditor.elements.MultiCheckbox.label + group: select + groupSorting: 400 + iconIdentifier: t3-form-icon-multi-checkbox diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..da2bfb90b686e4890c89fe1314f2bcf501c3c1bc --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/100.rst @@ -0,0 +1,29 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + MultiCheckbox: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..56262086af40024e5a57d91809b7c98bdb408d53 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/200.rst @@ -0,0 +1,31 @@ +formEditor.editors.200 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + MultiCheckbox: + formEditor: + editors: + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..bab098f011123dd75e00b5e89544a2a324d17a94 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/300.rst @@ -0,0 +1,38 @@ +formEditor.editors.300 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.300 + +:aspect:`Data type` + array/ :ref:`[PropertyGridEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.propertygrideditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + MultiCheckbox: + formEditor: + editors: + 300: + identifier: options + templateName: Inspector-PropertyGridEditor + label: formEditor.elements.SelectionMixin.editor.options.label + propertyPath: properties.options + isSortable: true + enableAddRow: true + enableDeleteRow: true + removeLastAvailableRowFlashMessageTitle: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageTitle + removeLastAvailableRowFlashMessageMessage: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageMessage + shouldShowPreselectedValueColumn: multiple + multiSelection: true diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/700.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/700.rst new file mode 100644 index 0000000000000000000000000000000000000000..b704c70033d56e846faeba5304eab041d044fbb7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/700.rst @@ -0,0 +1,49 @@ +formEditor.editors.700 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.700 + +:aspect:`Data type` + array/ :ref:`[GridColumnViewPortConfigurationEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + MultiCheckbox: + formEditor: + editors: + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/800.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/800.rst new file mode 100644 index 0000000000000000000000000000000000000000..960a91ff5b6df736dea5cc914a08227fb938710a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/800.rst @@ -0,0 +1,35 @@ +formEditor.editors.800 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.800 + +:aspect:`Data type` + array/ :ref:`[RequiredValidatorEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + MultiCheckbox: + formEditor: + editors: + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/900.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/900.rst new file mode 100644 index 0000000000000000000000000000000000000000..abe1081bd548cd877ce628eae9e8c8424dcb61ac --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/900.rst @@ -0,0 +1,38 @@ +formEditor.editors.900 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.900 + +:aspect:`Data type` + array/ :ref:`[ValidatorsEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.validatorseditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + MultiCheckbox: + formEditor: + editors: + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.MultiSelectionMixin.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.MultiSelectionMixin.editor.validators.EmptyValue.label + 20: + value: Count + label: formEditor.elements.MultiSelectionMixin.editor.validators.Count.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..1f343d5928d4a357a5fa0dee6c8f14c1bad5a183 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/editors/9999.rst @@ -0,0 +1,30 @@ +formEditor.editors.9999 +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + MultiCheckbox: + formEditor: + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/group.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/group.rst new file mode 100644 index 0000000000000000000000000000000000000000..64d95a2733b2a3e777e8be122ef6c9a1969d93b5 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/group.rst @@ -0,0 +1,30 @@ +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + MultiCheckbox: + formEditor: + group: select + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/groupSorting.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/groupSorting.rst new file mode 100644 index 0000000000000000000000000000000000000000..2c624cc6c9b5316166ebbd228ded218e5848125c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/groupSorting.rst @@ -0,0 +1,29 @@ +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + MultiCheckbox: + formEditor: + groupSorting: 400 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..1f63ff2ed4f13e7c510a19de6cde4bc8df6d684b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + MultiCheckbox: + formEditor: + iconIdentifier: t3-form-icon-multi-checkbox + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..6d38aeecba61aaf71c06ab28857bfc4f4cf0d39e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/label.rst @@ -0,0 +1,29 @@ +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + MultiCheckbox: + formEditor: + label: formEditor.elements.MultiCheckbox.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..814a9673edbd2aa491e6ff639214b8237bb2500b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/predefinedDefaults.rst @@ -0,0 +1,31 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + MultiCheckbox: + formEditor: + predefinedDefaults: + properties: + options: { } + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/propertyCollections/validators/10.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/propertyCollections/validators/10.rst new file mode 100644 index 0000000000000000000000000000000000000000..fc3aab07b9719d95abda8b84a59ab16418a71206 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/propertyCollections/validators/10.rst @@ -0,0 +1,53 @@ +formEditor.propertyCollections.validators.10 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.propertyCollections.validators.10 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + MultiCheckbox: + formEditor: + propertyCollections: + validators: + 10: + identifier: Count + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.MultiSelectionMixin.validators.Count.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/propertyCollections/validators/10/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/propertyCollections/validators/10/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..29d5fa033f9bc802e30df3969a1a155c86127c36 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/propertyCollections/validators/10/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.10.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.propertyCollections.validators.10.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + MultiCheckbox: + formEditor: + propertyCollections: + validators: + 10: + identifier: Count + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.MultiSelectionMixin.validators.Count.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/propertyCollections/validators/10/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/propertyCollections/validators/10/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..171c1e51d53106551d7134f93b730a9fb987aa12 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/propertyCollections/validators/10/editors/200.rst @@ -0,0 +1,37 @@ +formEditor.propertyCollections.validators.10.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.propertyCollections.validators.10.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + MultiCheckbox: + formEditor: + propertyCollections: + validators: + 10: + identifier: Count + editors: + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/propertyCollections/validators/10/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/propertyCollections/validators/10/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..ee41c88ee2b40b5f7e8e4a82c6887a1bbe04ba56 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/propertyCollections/validators/10/editors/300.rst @@ -0,0 +1,37 @@ +formEditor.propertyCollections.validators.10.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.propertyCollections.validators.10.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + MultiCheckbox: + formEditor: + propertyCollections: + validators: + 10: + identifier: Count + editors: + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/propertyCollections/validators/10/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/propertyCollections/validators/10/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..c50fe2fa606ced21dc31c8f5c88e4abbf9b9d3f9 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/propertyCollections/validators/10/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.10.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.propertyCollections.validators.10.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + MultiCheckbox: + formEditor: + propertyCollections: + validators: + 10: + identifier: Count + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/propertyCollections/validators/10/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/propertyCollections/validators/10/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..67a015b45b45aa6e404f2b28906183953926c5d8 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/formEditor/propertyCollections/validators/10/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.10.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.propertyCollections.validators.10.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + MultiCheckbox: + formEditor: + propertyCollections: + validators: + 10: + identifier: Count + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..9b8145ab5104c3ebf5c2560738704e43093795b3 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + MultiCheckbox: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/properties/containerClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/properties/containerClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..8e70fb26aefca4eaf18d3d552ffc28b59efddcbe --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/properties/containerClassAttribute.rst @@ -0,0 +1,37 @@ +properties.containerClassAttribute +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.properties.containerClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + MultiCheckbox: + properties: + containerClassAttribute: 'input checkbox' + elementClassAttribute: '' + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is typically wrapped around the form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/properties/elementClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/properties/elementClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..e622696d0005b44abe01a5d16975fe08688fd192 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/properties/elementClassAttribute.rst @@ -0,0 +1,37 @@ +properties.elementClassAttribute +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.properties.elementClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + MultiCheckbox: + properties: + containerClassAttribute: 'input checkbox' + elementClassAttribute: '' + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class written to the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/properties/elementErrorClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/properties/elementErrorClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..aaf9a5e11ca450e09d1f6f1b1b1e9f26b270e6fc --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiCheckbox/properties/elementErrorClassAttribute.rst @@ -0,0 +1,37 @@ +properties.elementErrorClassAttribute +------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.properties.elementErrorClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + MultiCheckbox: + properties: + containerClassAttribute: 'input checkbox' + elementClassAttribute: '' + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is written to the form element if validation errors exists. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect.rst new file mode 100644 index 0000000000000000000000000000000000000000..b679457f8ba4a954021fb52c589be4e6b4105437 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect.rst @@ -0,0 +1,85 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.multiselect: + +============= +[MultiSelect] +============= + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.multiselect-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.implementationclassname: +.. include:: MultiSelect/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.properties.containerclassattribute: +.. include:: MultiSelect/properties/containerClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.properties.elementclassattribute: +.. include:: MultiSelect/properties/elementClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.properties.elementerrorclassattribute: +.. include:: MultiSelect/properties/elementErrorClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor: +.. include:: MultiSelect/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.editors.100: +.. include:: MultiSelect/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.editors.200: +.. include:: MultiSelect/formEditor/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.editors.250: +.. include:: MultiSelect/formEditor/editors/250.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.editors.300: +.. include:: MultiSelect/formEditor/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.editors.700: +.. include:: MultiSelect/formEditor/editors/700.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.editors.800: +.. include:: MultiSelect/formEditor/editors/800.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.editors.900: +.. include:: MultiSelect/formEditor/editors/900.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.editors.9999: +.. include:: MultiSelect/formEditor/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.predefineddefaults: +.. include:: MultiSelect/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.propertycollections.validators.10: +.. include:: MultiSelect/formEditor/propertyCollections/validators/10.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.propertycollections.validators.10.identifier: +.. include:: MultiSelect/formEditor/propertyCollections/validators/10/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.propertycollections.validators.10.editors.100: +.. include:: MultiSelect/formEditor/propertyCollections/validators/10/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.propertycollections.validators.10.editors.200: +.. include:: MultiSelect/formEditor/propertyCollections/validators/10/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.propertycollections.validators.10.editors.300: +.. include:: MultiSelect/formEditor/propertyCollections/validators/10/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.propertycollections.validators.10.editors.9999: +.. include:: MultiSelect/formEditor/propertyCollections/validators/10/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.label: +.. include:: MultiSelect/formEditor/label.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.group: +.. include:: MultiSelect/formEditor/group.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.groupsorting: +.. include:: MultiSelect/formEditor/groupSorting.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.iconidentifier: +.. include:: MultiSelect/formEditor/iconIdentifier.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..f82425f5e51b4c0117ba1a764daac892ed787588 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor.rst @@ -0,0 +1,130 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + MultiSelect: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 250: + identifier: inactiveOption + templateName: Inspector-TextEditor + label: formEditor.elements.SelectionMixin.editor.inactiveOption.label + propertyPath: properties.prependOptionLabel + fieldExplanationText: formEditor.elements.SelectionMixin.editor.inactiveOption.fieldExplanationText + doNotSetIfPropertyValueIsEmpty: true + 300: + identifier: options + templateName: Inspector-PropertyGridEditor + label: formEditor.elements.SelectionMixin.editor.options.label + propertyPath: properties.options + isSortable: true + enableAddRow: true + enableDeleteRow: true + removeLastAvailableRowFlashMessageTitle: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageTitle + removeLastAvailableRowFlashMessageMessage: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageMessage + shouldShowPreselectedValueColumn: multiple + multiSelection: true + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.MultiSelectionMixin.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.MultiSelectionMixin.editor.validators.EmptyValue.label + 20: + value: Count + label: formEditor.elements.MultiSelectionMixin.editor.validators.Count.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + properties: + options: { } + propertyCollections: + validators: + 10: + identifier: Count + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.MultiSelectionMixin.validators.Count.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + label: formEditor.elements.MultiSelect.label + group: select + groupSorting: 500 + iconIdentifier: t3-form-icon-multi-select diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..f11dc5ca6181367f71b5c947cddc2efb0d02a796 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/100.rst @@ -0,0 +1,29 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + MultiSelect: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..fb16e0c99971b78ddc9b7a3a48fca7b71a745e83 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/200.rst @@ -0,0 +1,31 @@ +formEditor.editors.200 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + MultiSelect: + formEditor: + editors: + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/250.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/250.rst new file mode 100644 index 0000000000000000000000000000000000000000..5e53c606e1a68ba8fed4adb08a45c47468dbbad7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/250.rst @@ -0,0 +1,33 @@ +formEditor.editors.250 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.editors.250 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + MultiSelect: + formEditor: + editors: + 250: + identifier: inactiveOption + templateName: Inspector-TextEditor + label: formEditor.elements.SelectionMixin.editor.inactiveOption.label + propertyPath: properties.prependOptionLabel + fieldExplanationText: formEditor.elements.SelectionMixin.editor.inactiveOption.fieldExplanationText + doNotSetIfPropertyValueIsEmpty: true diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..f201573989668dcd8e146f6501df239891536cb2 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/300.rst @@ -0,0 +1,38 @@ +formEditor.editors.300 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.editors.300 + +:aspect:`Data type` + array/ :ref:`[PropertyGridEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.propertygrideditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + MultiSelect: + formEditor: + editors: + 300: + identifier: options + templateName: Inspector-PropertyGridEditor + label: formEditor.elements.SelectionMixin.editor.options.label + propertyPath: properties.options + isSortable: true + enableAddRow: true + enableDeleteRow: true + removeLastAvailableRowFlashMessageTitle: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageTitle + removeLastAvailableRowFlashMessageMessage: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageMessage + shouldShowPreselectedValueColumn: multiple + multiSelection: true diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/700.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/700.rst new file mode 100644 index 0000000000000000000000000000000000000000..9858b1e76cb522218254094c642609aec113c1ba --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/700.rst @@ -0,0 +1,49 @@ +formEditor.editors.700 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.editors.700 + +:aspect:`Data type` + array/ :ref:`[GridColumnViewPortConfigurationEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + MultiSelect: + formEditor: + editors: + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/800.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/800.rst new file mode 100644 index 0000000000000000000000000000000000000000..e33121b0ca3ee70ef8667100343753107e80d352 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/800.rst @@ -0,0 +1,35 @@ +formEditor.editors.800 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.editors.800 + +:aspect:`Data type` + array/ :ref:`[RequiredValidatorEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + MultiSelect: + formEditor: + editors: + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/900.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/900.rst new file mode 100644 index 0000000000000000000000000000000000000000..ad23b36bf035d052f6ae5a708b6da51ef88eba71 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/900.rst @@ -0,0 +1,38 @@ +formEditor.editors.900 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.editors.900 + +:aspect:`Data type` + array/ :ref:`[ValidatorsEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.validatorseditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + MultiSelect: + formEditor: + editors: + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.MultiSelectionMixin.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.MultiSelectionMixin.editor.validators.EmptyValue.label + 20: + value: Count + label: formEditor.elements.MultiSelectionMixin.editor.validators.Count.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..2e57fceffe14d2bd7b9acb2abfdf735bbe764fc4 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/editors/9999.rst @@ -0,0 +1,30 @@ +formEditor.editors.9999 +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + MultiSelect: + formEditor: + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/group.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/group.rst new file mode 100644 index 0000000000000000000000000000000000000000..e08833c0a6f6e3664c6be889f4899edea2f3f9b9 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/group.rst @@ -0,0 +1,30 @@ +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + MultiSelect: + formEditor: + group: select + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/groupSorting.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/groupSorting.rst new file mode 100644 index 0000000000000000000000000000000000000000..0c3227b07c15a0aed4bb5c40c8f3005ca2602905 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/groupSorting.rst @@ -0,0 +1,29 @@ +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + MultiSelect: + formEditor: + groupSorting: 500 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..29a6a95361384614f6aaf03bc7ff23e00f23e716 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + MultiSelect: + formEditor: + iconIdentifier: t3-form-icon-multi-select + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..06d05b3f884b3e7d79b79179accd8153bd78f75f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/label.rst @@ -0,0 +1,29 @@ +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + MultiSelect: + formEditor: + label: formEditor.elements.MultiSelect.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..8f88129cffd17178038b429b07ae892a41b13e91 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/predefinedDefaults.rst @@ -0,0 +1,31 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + MultiSelect: + formEditor: + predefinedDefaults: + properties: + options: { } + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/propertyCollections/validators/10.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/propertyCollections/validators/10.rst new file mode 100644 index 0000000000000000000000000000000000000000..1c022d119ef7cf7cb703945730b3b7d084e75984 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/propertyCollections/validators/10.rst @@ -0,0 +1,53 @@ +formEditor.propertyCollections.validators.10 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.propertyCollections.validators.10 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + MultiSelect: + formEditor: + propertyCollections: + validators: + 10: + identifier: Count + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.MultiSelectionMixin.validators.Count.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/propertyCollections/validators/10/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/propertyCollections/validators/10/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..6d8f11637b7d2355c0b38e87b9649004a79d4040 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/propertyCollections/validators/10/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.10.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.propertyCollections.validators.10.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + MultiSelect: + formEditor: + propertyCollections: + validators: + 10: + identifier: Count + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.MultiSelectionMixin.validators.Count.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/propertyCollections/validators/10/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/propertyCollections/validators/10/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..a521c685628fe569f5562cb3f04771792d532509 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/propertyCollections/validators/10/editors/200.rst @@ -0,0 +1,37 @@ +formEditor.propertyCollections.validators.10.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.propertyCollections.validators.10.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + MultiSelect: + formEditor: + propertyCollections: + validators: + 10: + identifier: Count + editors: + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/propertyCollections/validators/10/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/propertyCollections/validators/10/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..6d71258946e791a93ebbdf00778581f4a6ae65d5 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/propertyCollections/validators/10/editors/300.rst @@ -0,0 +1,37 @@ +formEditor.propertyCollections.validators.10.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.propertyCollections.validators.10.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + MultiSelect: + formEditor: + propertyCollections: + validators: + 10: + identifier: Count + editors: + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/propertyCollections/validators/10/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/propertyCollections/validators/10/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..6a358ee83559ca9f062ea4d4ede8afbb33918cae --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/propertyCollections/validators/10/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.10.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.propertyCollections.validators.10.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + MultiSelect: + formEditor: + propertyCollections: + validators: + 10: + identifier: Count + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/propertyCollections/validators/10/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/propertyCollections/validators/10/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..698bf14e6d41caf623beb1517740424414d07e52 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/formEditor/propertyCollections/validators/10/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.10.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.propertyCollections.validators.10.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + MultiSelect: + formEditor: + propertyCollections: + validators: + 10: + identifier: Count + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..d7600add8fe9a90b06d247a30c65a5aa8b73d613 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + MultiSelect: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/properties/containerClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/properties/containerClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..8cdc7e25e487d71c39340e2e8741ef3c3e45eae6 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/properties/containerClassAttribute.rst @@ -0,0 +1,37 @@ +properties.containerClassAttribute +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.properties.containerClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + MultiSelect: + properties: + containerClassAttribute: input + elementClassAttribute: xlarge + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is typically wrapped around the form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/properties/elementClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/properties/elementClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..5a57c8c477c6dfba589716a0dd8052d00b274eb7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/properties/elementClassAttribute.rst @@ -0,0 +1,37 @@ +properties.elementClassAttribute +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.properties.elementClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + MultiSelect: + properties: + containerClassAttribute: input + elementClassAttribute: xlarge + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class written to the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/properties/elementErrorClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/properties/elementErrorClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..24cad799141c3e8b880fb28cd298b2a577fcaebe --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/properties/elementErrorClassAttribute.rst @@ -0,0 +1,37 @@ +properties.elementErrorClassAttribute +------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.properties.elementErrorClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + MultiSelect: + properties: + containerClassAttribute: input + elementClassAttribute: xlarge + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is written to the form element if validation errors exists. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page.rst new file mode 100644 index 0000000000000000000000000000000000000000..23b552594a3f82d4344cad9273c945b5c5545fa2 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page.rst @@ -0,0 +1,67 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.page: + +====== +[Page] +====== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.page-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.page.implementationclassname: +.. include:: Page/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.page.renderingoptions._iscompositeformelement: +.. include:: Page/renderingOptions/_isCompositeFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.page.renderingoptions._istoplevelformelement: +.. include:: Page/renderingOptions/_isTopLevelFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.page.renderingoptions.nextbuttonlabel: +.. include:: Page/renderingOptions/nextButtonLabel.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.page.renderingoptions.previousbuttonlabel: +.. include:: Page/renderingOptions/previousButtonLabel.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.page.formeditor: +.. include:: Page/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.page.formeditor.editors.100: +.. include:: Page/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.page.formeditor.editors.200: +.. include:: Page/formEditor/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.page.formeditor.editors.300: +.. include:: Page/formEditor/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.page.formeditor.editors.400: +.. include:: Page/formEditor/editors/400.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.page.formeditor.editors.9999: +.. include:: Page/formEditor/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.page.formeditor.predefineddefaults: +.. include:: Page/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.page.formeditor._iscompositeformelement: +.. include:: Page/formEditor/_isCompositeFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.page.formeditor._istoplevelformelement: +.. include:: Page/formEditor/_isTopLevelFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.page.formeditor.label: +.. include:: Page/formEditor/label.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.page.formeditor.group: +.. include:: Page/formEditor/group.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.page.formeditor.groupsorting: +.. include:: Page/formEditor/groupSorting.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.page.formeditor.iconidentifier: +.. include:: Page/formEditor/iconIdentifier.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..60952f9174cdbe42aaa447979dd3644ef4aedce8 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor.rst @@ -0,0 +1,54 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + Page: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.Page.editor.label.label + propertyPath: label + 300: + identifier: 'previousButtonLabel' + templateName: 'Inspector-TextEditor' + label: 'formEditor.elements.Page.editor.previousButtonLabel.label' + propertyPath: 'renderingOptions.previousButtonLabel' + 400: + identifier: 'nextButtonLabel' + templateName: 'Inspector-TextEditor' + label: 'formEditor.elements.Page.editor.nextButtonLabel.label' + propertyPath: 'renderingOptions.nextButtonLabel' + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + renderingOptions: + previousButtonLabel: 'formEditor.elements.Page.editor.previousButtonLabel.value' + nextButtonLabel: 'formEditor.elements.Page.editor.nextButtonLabel.value' + label: formEditor.elements.Page.label + group: page + groupSorting: 100 + _isTopLevelFormElement: true + _isCompositeFormElement: true + iconIdentifier: t3-form-icon-page diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/_isCompositeFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/_isCompositeFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..15b1b44d5cefd27ed0d67989e96d99ad7560e216 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/_isCompositeFormElement.rst @@ -0,0 +1,29 @@ +formEditor._isCompositeFormElement +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor._isCompositeFormElement + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Page: + formEditor: + _isCompositeFormElement: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting to define that the form element contains child form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/_isTopLevelFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/_isTopLevelFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..0493c0b7127b956b6e7bcee7bb9a83b76062a5c6 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/_isTopLevelFormElement.rst @@ -0,0 +1,29 @@ +formEditor._isTopLevelFormElement +--------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor._isTopLevelFormElement + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Page: + formEditor: + _isTopLevelFormElement: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting to define that the form element must not have a parent form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..92aa1a4d1f567734712b7d5b79161c7ab0e34573 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/editors/100.rst @@ -0,0 +1,29 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Page: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..777bd15e8cf6004f794a6bb19df8150969989646 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/editors/200.rst @@ -0,0 +1,31 @@ +formEditor.editors.200 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Page: + formEditor: + editors: + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.Page.editor.label.label + propertyPath: label diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..93ac441c53bb6f91b157b26c4fabdddef0454143 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/editors/300.rst @@ -0,0 +1,31 @@ +formEditor.editors.300 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.editors.300 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Form: + formEditor: + editors: + 300: + identifier: 'previousButtonLabel' + templateName: 'Inspector-TextEditor' + label: 'formEditor.elements.Page.editor.previousButtonLabel.label' + propertyPath: 'renderingOptions.previousButtonLabel' diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/editors/400.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/editors/400.rst new file mode 100644 index 0000000000000000000000000000000000000000..328aa918427df9e52e666cfa9e6720bf055e7e40 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/editors/400.rst @@ -0,0 +1,31 @@ +formEditor.editors.400 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.editors.400 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Form: + formEditor: + editors: + 400: + identifier: 'nextButtonLabel' + templateName: 'Inspector-TextEditor' + label: 'formEditor.elements.Page.editor.nextButtonLabel.label' + propertyPath: 'renderingOptions.nextButtonLabel' diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..652285d685a9ec43e6b8bbdd671a2404d906379e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/editors/9999.rst @@ -0,0 +1,30 @@ +formEditor.editors.9999 +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Page: + formEditor: + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/group.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/group.rst new file mode 100644 index 0000000000000000000000000000000000000000..0794db7a59fbfa5b25d8aa095c5afbbbf35d8700 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/group.rst @@ -0,0 +1,30 @@ +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Page: + formEditor: + group: page + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/groupSorting.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/groupSorting.rst new file mode 100644 index 0000000000000000000000000000000000000000..f9f921520fa5538f8588ba2a20212efd3f6bbe58 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/groupSorting.rst @@ -0,0 +1,29 @@ +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Page: + formEditor: + groupSorting: 100 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..5500553c0edc08e26618c1ef6a6bc0cf62b46a9a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Page: + formEditor: + iconIdentifier: t3-form-icon-page + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..c044e6f4462c91205df64c3485ff51b4982ebd75 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/label.rst @@ -0,0 +1,29 @@ +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Page: + formEditor: + label: formEditor.elements.Page.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..9cf59df3a8d6850b38ce7eb0ebbb5bf356853e60 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/formEditor/predefinedDefaults.rst @@ -0,0 +1,32 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Page: + formEditor: + predefinedDefaults: + renderingOptions: + previousButtonLabel: 'formEditor.elements.Page.editor.previousButtonLabel.value' + nextButtonLabel: 'formEditor.elements.Page.editor.nextButtonLabel.value' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..e844a533043ddbc3defc28ad5fbde51775b1bbda --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + Page: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\Page + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/renderingOptions/_isCompositeFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/renderingOptions/_isCompositeFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..04eb8e4579ede158b5cb465713f7f5c9676b7f35 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/renderingOptions/_isCompositeFormElement.rst @@ -0,0 +1,38 @@ +renderingOptions._isCompositeFormElement +---------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.renderingOptions._isCompositeFormElement + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Page: + renderingOptions: + _isTopLevelFormElement: true + _isCompositeFormElement: true + nextButtonLabel: 'next Page' + previousButtonLabel: 'previous Page' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting to define that the form element contains child form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/renderingOptions/_isTopLevelFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/renderingOptions/_isTopLevelFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..ace12e7b44906337837496f49699360bfb1c5ee2 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/renderingOptions/_isTopLevelFormElement.rst @@ -0,0 +1,38 @@ +renderingOptions._isTopLevelFormElement +--------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.renderingOptions._isTopLevelFormElement + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + Page: + renderingOptions: + _isTopLevelFormElement: true + _isCompositeFormElement: true + nextButtonLabel: 'next Page' + previousButtonLabel: 'previous Page' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting to define that the form element must not have a parent form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/renderingOptions/nextButtonLabel.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/renderingOptions/nextButtonLabel.rst new file mode 100644 index 0000000000000000000000000000000000000000..da8da66113c38c2901bce91b0538fb5cf238b13a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/renderingOptions/nextButtonLabel.rst @@ -0,0 +1,38 @@ +renderingOptions.nextButtonLabel +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.renderingOptions.nextButtonLabel + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + Yes + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + Page: + renderingOptions: + _isTopLevelFormElement: true + _isCompositeFormElement: false + nextButtonLabel: 'next Page' + previousButtonLabel: 'previous Page' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The label for the "next page" Button. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/renderingOptions/previousButtonLabel.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/renderingOptions/previousButtonLabel.rst new file mode 100644 index 0000000000000000000000000000000000000000..72d11eca26ee6b10c6c3a5381f91d02ddbaf86a3 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Page/renderingOptions/previousButtonLabel.rst @@ -0,0 +1,38 @@ +renderingOptions.previousButtonLabel +------------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.renderingOptions.previousButtonLabel + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + Yes + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Page: + renderingOptions: + _isTopLevelFormElement: true + _isCompositeFormElement: false + nextButtonLabel: 'next Page' + previousButtonLabel: 'previous Page' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The label for the "previous page" Button. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password.rst new file mode 100644 index 0000000000000000000000000000000000000000..a92e37050f5491aa151652a5a5619021d5beafb6 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password.rst @@ -0,0 +1,178 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.password: + +========== +[Password] +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.password-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.implementationclassname: +.. include:: Password/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.properties.containerclassattribute: +.. include:: Password/properties/containerClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.properties.elementclassattribute: +.. include:: Password/properties/elementClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.properties.elementerrorclassattribute: +.. include:: Password/properties/elementErrorClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor: +.. include:: Password/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.editors.100: +.. include:: Password/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.editors.200: +.. include:: Password/formEditor/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.editors.400: +.. include:: Password/formEditor/editors/400.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.editors.500: +.. include:: Password/formEditor/editors/500.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.editors.700: +.. include:: Password/formEditor/editors/700.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.editors.800: +.. include:: Password/formEditor/editors/800.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.editors.900: +.. include:: Password/formEditor/editors/900.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.editors.9999: +.. include:: Password/formEditor/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.predefineddefaults: +.. include:: Password/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.10: +.. include:: Password/formEditor/propertyCollections/validators/10.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.10.identifier: +.. include:: Password/formEditor/propertyCollections/validators/10/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.10.editors.100: +.. include:: Password/formEditor/propertyCollections/validators/10/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.10.editors.9999: +.. include:: Password/formEditor/propertyCollections/validators/10/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.20: +.. include:: Password/formEditor/propertyCollections/validators/20.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.20.identifier: +.. include:: Password/formEditor/propertyCollections/validators/20/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.20.editors.100: +.. include:: Password/formEditor/propertyCollections/validators/20/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.20.editors.9999: +.. include:: Password/formEditor/propertyCollections/validators/20/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.30: +.. include:: Password/formEditor/propertyCollections/validators/30.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.30.identifier: +.. include:: Password/formEditor/propertyCollections/validators/30/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.30.editors.100: +.. include:: Password/formEditor/propertyCollections/validators/30/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.30.editors.200: +.. include:: Password/formEditor/propertyCollections/validators/30/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.30.editors.300: +.. include:: Password/formEditor/propertyCollections/validators/30/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.30.editors.9999: +.. include:: Password/formEditor/propertyCollections/validators/30/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.40: +.. include:: Password/formEditor/propertyCollections/validators/40.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.40.identifier: +.. include:: Password/formEditor/propertyCollections/validators/40/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.40.editors.100: +.. include:: Password/formEditor/propertyCollections/validators/40/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.40.editors.9999: +.. include:: Password/formEditor/propertyCollections/validators/40/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.50: +.. include:: Password/formEditor/propertyCollections/validators/50.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.50.identifier: +.. include:: Password/formEditor/propertyCollections/validators/50/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.50.editors.100: +.. include:: Password/formEditor/propertyCollections/validators/50/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.50.editors.9999: +.. include:: Password/formEditor/propertyCollections/validators/50/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.60: +.. include:: Password/formEditor/propertyCollections/validators/60.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.60.identifier: +.. include:: Password/formEditor/propertyCollections/validators/60/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.60.editors.100: +.. include:: Password/formEditor/propertyCollections/validators/60/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.60.editors.9999: +.. include:: Password/formEditor/propertyCollections/validators/60/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.70: +.. include:: Password/formEditor/propertyCollections/validators/70.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.70.identifier: +.. include:: Password/formEditor/propertyCollections/validators/70/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.70.editors.100: +.. include:: Password/formEditor/propertyCollections/validators/70/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.70.editors.200: +.. include:: Password/formEditor/propertyCollections/validators/70/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.70.editors.300: +.. include:: Password/formEditor/propertyCollections/validators/70/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.70.editors.9999: +.. include:: Password/formEditor/propertyCollections/validators/70/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.80: +.. include:: Password/formEditor/propertyCollections/validators/80.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.80.identifier: +.. include:: Password/formEditor/propertyCollections/validators/80/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.80.editors.100: +.. include:: Password/formEditor/propertyCollections/validators/80/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.80.editors.200: +.. include:: Password/formEditor/propertyCollections/validators/80/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.propertycollections.validators.80.editors.9999: +.. include:: Password/formEditor/propertyCollections/validators/80/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.label: +.. include:: Password/formEditor/label.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.group: +.. include:: Password/formEditor/group.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.groupsorting: +.. include:: Password/formEditor/groupSorting.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.password.formeditor.iconidentifier: +.. include:: Password/formEditor/iconIdentifier.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..d4165e38da7704b1f69705c459f57f1c4737132c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor.rst @@ -0,0 +1,243 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + Password: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 400: + identifier: placeholder + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.placeholder.label + propertyPath: properties.fluidAdditionalAttributes.placeholder + compatibilityPropertyPath: properties.placeholder + doNotSetIfPropertyValueIsEmpty: true + 500: + identifier: defaultValue + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.defaultValue.label + propertyPath: defaultValue + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.TextMixin.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.TextMixin.editor.validators.EmptyValue.label + 20: + value: Alphanumeric + label: formEditor.elements.TextMixin.editor.validators.Alphanumeric.label + 30: + value: Text + label: formEditor.elements.TextMixin.editor.validators.Text.label + 40: + value: StringLength + label: formEditor.elements.TextMixin.editor.validators.StringLength.label + 50: + value: EmailAddress + label: formEditor.elements.TextMixin.editor.validators.EmailAddress.label + 60: + value: Integer + label: formEditor.elements.TextMixin.editor.validators.Integer.label + 70: + value: Float + label: formEditor.elements.TextMixin.editor.validators.Float.label + 80: + value: NumberRange + label: formEditor.elements.TextMixin.editor.validators.NumberRange.label + 90: + value: RegularExpression + label: formEditor.elements.TextMixin.editor.validators.RegularExpression.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + defaultValue: '' + propertyCollections: + validators: + 10: + identifier: Alphanumeric + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Alphanumeric.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 20: + identifier: Text + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Text.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 30: + identifier: StringLength + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.StringLength.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.minlength + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.maxlength + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 40: + identifier: EmailAddress + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.EmailAddress.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 50: + identifier: Integer + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Integer.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 60: + identifier: Float + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Float.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 70: + identifier: NumberRange + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.NumberRange.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 80: + identifier: RegularExpression + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.header.label + 200: + identifier: regex + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.label + fieldExplanationText: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.fieldExplanationText + propertyPath: options.regularExpression + propertyValidators: + 10: NotEmpty + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + label: formEditor.elements.Password.label + group: input + groupSorting: 300 + iconIdentifier: t3-form-icon-password \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..a0209be03b252d32cce6deefa64b3f0f5b867bf1 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/100.rst @@ -0,0 +1,29 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Password: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..e2d4cb285658e9bc39e7cbb690b0a3dc5fe84be0 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/200.rst @@ -0,0 +1,32 @@ +formEditor.editors.200 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Password: + formEditor: + editors: + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/400.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/400.rst new file mode 100644 index 0000000000000000000000000000000000000000..12ca70405e63ce5d9515a130e5f94d982b18df56 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/400.rst @@ -0,0 +1,35 @@ +formEditor.editors.400 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.editors.400 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Password: + formEditor: + editors: + 400: + identifier: placeholder + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.placeholder.label + propertyPath: properties.fluidAdditionalAttributes.placeholder + compatibilityPropertyPath: properties.placeholder + doNotSetIfPropertyValueIsEmpty: true + + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/500.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/500.rst new file mode 100644 index 0000000000000000000000000000000000000000..97dc5c949e5bb8f70cfedf8acb1e1dc15926197e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/500.rst @@ -0,0 +1,32 @@ +formEditor.editors.400 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.editors.400 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Password: + formEditor: + editors: + 500: + identifier: defaultValue + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.defaultValue.label + propertyPath: defaultValue + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/700.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/700.rst new file mode 100644 index 0000000000000000000000000000000000000000..92c7e2790e3bbbdd2c7f69528de057499609b129 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/700.rst @@ -0,0 +1,49 @@ +formEditor.editors.700 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.editors.700 + +:aspect:`Data type` + array/ :ref:`[GridColumnViewPortConfigurationEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Password: + formEditor: + editors: + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/800.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/800.rst new file mode 100644 index 0000000000000000000000000000000000000000..0988b976957a96107e2c412dd46d2af3e0f1e791 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/800.rst @@ -0,0 +1,35 @@ +formEditor.editors.800 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.editors.800 + +:aspect:`Data type` + array/ :ref:`[RequiredValidatorEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Password: + formEditor: + editors: + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/900.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/900.rst new file mode 100644 index 0000000000000000000000000000000000000000..75cd9ae6878b0996e62ba9e5b31c6288f1399523 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/900.rst @@ -0,0 +1,59 @@ +formEditor.editors.900 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.editors.900 + +:aspect:`Data type` + array/ :ref:`[ValidatorsEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.validatorseditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Password: + formEditor: + editors: + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.TextMixin.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.TextMixin.editor.validators.EmptyValue.label + 20: + value: Alphanumeric + label: formEditor.elements.TextMixin.editor.validators.Alphanumeric.label + 30: + value: Text + label: formEditor.elements.TextMixin.editor.validators.Text.label + 40: + value: StringLength + label: formEditor.elements.TextMixin.editor.validators.StringLength.label + 50: + value: EmailAddress + label: formEditor.elements.TextMixin.editor.validators.EmailAddress.label + 60: + value: Integer + label: formEditor.elements.TextMixin.editor.validators.Integer.label + 70: + value: Float + label: formEditor.elements.TextMixin.editor.validators.Float.label + 80: + value: NumberRange + label: formEditor.elements.TextMixin.editor.validators.NumberRange.label + 90: + value: RegularExpression + label: formEditor.elements.TextMixin.editor.validators.RegularExpression.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..4008dbc1d8acaa8fa201e5a9812636899620db35 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/editors/9999.rst @@ -0,0 +1,30 @@ +formEditor.editors.9999 +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Password: + formEditor: + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/group.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/group.rst new file mode 100644 index 0000000000000000000000000000000000000000..bdad919d31adef1f6bce7c7a5186aac2a5cc1a02 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/group.rst @@ -0,0 +1,30 @@ +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Password: + formEditor: + group: input + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/groupSorting.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/groupSorting.rst new file mode 100644 index 0000000000000000000000000000000000000000..576e3b46ab179acfc23b27af95394d0007c224a7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/groupSorting.rst @@ -0,0 +1,29 @@ +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Password: + formEditor: + groupSorting: 300 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..d31a78927b0350749b8638a51df2565f639f6167 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Password: + formEditor: + iconIdentifier: t3-form-icon-password + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..a71e8ca9427e4c17d3f31c585ea02dd0815f8f43 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/label.rst @@ -0,0 +1,29 @@ +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Password: + formEditor: + label: formEditor.elements.Password.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..7ed824291eec89abb0f04fda396dd01342e21c31 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/predefinedDefaults.rst @@ -0,0 +1,30 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Password: + formEditor: + predefinedDefaults: + defaultValue: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/10.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/10.rst new file mode 100644 index 0000000000000000000000000000000000000000..aa2b355ee2fae6c9c6314f0e969616f422ba017c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/10.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.10 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.10 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Password: + formEditor: + propertyCollections: + validators: + 10: + identifier: Alphanumeric + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Alphanumeric.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/10/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/10/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..1f3f27c6cc0c1d31eb08f4f9cb8ff9219c4e286a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/10/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.10.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.10.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 10: + identifier: Alphanumeric + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Alphanumeric.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/10/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/10/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..6c67e11de6da34cc0024155e4c8465d7fdeadd19 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/10/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.10.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.10.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 10: + identifier: Alphanumeric + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/10/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/10/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..874f7c66cfc7f8558562a0e9a2ae6f9b075be108 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/10/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.10.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.10.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Password: + formEditor: + propertyCollections: + validators: + 10: + identifier: Alphanumeric + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/20.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/20.rst new file mode 100644 index 0000000000000000000000000000000000000000..00a05a6a5d42b12c202302527abbdb63f7d0993d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/20.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.20 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.20 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Password: + formEditor: + propertyCollections: + validators: + 20: + identifier: Text + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Text.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/20/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/20/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..758d6f3fdd2d67070c2f02a8a6bd01cbacc181b6 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/20/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.20.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.20.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 20: + identifier: Text + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Text.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/20/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/20/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..012aa7fafd6f44eac9e7170def152f88d0d04762 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/20/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.20.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.20.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 20: + identifier: Text + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/20/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/20/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..eed392b29a7f2acd60f670a7860f7307ee57ef4b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/20/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.20.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.20.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Password: + formEditor: + propertyCollections: + validators: + 20: + identifier: Text + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/30.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/30.rst new file mode 100644 index 0000000000000000000000000000000000000000..3559fc445120917358fc604c448cad79968b8d78 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/30.rst @@ -0,0 +1,57 @@ +formEditor.propertyCollections.validators.30 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.30 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Password: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.StringLength.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.minlength + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.maxlength + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/30/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/30/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..095938de59dd65645b6a1a2f2a001c2a281cf052 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/30/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.30.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.30.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.StringLength.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/30/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/30/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..f547a97e7df2f30422b6bb45d3848d26a25c7ba4 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/30/editors/200.rst @@ -0,0 +1,39 @@ +formEditor.propertyCollections.validators.30.editors.200 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.30.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + editors: + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.minlength + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/30/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/30/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..9c0555c199f67f9a3ad67cadba6e3bd4a4500c3f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/30/editors/300.rst @@ -0,0 +1,39 @@ +formEditor.propertyCollections.validators.30.editors.300 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.30.editors.300 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + editors: + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.maxlength + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/30/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/30/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..b5a9bcc53923275cc1669a456c4c071ebb4e0ec7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/30/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.30.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.30.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/30/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/30/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..58209b7e49eb5a92c5a77d62a8d65a795c82295c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/30/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.30.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.30.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Password: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/40.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/40.rst new file mode 100644 index 0000000000000000000000000000000000000000..585b3337b10a3f0c1b66896c4ff5575db93923fa --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/40.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.40 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.40 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Password: + formEditor: + propertyCollections: + validators: + 40: + identifier: EmailAddress + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.EmailAddress.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/40/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/40/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..cdbd2a3ce571739bc414bb00c56853046537c7d0 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/40/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.40.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.40.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 40: + identifier: EmailAddress + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.EmailAddress.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/40/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/40/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..9029ecac7e2eccdee1505ecf7e4c08a86bd28e30 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/40/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.40.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.40.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 40: + identifier: EmailAddress + editors: + 100: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/40/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/40/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..17a851b6d12580f3aaf4085f4a729e7fe2e8f4dd --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/40/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.40.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.40.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Password: + formEditor: + propertyCollections: + validators: + 40: + identifier: EmailAddress + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/50.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/50.rst new file mode 100644 index 0000000000000000000000000000000000000000..69fab0802d0a2737fa704806897049e2ab33b5cc --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/50.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.50 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.50 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Password: + formEditor: + propertyCollections: + validators: + 50: + identifier: Integer + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Integer.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/50/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/50/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..d02e9a6b48b331e511e2908c54c5c08e16c1b37b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/50/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.50.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.50.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 50: + identifier: Integer + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Integer.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/50/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/50/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..75486bff795ddd6383a474fc22b14e099ba48e46 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/50/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.50.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.50.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 50: + identifier: Integer + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/50/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/50/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..9b53663e9632aba4b5e2843dc084955a4dba61c2 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/50/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.50.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.50.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Password: + formEditor: + propertyCollections: + validators: + 50: + identifier: Integer + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/60.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/60.rst new file mode 100644 index 0000000000000000000000000000000000000000..2a02e0337e3a78d29450b78443e0ea5ec2315c2e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/60.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.60 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.60 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Password: + formEditor: + propertyCollections: + validators: + 60: + identifier: Float + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Float.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/60/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/60/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..41e450e0f2ccde6b9bd360c647a7e7a911c6158c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/60/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.60.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.60.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 60: + identifier: Float + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Float.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/60/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/60/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..2faec5682a866b40c34df6d5f4cfc96f88b50f65 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/60/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.60.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.60.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 60: + identifier: Float + editors: + 100: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/60/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/60/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..93046eae102c3be109dad7eb06abb9eee6f26012 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/60/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.60.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.60.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Password: + formEditor: + propertyCollections: + validators: + 60: + identifier: Float + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/70.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/70.rst new file mode 100644 index 0000000000000000000000000000000000000000..658bb12280beebb89a9222470aeee06642085adb --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/70.rst @@ -0,0 +1,53 @@ +formEditor.propertyCollections.validators.70 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.70 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Password: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.NumberRange.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/70/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/70/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..99edc59076cfe3679446a1a72a245cf69913e2ac --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/70/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.70.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.70.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.NumberRange.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/70/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/70/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..19cb8eb411f4e39732cdca63ccc9e01a30e358e7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/70/editors/200.rst @@ -0,0 +1,37 @@ +formEditor.propertyCollections.validators.70.editors.200 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.70.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + editors: + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/70/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/70/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..205dfea8ef8e3f1e167e77de967938192c7be891 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/70/editors/300.rst @@ -0,0 +1,36 @@ +formEditor.propertyCollections.validators.70.editors.300 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.70.editors.300 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + editors: + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/70/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/70/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..a5daada27e55c9743f5fe50bc0794402ef57c578 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/70/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.70.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.70.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/70/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/70/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..2a7c90e37834130b65f7ace384ed0a86373ea4c7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/70/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.70.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.70.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Password: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/80.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/80.rst new file mode 100644 index 0000000000000000000000000000000000000000..fbd027619427ac7e8032e6c4be9a2b54868b74be --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/80.rst @@ -0,0 +1,43 @@ +formEditor.propertyCollections.validators.80 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.80 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Password: + formEditor: + propertyCollections: + validators: + 80: + identifier: RegularExpression + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.header.label + 200: + identifier: regex + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.label + fieldExplanationText: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.fieldExplanationText + propertyPath: options.regularExpression + propertyValidators: + 10: NotEmpty + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/80/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/80/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..c400e9cf8f8e0575a2b621e17a152b67ed26f93a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/80/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.80.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.80.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 80: + identifier: RegularExpression + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/80/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/80/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..1d04f6a9df6d3fdd4756589c63465fb19fd9ac37 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/80/editors/200.rst @@ -0,0 +1,36 @@ +formEditor.propertyCollections.validators.80.editors.200 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.80.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 80: + identifier: RegularExpression + editors: + 200: + identifier: regex + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.label + fieldExplanationText: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.fieldExplanationText + propertyPath: options.regularExpression + propertyValidators: + 10: NotEmpty + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/80/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/80/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..fadf37c07e9b09a84ffeb85dbd57e384bf336ea1 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/80/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.80.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.80.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Password: + formEditor: + propertyCollections: + validators: + 80: + identifier: RegularExpression + editors: + 100: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/80/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/80/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..d573eaa4b2124f3abae2ea5df0662cada4bf9733 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/formEditor/propertyCollections/validators/80/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.80.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.formEditor.propertyCollections.validators.80.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Password: + formEditor: + propertyCollections: + validators: + 80: + identifier: RegularExpression + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..5d990d7e42f526937a2db2ac7cb40552e8b90de4 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + Password: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/properties/containerClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/properties/containerClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..bb76c4184c265c351b75a5824122dfc38f384805 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/properties/containerClassAttribute.rst @@ -0,0 +1,37 @@ +properties.containerClassAttribute +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.properties.containerClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Password: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is typically wrapped around the form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/properties/elementClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/properties/elementClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..88c36eafaf08822563ad452d0aa1ae458a952f6e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/properties/elementClassAttribute.rst @@ -0,0 +1,37 @@ +properties.elementClassAttribute +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.properties.elementClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + Password: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class written to the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/properties/elementErrorClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/properties/elementErrorClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..695e5ab1794611d4f614d9d3f3578e5d9a6080a4 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Password/properties/elementErrorClassAttribute.rst @@ -0,0 +1,37 @@ +properties.elementErrorClassAttribute +------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Password.properties.elementErrorClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + Password: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is written to the form element if validation errors exists. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton.rst new file mode 100644 index 0000000000000000000000000000000000000000..86cd43609c3dbe050b8c2db1a80d47fae0167eff --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton.rst @@ -0,0 +1,61 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.radiobutton: + +============= +[RadioButton] +============= + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.radiobutton-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.radiobutton.implementationclassname: +.. include:: RadioButton/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.radiobutton.properties.containerclassattribute: +.. include:: RadioButton/properties/containerClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.radiobutton.properties.elementclassattribute: +.. include:: RadioButton/properties/elementClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.radiobutton.properties.elementerrorclassattribute: +.. include:: RadioButton/properties/elementErrorClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.radiobutton.formeditor: +.. include:: RadioButton/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.radiobutton.formeditor.editors.100: +.. include:: RadioButton/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.radiobutton.formeditor.editors.200: +.. include:: RadioButton/formEditor/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.radiobutton.formeditor.editors.300: +.. include:: RadioButton/formEditor/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.radiobutton.formeditor.editors.700: +.. include:: RadioButton/formEditor/editors/700.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.radiobutton.formeditor.editors.800: +.. include:: RadioButton/formEditor/editors/800.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.radiobutton.formeditor.editors.9999: +.. include:: RadioButton/formEditor/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.radiobutton.formeditor.predefineddefaults: +.. include:: RadioButton/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.radiobutton.formeditor.label: +.. include:: RadioButton/formEditor/label.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.radiobutton.formeditor.group: +.. include:: RadioButton/formEditor/group.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.radiobutton.formeditor.groupsorting: +.. include:: RadioButton/formEditor/groupSorting.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.radiobutton.formeditor.iconidentifier: +.. include:: RadioButton/formEditor/iconIdentifier.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..bf2b8b5d7c43ad70a62cff43656e1eda3c5a7bc0 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor.rst @@ -0,0 +1,82 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.RadioButton.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + RadioButton: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 300: + identifier: options + templateName: Inspector-PropertyGridEditor + label: formEditor.elements.SelectionMixin.editor.options.label + propertyPath: properties.options + isSortable: true + enableAddRow: true + enableDeleteRow: true + removeLastAvailableRowFlashMessageTitle: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageTitle + removeLastAvailableRowFlashMessageMessage: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageMessage + shouldShowPreselectedValueColumn: single + multiSelection: false + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + properties: + options: { } + label: formEditor.elements.RadioButton.label + group: select + groupSorting: 300 + iconIdentifier: t3-form-icon-radio-button diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..4809c2fb09127561b52221911969d80e46abf9a6 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/editors/100.rst @@ -0,0 +1,29 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.RadioButton.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + RadioButton: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..ec440f51cb43f7338ee50b6245c2ec7ed3f8dc0c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/editors/200.rst @@ -0,0 +1,31 @@ +formEditor.editors.200 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.RadioButton.formEditor.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + RadioButton: + formEditor: + editors: + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..ac26f6756b490284d8b190bde4026f098592eaec --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/editors/300.rst @@ -0,0 +1,38 @@ +formEditor.editors.300 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.RadioButton.formEditor.editors.300 + +:aspect:`Data type` + array/ :ref:`[PropertyGridEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.propertygrideditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + RadioButton: + formEditor: + editors: + 300: + identifier: options + templateName: Inspector-PropertyGridEditor + label: formEditor.elements.SelectionMixin.editor.options.label + propertyPath: properties.options + isSortable: true + enableAddRow: true + enableDeleteRow: true + removeLastAvailableRowFlashMessageTitle: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageTitle + removeLastAvailableRowFlashMessageMessage: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageMessage + shouldShowPreselectedValueColumn: single + multiSelection: false diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/editors/700.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/editors/700.rst new file mode 100644 index 0000000000000000000000000000000000000000..96ccbea8c05b437555aac88afacdad9b0905b91d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/editors/700.rst @@ -0,0 +1,49 @@ +formEditor.editors.700 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.RadioButton.formEditor.editors.700 + +:aspect:`Data type` + array/ :ref:`[GridColumnViewPortConfigurationEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + RadioButton: + formEditor: + editors: + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/editors/800.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/editors/800.rst new file mode 100644 index 0000000000000000000000000000000000000000..f8b1b9ed2a54d34df8782000c35a5d1d734dfae1 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/editors/800.rst @@ -0,0 +1,35 @@ +formEditor.editors.800 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.RadioButton.formEditor.editors.800 + +:aspect:`Data type` + array/ :ref:`[RequiredValidatorEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + RadioButton: + formEditor: + editors: + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..c47bc249089e2e60a38d3ebec458fbf9dade742f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/editors/9999.rst @@ -0,0 +1,30 @@ +formEditor.editors.9999 +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.RadioButton.formEditor.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + RadioButton: + formEditor: + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/group.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/group.rst new file mode 100644 index 0000000000000000000000000000000000000000..ea3903ab76a178e9a59f290bd909e4f6db186ca6 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/group.rst @@ -0,0 +1,30 @@ +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.RadioButton.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + RadioButton: + formEditor: + group: select + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/groupSorting.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/groupSorting.rst new file mode 100644 index 0000000000000000000000000000000000000000..0e99ab9fcd6ccc55ea723c7f1b96a805081ea356 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/groupSorting.rst @@ -0,0 +1,29 @@ +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.RadioButton.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + RadioButton: + formEditor: + groupSorting: 300 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..e007a42def067de07d1c8df42c739555c4ffa4c4 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.RadioButton.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + RadioButton: + formEditor: + iconIdentifier: t3-form-icon-radio-button + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..10f09be3b2befbd679053f0b6c61fe09ca498d9f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/label.rst @@ -0,0 +1,29 @@ +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.RadioButton.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + RadioButton: + formEditor: + label: formEditor.elements.RadioButton.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..34384a74248c0f164639c8ff0f6695cb1993fd6e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/formEditor/predefinedDefaults.rst @@ -0,0 +1,31 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.RadioButton.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + RadioButton: + formEditor: + predefinedDefaults: + properties: + options: { } + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..d69af519a29c5b3db2f225ea952997e4faab4b17 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.RadioButton.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + RadioButton: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/properties/containerClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/properties/containerClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..fc33a39088c79d6e879a92b0f86d0a5f3add0a43 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/properties/containerClassAttribute.rst @@ -0,0 +1,37 @@ +properties.containerClassAttribute +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.RadioButton.properties.containerClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + RadioButton: + properties: + containerClassAttribute: input + elementClassAttribute: xlarge + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is typically wrapped around the form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/properties/elementClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/properties/elementClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..79cd8e1515b941a12011634f65df7495be431af7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/properties/elementClassAttribute.rst @@ -0,0 +1,37 @@ +properties.elementClassAttribute +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.RadioButton.properties.elementClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + RadioButton: + properties: + containerClassAttribute: input + elementClassAttribute: xlarge + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class written to the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/properties/elementErrorClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/properties/elementErrorClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..31c582dd56296496c52bbd566bde2d7c851164f3 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/RadioButton/properties/elementErrorClassAttribute.rst @@ -0,0 +1,37 @@ +properties.elementErrorClassAttribute +------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.RadioButton.properties.elementErrorClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + RadioButton: + properties: + containerClassAttribute: input + elementClassAttribute: xlarge + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is written to the form element if validation errors exists. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect.rst new file mode 100644 index 0000000000000000000000000000000000000000..3d591309dbfb81340d04d15f331cabc16e721556 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect.rst @@ -0,0 +1,64 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.singleselect: + +============== +[SingleSelect] +============== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.singleselect-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.implementationclassname: +.. include:: SingleSelect/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.properties.containerclassattribute: +.. include:: SingleSelect/properties/containerClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.properties.elementclassattribute: +.. include:: SingleSelect/properties/elementClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.properties.elementerrorclassattribute: +.. include:: SingleSelect/properties/elementErrorClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.formeditor: +.. include:: SingleSelect/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.formeditor.editors.100: +.. include:: SingleSelect/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.formeditor.editors.200: +.. include:: SingleSelect/formEditor/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.formeditor.editors.250: +.. include:: SingleSelect/formEditor/editors/250.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.formeditor.editors.300: +.. include:: SingleSelect/formEditor/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.formeditor.editors.700: +.. include:: SingleSelect/formEditor/editors/700.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.formeditor.editors.800: +.. include:: SingleSelect/formEditor/editors/800.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.formeditor.editors.9999: +.. include:: SingleSelect/formEditor/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.formeditor.predefineddefaults: +.. include:: SingleSelect/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.formeditor.label: +.. include:: SingleSelect/formEditor/label.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.formeditor.group: +.. include:: SingleSelect/formEditor/group.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.formeditor.groupsorting: +.. include:: SingleSelect/formEditor/groupSorting.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.formeditor.iconidentifier: +.. include:: SingleSelect/formEditor/iconIdentifier.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..5587708167c3b78e1033cd1e70064e5078258aa7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor.rst @@ -0,0 +1,89 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SingleSelect.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + SingleSelect: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 250: + identifier: inactiveOption + templateName: Inspector-TextEditor + label: formEditor.elements.SelectionMixin.editor.inactiveOption.label + propertyPath: properties.prependOptionLabel + fieldExplanationText: formEditor.elements.SelectionMixin.editor.inactiveOption.fieldExplanationText + doNotSetIfPropertyValueIsEmpty: true + 300: + identifier: options + templateName: Inspector-PropertyGridEditor + label: formEditor.elements.SelectionMixin.editor.options.label + propertyPath: properties.options + isSortable: true + enableAddRow: true + enableDeleteRow: true + removeLastAvailableRowFlashMessageTitle: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageTitle + removeLastAvailableRowFlashMessageMessage: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageMessage + shouldShowPreselectedValueColumn: single + multiSelection: false + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + properties: + options: { } + label: formEditor.elements.SingleSelect.label + group: select + groupSorting: 200 + iconIdentifier: t3-form-icon-single-select diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..f64c885c9f609b7b22e66c34d165fa03d77e7975 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/100.rst @@ -0,0 +1,29 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SingleSelect.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + SingleSelect: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..6459592137513ed9a9105ccc3f1113608442dbb3 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/200.rst @@ -0,0 +1,31 @@ +formEditor.editors.200 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SingleSelect.formEditor.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + SingleSelect: + formEditor: + editors: + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/250.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/250.rst new file mode 100644 index 0000000000000000000000000000000000000000..34d153e6271e92abfb1d83f281dac447cf1c8c55 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/250.rst @@ -0,0 +1,33 @@ +formEditor.editors.250 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SingleSelect.formEditor.editors.250 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + SingleSelect: + formEditor: + editors: + 250: + identifier: inactiveOption + templateName: Inspector-TextEditor + label: formEditor.elements.SelectionMixin.editor.inactiveOption.label + propertyPath: properties.prependOptionLabel + fieldExplanationText: formEditor.elements.SelectionMixin.editor.inactiveOption.fieldExplanationText + doNotSetIfPropertyValueIsEmpty: true diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..6b4eeafd98efb4fb27a73cbb3e8c00e1d929dcc8 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/300.rst @@ -0,0 +1,38 @@ +formEditor.editors.300 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SingleSelect.formEditor.editors.300 + +:aspect:`Data type` + array/ :ref:`[PropertyGridEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.propertygrideditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + SingleSelect: + formEditor: + editors: + 300: + identifier: options + templateName: Inspector-PropertyGridEditor + label: formEditor.elements.SelectionMixin.editor.options.label + propertyPath: properties.options + isSortable: true + enableAddRow: true + enableDeleteRow: true + removeLastAvailableRowFlashMessageTitle: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageTitle + removeLastAvailableRowFlashMessageMessage: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageMessage + shouldShowPreselectedValueColumn: single + multiSelection: false diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/700.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/700.rst new file mode 100644 index 0000000000000000000000000000000000000000..8e0edc44d0ac1bf89cf0bf3cf3cf8413ef3a4324 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/700.rst @@ -0,0 +1,49 @@ +formEditor.editors.700 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SingleSelect.formEditor.editors.700 + +:aspect:`Data type` + array/ :ref:`[GridColumnViewPortConfigurationEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + SingleSelect: + formEditor: + editors: + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/800.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/800.rst new file mode 100644 index 0000000000000000000000000000000000000000..949a7468bbfa14180d0303aa18b07eb1bf7ac26c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/800.rst @@ -0,0 +1,35 @@ +formEditor.editors.800 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SingleSelect.formEditor.editors.800 + +:aspect:`Data type` + array/ :ref:`[RequiredValidatorEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + SingleSelect: + formEditor: + editors: + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..c112dec95efa0afed5a1bf528eb3e6609b1cca41 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/editors/9999.rst @@ -0,0 +1,30 @@ +formEditor.editors.9999 +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SingleSelect.formEditor.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + SingleSelect: + formEditor: + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/group.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/group.rst new file mode 100644 index 0000000000000000000000000000000000000000..395376f608e078f5f1e48856ecab93390f2c3ac2 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/group.rst @@ -0,0 +1,30 @@ +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SingleSelect.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + SingleSelect: + formEditor: + group: select + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/groupSorting.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/groupSorting.rst new file mode 100644 index 0000000000000000000000000000000000000000..90367e245ecca86dc092760d6997ef839582f185 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/groupSorting.rst @@ -0,0 +1,29 @@ +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SingleSelect.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + SingleSelect: + formEditor: + groupSorting: 200 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..8bbf3b9202ca7e67a7d65836b822ca5e83621502 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SingleSelect.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + SingleSelect: + formEditor: + iconIdentifier: t3-form-icon-single-select + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..153e3fc47d54430f93eeca860b0d262b4cd4c3f1 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/label.rst @@ -0,0 +1,29 @@ +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SingleSelect.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + SingleSelect: + formEditor: + label: formEditor.elements.SingleSelect.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..445da2a82469edac5b3107d448aeef341d48c85d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/formEditor/predefinedDefaults.rst @@ -0,0 +1,31 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SingleSelect.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + SingleSelect: + formEditor: + predefinedDefaults: + properties: + options: { } + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..48ae35d7436ef4b511e49b98736f8f86e12bdd35 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SingleSelect.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + SingleSelect: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/properties/containerClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/properties/containerClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..7ef03c43b945287be19a82b73ed5d5297ab7e80a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/properties/containerClassAttribute.rst @@ -0,0 +1,37 @@ +properties.containerClassAttribute +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SingleSelect.properties.containerClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + SingleSelect: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is typically wrapped around the form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/properties/elementClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/properties/elementClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..ff6cc1478cb2b20b2054ec3dee9a353d80d6f599 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/properties/elementClassAttribute.rst @@ -0,0 +1,37 @@ +properties.elementClassAttribute +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SingleSelect.properties.elementClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + SingleSelect: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class written to the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/properties/elementErrorClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/properties/elementErrorClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..7e6140d125492cbeb3ba1f2652214f7073c71c49 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/properties/elementErrorClassAttribute.rst @@ -0,0 +1,37 @@ +properties.elementErrorClassAttribute +------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SingleSelect.properties.elementErrorClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + SingleSelect: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is written to the form element if validation errors exists. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText.rst new file mode 100644 index 0000000000000000000000000000000000000000..5b68549306873437da0bc6b59824829871479542 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText.rst @@ -0,0 +1,49 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.statictext: + +============ +[StaticText] +============ + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.statictext-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.statictext.implementationclassname: +.. include:: StaticText/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.statictext.properties.text: +.. include:: StaticText/properties/text.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.statictext.formeditor: +.. include:: StaticText/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.statictext.formeditor.editors.100: +.. include:: StaticText/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.statictext.formeditor.editors.200: +.. include:: StaticText/formEditor/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.statictext.formeditor.editors.300: +.. include:: StaticText/formEditor/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.statictext.formeditor.editors.9999: +.. include:: StaticText/formEditor/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.statictext.formeditor.predefineddefaults: +.. include:: StaticText/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.statictext.formeditor.label: +.. include:: StaticText/formEditor/label.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.statictext.formeditor.group: +.. include:: StaticText/formEditor/group.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.statictext.formeditor.groupsorting: +.. include:: StaticText/formEditor/groupSorting.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.statictext.formeditor.iconidentifier: +.. include:: StaticText/formEditor/iconIdentifier.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..0144c2c303b14d9d7aa9f6b9943d8940f05ccfea --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor.rst @@ -0,0 +1,46 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.StaticText.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + StaticText: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.ReadOnlyFormElement.editor.label.label + propertyPath: label + 300: + identifier: staticText + templateName: Inspector-TextareaEditor + label: formEditor.elements.StaticText.editor.staticText.label + propertyPath: properties.text + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + properties: + text: '' + label: formEditor.elements.StaticText.label + group: custom + groupSorting: 600 + iconIdentifier: t3-form-icon-static-text diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..756ffe6017058a544fbf50281933381998cc4391 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/editors/100.rst @@ -0,0 +1,29 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.StaticText.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + StaticText: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..334eba736fd42eb70c33c34dfb213d4ac9fd1bc1 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/editors/200.rst @@ -0,0 +1,31 @@ +formEditor.editors.200 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.StaticText.formEditor.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + StaticText: + formEditor: + editors: + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.ReadOnlyFormElement.editor.label.label + propertyPath: label diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..b6ccde393d8922779ad1756b7a2d3e51bb6f5fd2 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/editors/300.rst @@ -0,0 +1,31 @@ +formEditor.editors.300 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.StaticText.formEditor.editors.300 + +:aspect:`Data type` + array/ :ref:`[TextareaEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.textareaeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + StaticText: + formEditor: + editors: + 300: + identifier: staticText + templateName: Inspector-TextareaEditor + label: formEditor.elements.StaticText.editor.staticText.label + propertyPath: properties.text diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..4edcd154cc5cbda20190d04e1d5d618e33620d6b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/editors/9999.rst @@ -0,0 +1,30 @@ +formEditor.editors.9999 +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.StaticText.formEditor.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + StaticText: + formEditor: + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/group.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/group.rst new file mode 100644 index 0000000000000000000000000000000000000000..62bde1bacbce6591a33cc463e08cc70139b18d2d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/group.rst @@ -0,0 +1,30 @@ +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.StaticText.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + StaticText: + formEditor: + group: custom + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/groupSorting.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/groupSorting.rst new file mode 100644 index 0000000000000000000000000000000000000000..0abbdf1ed6c38023d9dda410d342d3e182148304 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/groupSorting.rst @@ -0,0 +1,29 @@ +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.StaticText.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + StaticText: + formEditor: + groupSorting: 600 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..fc46135c12d1a0aa3502228ca3178add9e6c16d5 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.StaticText.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + StaticText: + formEditor: + iconIdentifier: t3-form-icon-static-text + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..69a4ceee7148b37f1083acafcb45e38194dcf363 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/label.rst @@ -0,0 +1,29 @@ +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.StaticText.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + StaticText: + formEditor: + label: formEditor.elements.StaticText.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..0ae639dac33686bc277b7f34463c41a823d055d4 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/formEditor/predefinedDefaults.rst @@ -0,0 +1,31 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.StaticText.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + StaticText: + formEditor: + predefinedDefaults: + properties: + text: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..d493c03883b3b9d6c64b5fce420e523eff95bbae --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.StaticText.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + StaticText: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/properties/text.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/properties/text.rst new file mode 100644 index 0000000000000000000000000000000000000000..806945139dd85b7da4a62dc7e8c58b09b06eeda1 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/StaticText/properties/text.rst @@ -0,0 +1,35 @@ +properties.text +--------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.StaticText.properties.text + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + Yes + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + StaticText: + properties: + text: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The text to display. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage.rst new file mode 100644 index 0000000000000000000000000000000000000000..be75cff0d9694158839b1dbd5845983310132e28 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage.rst @@ -0,0 +1,67 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.summarysummarypage: + +============= +[SummaryPage] +============= + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.summarysummarypage-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.summarypage.implementationclassname: +.. include:: SummaryPage/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.summarypage.renderingoptions._iscompositeformelement: +.. include:: SummaryPage/renderingOptions/_isCompositeFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.summarypage.renderingoptions._istoplevelformelement: +.. include:: SummaryPage/renderingOptions/_isTopLevelFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.summarypage.renderingoptions.nextbuttonlabel: +.. include:: SummaryPage/renderingOptions/nextButtonLabel.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.summarypage.renderingoptions.previousbuttonlabel: +.. include:: SummaryPage/renderingOptions/previousButtonLabel.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.summarypage.formeditor: +.. include:: SummaryPage/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.summarypage.formeditor.editors.100: +.. include:: SummaryPage/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.summarypage.formeditor.editors.200: +.. include:: SummaryPage/formEditor/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.summarypage.formeditor.editors.300: +.. include:: SummaryPage/formEditor/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.summarypage.formeditor.editors.400: +.. include:: SummaryPage/formEditor/editors/400.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.summarypage.formeditor.editors.9999: +.. include:: SummaryPage/formEditor/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.summarypage.formeditor.predefineddefaults: +.. include:: SummaryPage/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.summarypage.formeditor._iscompositeformelement: +.. include:: SummaryPage/formEditor/_isCompositeFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.summarypage.formeditor._istoplevelformelement: +.. include:: SummaryPage/formEditor/_isTopLevelFormElement.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.summarypage.formeditor.label: +.. include:: SummaryPage/formEditor/label.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.summarypage.formeditor.group: +.. include:: SummaryPage/formEditor/group.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.summarypage.formeditor.groupsorting: +.. include:: SummaryPage/formEditor/groupSorting.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.summarypage.formeditor.iconidentifier: +.. include:: SummaryPage/formEditor/iconIdentifier.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..6b0d982d7b59b11193dfdc6baebc1e87788771e7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor.rst @@ -0,0 +1,54 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SummaryPage.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + SummaryPage: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.SummaryPage.editor.label.label + propertyPath: label + 300: + identifier: 'previousButtonLabel' + templateName: 'Inspector-TextEditor' + label: 'formEditor.elements.SummaryPage.editor.previousButtonLabel.label' + propertyPath: 'renderingOptions.previousButtonLabel' + 400: + identifier: 'nextButtonLabel' + templateName: 'Inspector-TextEditor' + label: 'formEditor.elements.SummaryPage.editor.nextButtonLabel.label' + propertyPath: 'renderingOptions.nextButtonLabel' + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + renderingOptions: + previousButtonLabel: 'formEditor.elements.SummaryPage.editor.previousButtonLabel.value' + nextButtonLabel: 'formEditor.elements.SummaryPage.editor.nextButtonLabel.value' + label: formEditor.elements.SummaryPage.label + group: page + groupSorting: 200 + _isTopLevelFormElement: true + _isCompositeFormElement: false + iconIdentifier: t3-form-icon-summary-page diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/_isCompositeFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/_isCompositeFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..3136a4e403e15d473701e36f397cc05289dcd528 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/_isCompositeFormElement.rst @@ -0,0 +1,29 @@ +formEditor._isCompositeFormElement +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SummaryPage.formEditor._isCompositeFormElement + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + SummaryPage: + formEditor: + _isCompositeFormElement: false + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting to define that the form element contains child form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/_isTopLevelFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/_isTopLevelFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..a9b6e941cedc3860c87ad0afb3ac203a637bbdf1 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/_isTopLevelFormElement.rst @@ -0,0 +1,29 @@ +formEditor._isTopLevelFormElement +--------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SummaryPage.formEditor._isTopLevelFormElement + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + SummaryPage: + formEditor: + _isTopLevelFormElement: true + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting to define that the form element must not have a parent form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..3db6936498930da85eebfd68c279fa0fe581a614 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/editors/100.rst @@ -0,0 +1,29 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SummaryPage.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + SummaryPage: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..28f5caf013f88434ab4b7cc1140739a00f50b931 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/editors/200.rst @@ -0,0 +1,31 @@ +formEditor.editors.200 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SummaryPage.formEditor.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + SummaryPage: + formEditor: + editors: + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.SummaryPage.editor.label.label + propertyPath: label diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..70f12d1b0ceeef7794a959cdd6fb9c3d6a19ad8b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/editors/300.rst @@ -0,0 +1,31 @@ +formEditor.editors.300 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SummaryPage.formEditor.editors.300 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Form: + formEditor: + editors: + 300: + identifier: 'previousButtonLabel' + templateName: 'Inspector-TextEditor' + label: 'formEditor.elements.SummaryPage.editor.previousButtonLabel.label' + propertyPath: 'renderingOptions.previousButtonLabel' diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/editors/400.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/editors/400.rst new file mode 100644 index 0000000000000000000000000000000000000000..565c09d14da4e0fa867b876818edb5b4e23189da --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/editors/400.rst @@ -0,0 +1,31 @@ +formEditor.editors.400 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SummaryPage.formEditor.editors.400 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Form: + formEditor: + editors: + 400: + identifier: 'nextButtonLabel' + templateName: 'Inspector-TextEditor' + label: 'formEditor.elements.SummaryPage.editor.nextButtonLabel.label' + propertyPath: 'renderingOptions.nextButtonLabel' diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..465a959657040ec01c0b4309f5090243467a74d7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/editors/9999.rst @@ -0,0 +1,30 @@ +formEditor.editors.9999 +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SummaryPage.formEditor.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + SummaryPage: + formEditor: + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/group.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/group.rst new file mode 100644 index 0000000000000000000000000000000000000000..6e195babaa1805f2fd29177516f1fb7cb055713a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/group.rst @@ -0,0 +1,30 @@ +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SummaryPage.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + SummaryPage: + formEditor: + group: page + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/groupSorting.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/groupSorting.rst new file mode 100644 index 0000000000000000000000000000000000000000..ba977004f8218ff6c7a2d48b2dbbb8a9e4b53616 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/groupSorting.rst @@ -0,0 +1,29 @@ +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SummaryPage.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + SummaryPage: + formEditor: + groupSorting: 200 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..9923ce2f34f74f2a242e0e5bfa4d59e0cbf72a6b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SummaryPage.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + SummaryPage: + formEditor: + iconIdentifier: t3-form-icon-summary-page + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..0ce9a8e17fa83424625010039da7212f0b21008b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/label.rst @@ -0,0 +1,29 @@ +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SummaryPage.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + SummaryPage: + formEditor: + label: formEditor.elements.SummaryPage.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..bbfaa790f8fc70a5ad1bfc5dce704d9fb27da94c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/formEditor/predefinedDefaults.rst @@ -0,0 +1,32 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SummaryPage.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + SummaryPage: + formEditor: + predefinedDefaults: + renderingOptions: + previousButtonLabel: 'formEditor.elements.SummaryPage.editor.previousButtonLabel.value' + nextButtonLabel: 'formEditor.elements.SummaryPage.editor.nextButtonLabel.value' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..d1e255117cc3fbf147a135b89761656bdb240aa6 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SummaryPage.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + SummaryPage: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\Page + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/renderingOptions/_isCompositeFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/renderingOptions/_isCompositeFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..47e9977d2ad1aaaa66abbaebad6d3b2f754fda5e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/renderingOptions/_isCompositeFormElement.rst @@ -0,0 +1,38 @@ +renderingOptions._isCompositeFormElement +---------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SummaryPage.renderingOptions._isCompositeFormElement + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + SummaryPage: + renderingOptions: + _isTopLevelFormElement: true + _isCompositeFormElement: false + nextButtonLabel: 'next Page' + previousButtonLabel: 'previous Page' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting to define that the form element contains child form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/renderingOptions/_isTopLevelFormElement.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/renderingOptions/_isTopLevelFormElement.rst new file mode 100644 index 0000000000000000000000000000000000000000..64ad047817717a41feee5c886de8980eed41a74b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/renderingOptions/_isTopLevelFormElement.rst @@ -0,0 +1,38 @@ +renderingOptions._isTopLevelFormElement +--------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SummaryPage.renderingOptions._isTopLevelFormElement + +:aspect:`Data type` + bool + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + SummaryPage: + renderingOptions: + _isTopLevelFormElement: true + _isCompositeFormElement: false + nextButtonLabel: 'next Page' + previousButtonLabel: 'previous Page' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Internal control setting to define that the form element must not have a parent form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/renderingOptions/nextButtonLabel.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/renderingOptions/nextButtonLabel.rst new file mode 100644 index 0000000000000000000000000000000000000000..330ec7ce61132b8b774b34c5deb1ae96f4b3a526 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/renderingOptions/nextButtonLabel.rst @@ -0,0 +1,38 @@ +renderingOptions.nextButtonLabel +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SummaryPage.renderingOptions.nextButtonLabel + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + Yes + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + SummaryPage: + renderingOptions: + _isTopLevelFormElement: true + _isCompositeFormElement: false + nextButtonLabel: 'next Page' + previousButtonLabel: 'previous Page' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The label for the "next page" Button. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/renderingOptions/previousButtonLabel.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/renderingOptions/previousButtonLabel.rst new file mode 100644 index 0000000000000000000000000000000000000000..f27919bce2d74817d3dc6d53921be3706b2c6864 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SummaryPage/renderingOptions/previousButtonLabel.rst @@ -0,0 +1,38 @@ +renderingOptions.previousButtonLabel +------------------------------------ + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SummaryPage.renderingOptions.previousButtonLabel + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + Yes + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + SummaryPage: + renderingOptions: + _isTopLevelFormElement: true + _isCompositeFormElement: false + nextButtonLabel: 'next Page' + previousButtonLabel: 'previous Page' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The label for the "previous page" Button. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text.rst new file mode 100644 index 0000000000000000000000000000000000000000..973e27852bd14f03ae7d1e5aa317b10191688116 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text.rst @@ -0,0 +1,178 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.text: + +====== +[Text] +====== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.text-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.implementationclassname: +.. include:: Text/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.properties.containerclassattribute: +.. include:: Text/properties/containerClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.properties.elementclassattribute: +.. include:: Text/properties/elementClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.properties.elementerrorclassattribute: +.. include:: Text/properties/elementErrorClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor: +.. include:: Text/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.editors.100: +.. include:: Text/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.editors.200: +.. include:: Text/formEditor/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.editors.400: +.. include:: Text/formEditor/editors/400.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.editors.500: +.. include:: Text/formEditor/editors/500.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.editors.700: +.. include:: Text/formEditor/editors/700.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.editors.800: +.. include:: Text/formEditor/editors/800.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.editors.900: +.. include:: Text/formEditor/editors/900.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.editors.9999: +.. include:: Text/formEditor/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.predefineddefaults: +.. include:: Text/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.10: +.. include:: Text/formEditor/propertyCollections/validators/10.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.10.identifier: +.. include:: Text/formEditor/propertyCollections/validators/10/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.10.editors.100: +.. include:: Text/formEditor/propertyCollections/validators/10/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.10.editors.9999: +.. include:: Text/formEditor/propertyCollections/validators/10/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.20: +.. include:: Text/formEditor/propertyCollections/validators/20.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.20.identifier: +.. include:: Text/formEditor/propertyCollections/validators/20/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.20.editors.100: +.. include:: Text/formEditor/propertyCollections/validators/20/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.20.editors.9999: +.. include:: Text/formEditor/propertyCollections/validators/20/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.30: +.. include:: Text/formEditor/propertyCollections/validators/30.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.30.identifier: +.. include:: Text/formEditor/propertyCollections/validators/30/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.30.editors.100: +.. include:: Text/formEditor/propertyCollections/validators/30/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.30.editors.200: +.. include:: Text/formEditor/propertyCollections/validators/30/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.30.editors.300: +.. include:: Text/formEditor/propertyCollections/validators/30/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.30.editors.9999: +.. include:: Text/formEditor/propertyCollections/validators/30/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.40: +.. include:: Text/formEditor/propertyCollections/validators/40.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.40.identifier: +.. include:: Text/formEditor/propertyCollections/validators/40/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.40.editors.100: +.. include:: Text/formEditor/propertyCollections/validators/40/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.40.editors.9999: +.. include:: Text/formEditor/propertyCollections/validators/40/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.50: +.. include:: Text/formEditor/propertyCollections/validators/50.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.50.identifier: +.. include:: Text/formEditor/propertyCollections/validators/50/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.50.editors.100: +.. include:: Text/formEditor/propertyCollections/validators/50/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.50.editors.9999: +.. include:: Text/formEditor/propertyCollections/validators/50/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.60: +.. include:: Text/formEditor/propertyCollections/validators/60.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.60.identifier: +.. include:: Text/formEditor/propertyCollections/validators/60/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.60.editors.100: +.. include:: Text/formEditor/propertyCollections/validators/60/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.60.editors.9999: +.. include:: Text/formEditor/propertyCollections/validators/60/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.70: +.. include:: Text/formEditor/propertyCollections/validators/70.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.70.identifier: +.. include:: Text/formEditor/propertyCollections/validators/70/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.70.editors.100: +.. include:: Text/formEditor/propertyCollections/validators/70/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.70.editors.200: +.. include:: Text/formEditor/propertyCollections/validators/70/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.70.editors.300: +.. include:: Text/formEditor/propertyCollections/validators/70/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.70.editors.9999: +.. include:: Text/formEditor/propertyCollections/validators/70/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.80: +.. include:: Text/formEditor/propertyCollections/validators/80.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.80.identifier: +.. include:: Text/formEditor/propertyCollections/validators/80/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.80.editors.100: +.. include:: Text/formEditor/propertyCollections/validators/80/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.80.editors.200: +.. include:: Text/formEditor/propertyCollections/validators/80/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.propertycollections.validators.80.editors.9999: +.. include:: Text/formEditor/propertyCollections/validators/80/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.label: +.. include:: Text/formEditor/label.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.group: +.. include:: Text/formEditor/group.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.groupsorting: +.. include:: Text/formEditor/groupSorting.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.text.formeditor.iconidentifier: +.. include:: Text/formEditor/iconIdentifier.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..eec94b6612c6727eaa235ab65c93e81d8aadf525 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor.rst @@ -0,0 +1,243 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + Text: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 400: + identifier: placeholder + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.placeholder.label + propertyPath: properties.fluidAdditionalAttributes.placeholder + compatibilityPropertyPath: properties.placeholder + doNotSetIfPropertyValueIsEmpty: true + 500: + identifier: defaultValue + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.defaultValue.label + propertyPath: defaultValue + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.TextMixin.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.TextMixin.editor.validators.EmptyValue.label + 20: + value: Alphanumeric + label: formEditor.elements.TextMixin.editor.validators.Alphanumeric.label + 30: + value: Text + label: formEditor.elements.TextMixin.editor.validators.Text.label + 40: + value: StringLength + label: formEditor.elements.TextMixin.editor.validators.StringLength.label + 50: + value: EmailAddress + label: formEditor.elements.TextMixin.editor.validators.EmailAddress.label + 60: + value: Integer + label: formEditor.elements.TextMixin.editor.validators.Integer.label + 70: + value: Float + label: formEditor.elements.TextMixin.editor.validators.Float.label + 80: + value: NumberRange + label: formEditor.elements.TextMixin.editor.validators.NumberRange.label + 90: + value: RegularExpression + label: formEditor.elements.TextMixin.editor.validators.RegularExpression.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + defaultValue: '' + propertyCollections: + validators: + 10: + identifier: Alphanumeric + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Alphanumeric.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 20: + identifier: Text + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Text.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 30: + identifier: StringLength + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.StringLength.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.minlength + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.maxlength + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 40: + identifier: EmailAddress + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.EmailAddress.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 50: + identifier: Integer + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Integer.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 60: + identifier: Float + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Float.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 70: + identifier: NumberRange + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.NumberRange.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 80: + identifier: RegularExpression + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.header.label + 200: + identifier: regex + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.label + fieldExplanationText: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.fieldExplanationText + propertyPath: options.regularExpression + propertyValidators: + 10: NotEmpty + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + label: formEditor.elements.Text.label + group: input + groupSorting: 100 + iconIdentifier: t3-form-icon-text diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..228454bdc9abce4163b52d16d40cc76e803e27b0 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/100.rst @@ -0,0 +1,30 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Text: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..4340af6f3074d42eaaa79cd445e7c8053c38d738 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/200.rst @@ -0,0 +1,32 @@ +formEditor.editors.200 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Text: + formEditor: + editors: + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/400.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/400.rst new file mode 100644 index 0000000000000000000000000000000000000000..417c19a9dafc1699a4808ff5d67654cf63f38955 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/400.rst @@ -0,0 +1,35 @@ +formEditor.editors.400 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.editors.400 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Text: + formEditor: + editors: + 400: + identifier: placeholder + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.placeholder.label + propertyPath: properties.fluidAdditionalAttributes.placeholder + compatibilityPropertyPath: properties.placeholder + doNotSetIfPropertyValueIsEmpty: true + + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/500.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/500.rst new file mode 100644 index 0000000000000000000000000000000000000000..fbcc2200a7f8414d31a398b8decf01270f1bf941 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/500.rst @@ -0,0 +1,32 @@ +formEditor.editors.400 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.editors.400 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Text: + formEditor: + editors: + 500: + identifier: defaultValue + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.defaultValue.label + propertyPath: defaultValue + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/700.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/700.rst new file mode 100644 index 0000000000000000000000000000000000000000..434c123fd62e7c7a35a5c6a94bd881a460185170 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/700.rst @@ -0,0 +1,50 @@ +formEditor.editors.700 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.editors.700 + +:aspect:`Data type` + array/ :ref:`[GridColumnViewPortConfigurationEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Text: + formEditor: + editors: + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/800.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/800.rst new file mode 100644 index 0000000000000000000000000000000000000000..7042833aec997db0e76b3eddeb9e355f64e6cb7e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/800.rst @@ -0,0 +1,36 @@ +formEditor.editors.800 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.editors.800 + +:aspect:`Data type` + array/ :ref:`[RequiredValidatorEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Text: + formEditor: + editors: + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + + + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/900.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/900.rst new file mode 100644 index 0000000000000000000000000000000000000000..6cbda9b0a053e312ef2fcb57de2821db9f263c33 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/900.rst @@ -0,0 +1,59 @@ +formEditor.editors.900 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.editors.900 + +:aspect:`Data type` + array/ :ref:`[ValidatorsEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.validatorseditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Text: + formEditor: + editors: + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.TextMixin.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.TextMixin.editor.validators.EmptyValue.label + 20: + value: Alphanumeric + label: formEditor.elements.TextMixin.editor.validators.Alphanumeric.label + 30: + value: Text + label: formEditor.elements.TextMixin.editor.validators.Text.label + 40: + value: StringLength + label: formEditor.elements.TextMixin.editor.validators.StringLength.label + 50: + value: EmailAddress + label: formEditor.elements.TextMixin.editor.validators.EmailAddress.label + 60: + value: Integer + label: formEditor.elements.TextMixin.editor.validators.Integer.label + 70: + value: Float + label: formEditor.elements.TextMixin.editor.validators.Float.label + 80: + value: NumberRange + label: formEditor.elements.TextMixin.editor.validators.NumberRange.label + 90: + value: RegularExpression + label: formEditor.elements.TextMixin.editor.validators.RegularExpression.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..fc7dbe877ef26dc5af6780ded17aa1f019527c99 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/editors/9999.rst @@ -0,0 +1,30 @@ +formEditor.editors.9999 +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Text: + formEditor: + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/group.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/group.rst new file mode 100644 index 0000000000000000000000000000000000000000..8d76c0d96e22f140106826334d6730384f7ffd73 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/group.rst @@ -0,0 +1,30 @@ +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Text: + formEditor: + group: input + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/groupSorting.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/groupSorting.rst new file mode 100644 index 0000000000000000000000000000000000000000..e8d30c656ec34cc5307f0cac19c1167beb9423ca --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/groupSorting.rst @@ -0,0 +1,29 @@ +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Text: + formEditor: + groupSorting: 100 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..915dc9a5c830f30851d280cdabfa17c2b854ad2a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Text: + formEditor: + iconIdentifier: t3-form-icon-text + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..ddb1ab51defb7d5fd2878e7a6989f6dc0bd28f37 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/label.rst @@ -0,0 +1,29 @@ +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Text: + formEditor: + label: formEditor.elements.Text.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..7bb5e928626b65c42e72a01f5517cbe796bf1443 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/predefinedDefaults.rst @@ -0,0 +1,30 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Text: + formEditor: + predefinedDefaults: + defaultValue: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/10.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/10.rst new file mode 100644 index 0000000000000000000000000000000000000000..0d038e90b39fc116122b33c3b463d73dd218d638 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/10.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.10 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.10 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Text: + formEditor: + propertyCollections: + validators: + 10: + identifier: Alphanumeric + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Alphanumeric.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/10/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/10/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..e052b10063535d115ac22f24452676ecd835b11b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/10/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.10.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.10.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 10: + identifier: Alphanumeric + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Alphanumeric.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/10/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/10/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..17a330d48ba1d093d8a54202d0ea8e16b17edad7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/10/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.10.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.10.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 10: + identifier: Alphanumeric + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/10/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/10/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..125afe15026f08e2ab0c93d86691fba99ba1172f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/10/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.10.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.10.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Text: + formEditor: + propertyCollections: + validators: + 10: + identifier: Alphanumeric + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/20.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/20.rst new file mode 100644 index 0000000000000000000000000000000000000000..8ab3c33f64a28c4cc26866df79344cece5473d7d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/20.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.20 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.20 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Text: + formEditor: + propertyCollections: + validators: + 20: + identifier: Text + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Text.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/20/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/20/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..462fb0fa34b62ee6e8705c99c1c388e3b0d2133d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/20/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.20.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.20.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 20: + identifier: Text + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Text.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/20/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/20/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..ba688c0b3974b7407529c07ea7c696e974e9f144 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/20/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.20.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.20.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 20: + identifier: Text + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/20/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/20/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..496d0981381ed9842faad03735c244ef9410d7ca --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/20/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.20.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.20.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Text: + formEditor: + propertyCollections: + validators: + 20: + identifier: Text + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/30.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/30.rst new file mode 100644 index 0000000000000000000000000000000000000000..8034b797b7d4e3e44c50889825b81a2c1ac05acd --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/30.rst @@ -0,0 +1,57 @@ +formEditor.propertyCollections.validators.30 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.30 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Text: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.StringLength.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.minlength + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.maxlength + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/30/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/30/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..a5cc4a2b5ef676977b33d3232c742ffaeb3e2e01 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/30/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.30.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.30.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.StringLength.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/30/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/30/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..7ed62a11d610481c2224bd96d654689c08f40350 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/30/editors/200.rst @@ -0,0 +1,39 @@ +formEditor.propertyCollections.validators.30.editors.200 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.30.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + editors: + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.minlength + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/30/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/30/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..6c8dd73e3f99c0ca0af113e737cb267c558505ac --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/30/editors/300.rst @@ -0,0 +1,39 @@ +formEditor.propertyCollections.validators.30.editors.300 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.30.editors.300 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + editors: + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.maxlength + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/30/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/30/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..739a6c1e9c230aadb768f7453728534f502cac92 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/30/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.30.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.30.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/30/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/30/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..7335bde7b85a87f21b7faf3b62ee4701daeccc9b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/30/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.30.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.30.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Text: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/40.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/40.rst new file mode 100644 index 0000000000000000000000000000000000000000..87cca0a92d594e27fe41f9ba5eebc7497a69d606 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/40.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.40 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.40 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Text: + formEditor: + propertyCollections: + validators: + 40: + identifier: EmailAddress + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.EmailAddress.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/40/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/40/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..f126e59f76b0a4f7cf65c79c08b065cd512a55ed --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/40/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.40.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.40.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 40: + identifier: EmailAddress + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.EmailAddress.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/40/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/40/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..ab288fcc4e2e1c27fd2f327ccb466ca916d520d7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/40/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.40.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.40.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 40: + identifier: EmailAddress + editors: + 100: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/40/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/40/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..5b83ed9076f29a50282991dd2a70953920631f1e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/40/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.40.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.40.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Text: + formEditor: + propertyCollections: + validators: + 40: + identifier: EmailAddress + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/50.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/50.rst new file mode 100644 index 0000000000000000000000000000000000000000..ded05666983befc4aeafc84295d6e588f9b9f925 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/50.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.50 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.50 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Text: + formEditor: + propertyCollections: + validators: + 50: + identifier: Integer + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Integer.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/50/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/50/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..3093b92bd23b44a99d662567bebc6636cf50d2f4 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/50/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.50.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.50.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 50: + identifier: Integer + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Integer.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/50/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/50/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..8425938c2da5660148d6649d282eb9add50fbb31 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/50/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.50.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.50.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 50: + identifier: Integer + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/50/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/50/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..143a45dddbdc65fabb2d667e4bc021915ed7df01 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/50/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.50.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.50.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Text: + formEditor: + propertyCollections: + validators: + 50: + identifier: Integer + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/60.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/60.rst new file mode 100644 index 0000000000000000000000000000000000000000..41141ea09014075f33caec31bd33e2f0e992ef24 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/60.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.60 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.60 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Text: + formEditor: + propertyCollections: + validators: + 60: + identifier: Float + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Float.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/60/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/60/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..75ed65c748b12b1a0f1dbdb082eaf12724702940 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/60/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.60.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.60.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 60: + identifier: Float + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Float.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/60/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/60/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..b3f5fa3bed6cd87aab65a32aece02f0134d4ce6e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/60/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.60.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.60.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 60: + identifier: Float + editors: + 100: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/60/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/60/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..3a97c98bc23d2dfc6c649f00c18c4a85df3b6879 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/60/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.60.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.60.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Text: + formEditor: + propertyCollections: + validators: + 60: + identifier: Float + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/70.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/70.rst new file mode 100644 index 0000000000000000000000000000000000000000..137a4afe71c381d52528b159e71ece737348039a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/70.rst @@ -0,0 +1,53 @@ +formEditor.propertyCollections.validators.70 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.70 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Text: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.NumberRange.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/70/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/70/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..b1d845b5e42ecf4d4f84aa5f8f45594029474afb --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/70/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.70.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.70.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.NumberRange.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/70/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/70/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..166a03daeba24230a5039ca2507a991381076b52 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/70/editors/200.rst @@ -0,0 +1,37 @@ +formEditor.propertyCollections.validators.70.editors.200 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.70.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + editors: + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/70/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/70/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..0e32fd4c8f1270cf3559b0e563e1c12794d0ed1d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/70/editors/300.rst @@ -0,0 +1,36 @@ +formEditor.propertyCollections.validators.70.editors.300 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.70.editors.300 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + editors: + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/70/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/70/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..24d5ae576cf46e2503a2e0d084bb0607f28a2c35 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/70/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.70.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.70.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/70/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/70/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..8e84e02bf622cfa79da0ac3a7fde816b759f4c81 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/70/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.70.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.70.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Text: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/80.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/80.rst new file mode 100644 index 0000000000000000000000000000000000000000..b338a8c4acc4544741a3964632d7add0f262eafe --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/80.rst @@ -0,0 +1,43 @@ +formEditor.propertyCollections.validators.80 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.80 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Text: + formEditor: + propertyCollections: + validators: + 80: + identifier: RegularExpression + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.header.label + 200: + identifier: regex + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.label + fieldExplanationText: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.fieldExplanationText + propertyPath: options.regularExpression + propertyValidators: + 10: NotEmpty + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/80/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/80/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..c4085582fc3c2273aefa9c5c108318b95f03a2f1 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/80/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.80.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.80.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 80: + identifier: RegularExpression + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/80/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/80/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..6a29b340eed2fd64d3acfca7f351b76279f913ac --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/80/editors/200.rst @@ -0,0 +1,36 @@ +formEditor.propertyCollections.validators.80.editors.200 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.80.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 80: + identifier: RegularExpression + editors: + 200: + identifier: regex + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.label + fieldExplanationText: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.fieldExplanationText + propertyPath: options.regularExpression + propertyValidators: + 10: NotEmpty + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/80/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/80/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..0ef6839ea5f50f818f49743d29f30575024e577c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/80/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.80.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.80.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Text: + formEditor: + propertyCollections: + validators: + 80: + identifier: RegularExpression + editors: + 100: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/80/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/80/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..dfc51c29177c7d7420583edc2392b97d8ed6f851 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/formEditor/propertyCollections/validators/80/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.80.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.formEditor.propertyCollections.validators.80.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Text: + formEditor: + propertyCollections: + validators: + 80: + identifier: RegularExpression + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..96a5dd541d22779c164628343ce1b0e8e5d2f29b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + Text: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/properties/containerClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/properties/containerClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..e5bf7e849adc1d907ae8cf8134765e96e0b523ee --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/properties/containerClassAttribute.rst @@ -0,0 +1,37 @@ +properties.containerClassAttribute +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.properties.containerClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Text: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is typically wrapped around the form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/properties/elementClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/properties/elementClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..17f1655883796548eb7b602351916284d07d752d --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/properties/elementClassAttribute.rst @@ -0,0 +1,37 @@ +properties.elementClassAttribute +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.properties.elementClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + Text: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class written to the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/properties/elementErrorClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/properties/elementErrorClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..9500b80c43c5d5ff91fd820463368f7e6c06b7b3 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Text/properties/elementErrorClassAttribute.rst @@ -0,0 +1,37 @@ +properties.elementErrorClassAttribute +------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Text.properties.elementErrorClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + Text: + properties: + containerClassAttribute: input + elementClassAttribute: '' + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is written to the form element if validation errors exists. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea.rst new file mode 100644 index 0000000000000000000000000000000000000000..787ce1818f2de91495209817b4f726d8759ffdf6 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea.rst @@ -0,0 +1,178 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.textareaarea: + +========== +[Textarea] +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.textareaarea-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.implementationclassname: +.. include:: Textarea/implementationClassName.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.properties.containerclassattribute: +.. include:: Textarea/properties/containerClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.properties.elementclassattribute: +.. include:: Textarea/properties/elementClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.properties.elementerrorclassattribute: +.. include:: Textarea/properties/elementErrorClassAttribute.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor: +.. include:: Textarea/formEditor.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.editors.100: +.. include:: Textarea/formEditor/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.editors.200: +.. include:: Textarea/formEditor/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.editors.400: +.. include:: Textarea/formEditor/editors/400.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.editors.500: +.. include:: Textarea/formEditor/editors/500.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.editors.700: +.. include:: Textarea/formEditor/editors/700.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.editors.800: +.. include:: Textarea/formEditor/editors/800.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.editors.900: +.. include:: Textarea/formEditor/editors/900.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.editors.9999: +.. include:: Textarea/formEditor/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.predefineddefaults: +.. include:: Textarea/formEditor/predefinedDefaults.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.10: +.. include:: Textarea/formEditor/propertyCollections/validators/10.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.10.identifier: +.. include:: Textarea/formEditor/propertyCollections/validators/10/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.10.editors.100: +.. include:: Textarea/formEditor/propertyCollections/validators/10/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.10.editors.9999: +.. include:: Textarea/formEditor/propertyCollections/validators/10/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.20: +.. include:: Textarea/formEditor/propertyCollections/validators/20.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.20.identifier: +.. include:: Textarea/formEditor/propertyCollections/validators/20/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.20.editors.100: +.. include:: Textarea/formEditor/propertyCollections/validators/20/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.20.editors.9999: +.. include:: Textarea/formEditor/propertyCollections/validators/20/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.30: +.. include:: Textarea/formEditor/propertyCollections/validators/30.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.30.identifier: +.. include:: Textarea/formEditor/propertyCollections/validators/30/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.30.editors.100: +.. include:: Textarea/formEditor/propertyCollections/validators/30/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.30.editors.200: +.. include:: Textarea/formEditor/propertyCollections/validators/30/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.30.editors.300: +.. include:: Textarea/formEditor/propertyCollections/validators/30/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.30.editors.9999: +.. include:: Textarea/formEditor/propertyCollections/validators/30/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.40: +.. include:: Textarea/formEditor/propertyCollections/validators/40.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.40.identifier: +.. include:: Textarea/formEditor/propertyCollections/validators/40/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.40.editors.100: +.. include:: Textarea/formEditor/propertyCollections/validators/40/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.40.editors.9999: +.. include:: Textarea/formEditor/propertyCollections/validators/40/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.50: +.. include:: Textarea/formEditor/propertyCollections/validators/50.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.50.identifier: +.. include:: Textarea/formEditor/propertyCollections/validators/50/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.50.editors.100: +.. include:: Textarea/formEditor/propertyCollections/validators/50/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.50.editors.9999: +.. include:: Textarea/formEditor/propertyCollections/validators/50/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.60: +.. include:: Textarea/formEditor/propertyCollections/validators/60.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.60.identifier: +.. include:: Textarea/formEditor/propertyCollections/validators/60/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.60.editors.100: +.. include:: Textarea/formEditor/propertyCollections/validators/60/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.60.editors.9999: +.. include:: Textarea/formEditor/propertyCollections/validators/60/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.70: +.. include:: Textarea/formEditor/propertyCollections/validators/70.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.70.identifier: +.. include:: Textarea/formEditor/propertyCollections/validators/70/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.70.editors.100: +.. include:: Textarea/formEditor/propertyCollections/validators/70/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.70.editors.200: +.. include:: Textarea/formEditor/propertyCollections/validators/70/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.70.editors.300: +.. include:: Textarea/formEditor/propertyCollections/validators/70/editors/300.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.70.editors.9999: +.. include:: Textarea/formEditor/propertyCollections/validators/70/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.80: +.. include:: Textarea/formEditor/propertyCollections/validators/80.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.80.identifier: +.. include:: Textarea/formEditor/propertyCollections/validators/80/identifier.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.80.editors.100: +.. include:: Textarea/formEditor/propertyCollections/validators/80/editors/100.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.80.editors.200: +.. include:: Textarea/formEditor/propertyCollections/validators/80/editors/200.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.propertycollections.validators.80.editors.9999: +.. include:: Textarea/formEditor/propertyCollections/validators/80/editors/9999.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.label: +.. include:: Textarea/formEditor/label.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.group: +.. include:: Textarea/formEditor/group.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.groupsorting: +.. include:: Textarea/formEditor/groupSorting.rst + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.iconidentifier: +.. include:: Textarea/formEditor/iconIdentifier.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor.rst new file mode 100644 index 0000000000000000000000000000000000000000..8ba55e4923e217d52f902fbbd582501d1b3546f6 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor.rst @@ -0,0 +1,240 @@ +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2- + + Textarea: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label + 400: + identifier: placeholder + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.placeholder.label + propertyPath: properties.fluidAdditionalAttributes.placeholder + compatibilityPropertyPath: properties.placeholder + doNotSetIfPropertyValueIsEmpty: true + 500: + identifier: defaultValue + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.defaultValue.label + propertyPath: defaultValue + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.TextMixin.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.TextMixin.editor.validators.EmptyValue.label + 20: + value: Alphanumeric + label: formEditor.elements.TextMixin.editor.validators.Alphanumeric.label + 30: + value: Text + label: formEditor.elements.TextMixin.editor.validators.Text.label + 40: + value: StringLength + label: formEditor.elements.TextMixin.editor.validators.StringLength.label + 60: + value: Integer + label: formEditor.elements.TextMixin.editor.validators.Integer.label + 70: + value: Float + label: formEditor.elements.TextMixin.editor.validators.Float.label + 80: + value: NumberRange + label: formEditor.elements.TextMixin.editor.validators.NumberRange.label + 90: + value: RegularExpression + label: formEditor.elements.TextMixin.editor.validators.RegularExpression.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + predefinedDefaults: + defaultValue: '' + propertyCollections: + validators: + 10: + identifier: Alphanumeric + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Alphanumeric.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 20: + identifier: Text + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Text.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 30: + identifier: StringLength + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.StringLength.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.minlength + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.maxlength + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 40: + identifier: EmailAddress + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.EmailAddress.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 50: + identifier: Integer + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Integer.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 60: + identifier: Float + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Float.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 70: + identifier: NumberRange + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.NumberRange.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + 80: + identifier: RegularExpression + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.header.label + 200: + identifier: regex + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.label + fieldExplanationText: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.fieldExplanationText + propertyPath: options.regularExpression + propertyValidators: + 10: NotEmpty + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + label: formEditor.elements.Textarea.label + group: input + groupSorting: 200 + iconIdentifier: t3-form-icon-textarea diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..7c09fcb98058de1ea63af27ccf0646aaa87596cb --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/100.rst @@ -0,0 +1,29 @@ +formEditor.editors.100 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.editors.100 + +:aspect:`Data type` + array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Textarea: + formEditor: + editors: + 100: + identifier: header + templateName: Inspector-FormElementHeaderEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..81cc2f2d40da82d86e0f7e2266a33ec82e57edaf --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/200.rst @@ -0,0 +1,31 @@ +formEditor.editors.200 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Textarea: + formEditor: + editors: + 200: + identifier: label + templateName: Inspector-TextEditor + label: formEditor.elements.FormElement.editor.label.label + propertyPath: label diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/400.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/400.rst new file mode 100644 index 0000000000000000000000000000000000000000..38540c5e1e4141e64167ad211e02bc00825ce24a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/400.rst @@ -0,0 +1,33 @@ +formEditor.editors.400 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.editors.400 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Textarea: + formEditor: + editors: + 400: + identifier: placeholder + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.placeholder.label + propertyPath: properties.fluidAdditionalAttributes.placeholder + compatibilityPropertyPath: properties.placeholder + doNotSetIfPropertyValueIsEmpty: true diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/500.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/500.rst new file mode 100644 index 0000000000000000000000000000000000000000..d1c380fb47953db9822d522c3b5b1b6be2c4c8ae --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/500.rst @@ -0,0 +1,31 @@ +formEditor.editors.400 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.editors.400 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Textarea: + formEditor: + editors: + 400: + identifier: defaultValue + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.editor.defaultValue.label + propertyPath: defaultValue diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/700.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/700.rst new file mode 100644 index 0000000000000000000000000000000000000000..a90f7047ea93e67eaf066348327eb47026f19d41 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/700.rst @@ -0,0 +1,48 @@ +formEditor.editors.700 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.editors.700 + +:aspect:`Data type` + array/ :ref:`[GridColumnViewPortConfigurationEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Textarea: + formEditor: + editors: + 700: + identifier: gridColumnViewPortConfiguration + templateName: Inspector-GridColumnViewPortConfigurationEditor + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label + configurationOptions: + viewPorts: + 10: + viewPortIdentifier: xs + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label + 20: + viewPortIdentifier: sm + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label + 30: + viewPortIdentifier: md + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label + 40: + viewPortIdentifier: lg + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label + numbersOfColumnsToUse: + label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label + propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse' + fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/800.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/800.rst new file mode 100644 index 0000000000000000000000000000000000000000..349ca27b40d1630dfacc5b9e9df824930df0844a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/800.rst @@ -0,0 +1,33 @@ +formEditor.editors.800 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.editors.800 + +:aspect:`Data type` + array/ :ref:`[RequiredValidatorEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Textarea: + formEditor: + editors: + 800: + identifier: requiredValidator + templateName: Inspector-RequiredValidatorEditor + label: formEditor.elements.FormElement.editor.requiredValidator.label + validatorIdentifier: NotEmpty + propertyPath: properties.fluidAdditionalAttributes.required + propertyValue: required diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/900.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/900.rst new file mode 100644 index 0000000000000000000000000000000000000000..d79f891367798b1085c15fd32bc2f5d6948c39e8 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/900.rst @@ -0,0 +1,58 @@ +formEditor.editors.900 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.editors.900 + +:aspect:`Data type` + array/ :ref:`[ValidatorsEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.validatorseditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Textarea: + formEditor: + editors: + 900: + identifier: validators + templateName: Inspector-ValidatorsEditor + label: formEditor.elements.TextMixin.editor.validators.label + selectOptions: + 10: + value: '' + label: formEditor.elements.TextMixin.editor.validators.EmptyValue.label + 20: + value: Alphanumeric + label: formEditor.elements.TextMixin.editor.validators.Alphanumeric.label + 30: + value: Text + label: formEditor.elements.TextMixin.editor.validators.Text.label + 40: + value: StringLength + label: formEditor.elements.TextMixin.editor.validators.StringLength.label + 50: + value: EmailAddress + label: formEditor.elements.TextMixin.editor.validators.EmailAddress.label + 60: + value: Integer + label: formEditor.elements.TextMixin.editor.validators.Integer.label + 70: + value: Float + label: formEditor.elements.TextMixin.editor.validators.Float.label + 80: + value: NumberRange + label: formEditor.elements.TextMixin.editor.validators.NumberRange.label + 90: + value: RegularExpression + label: formEditor.elements.TextMixin.editor.validators.RegularExpression.label diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..aa698a7465a5973c362e0f8b6e56abe59a249690 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/editors/9999.rst @@ -0,0 +1,29 @@ +formEditor.editors.9999 +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +.. :aspect:`Related options` + @ToDo + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4- + + Textarea: + formEditor: + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/group.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/group.rst new file mode 100644 index 0000000000000000000000000000000000000000..d246a57dff6ec9a185e99564f7e888ca3566e563 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/group.rst @@ -0,0 +1,30 @@ +formEditor.group +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.group + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Textarea: + formEditor: + group: input + +:aspect:`Default value` + Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`) + +:aspect:`Description` + Define within which group within the ``form editor`` "new Element" modal the form element should be shown. + The ``group`` value must be equal to an array key within ``formElementGroups``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/groupSorting.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/groupSorting.rst new file mode 100644 index 0000000000000000000000000000000000000000..219ac4d544ef0b91ae7990f9fa5cc9024285f971 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/groupSorting.rst @@ -0,0 +1,29 @@ +formEditor.groupSorting +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.groupSorting + +:aspect:`Data type` + int + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Textarea: + formEditor: + groupSorting: 200 + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + The position within the ``formEditor.group`` for this form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..86328d9f82013f55bccd35d6c88f0b6aaa9f8701 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/iconIdentifier.rst @@ -0,0 +1,35 @@ +formEditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Textarea: + formEditor: + iconIdentifier: t3-form-icon-textarea + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. + This icon will be shown within + + - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`. + - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`. + - ``Tree`` component. + - "new element" Modal \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..9ffdba2a7eee2c4e829bba3e0255b36808817bda --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/label.rst @@ -0,0 +1,29 @@ +formEditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Textarea: + formEditor: + label: formEditor.elements.Textarea.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + This label will be shown within the "new element" Modal. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..d8a3c6b615a758710c400b6f8e96cc8e266efc7e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/predefinedDefaults.rst @@ -0,0 +1,30 @@ +formEditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Textarea: + formEditor: + predefinedDefaults: + defaultValue: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/10.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/10.rst new file mode 100644 index 0000000000000000000000000000000000000000..aa0e04af4606e9f117d07943c8b86398fa754782 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/10.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.10 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.10 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Textarea: + formEditor: + propertyCollections: + validators: + 10: + identifier: Alphanumeric + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Alphanumeric.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/10/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/10/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..7c09e019440ad436af71a31cc97ba6ea9b2c9e96 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/10/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.10.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.10.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 10: + identifier: Alphanumeric + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Alphanumeric.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/10/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/10/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..110f651d82ce488e859e3022541ea1cfd0b7a5c8 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/10/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.10.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.10.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 10: + identifier: Alphanumeric + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/10/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/10/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..8c55f34190450db2d1b5654518e4dfcb2f8a9c06 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/10/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.10.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.10.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Textarea: + formEditor: + propertyCollections: + validators: + 10: + identifier: Alphanumeric + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/20.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/20.rst new file mode 100644 index 0000000000000000000000000000000000000000..41d118e60948469a1fd930ba326178216c46ba53 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/20.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.20 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.20 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Textarea: + formEditor: + propertyCollections: + validators: + 20: + identifier: Text + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Text.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/20/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/20/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..7262f826b72136b364c623ec94ba044e87346afb --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/20/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.20.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.20.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 20: + identifier: Text + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Text.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/20/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/20/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..c684931d94b552a778336dcfb2797ce650e0d855 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/20/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.20.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.20.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 20: + identifier: Text + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/20/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/20/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..508caa60935a81c1751144cd85fb2a3c77f2f2a3 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/20/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.20.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.20.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Textarea: + formEditor: + propertyCollections: + validators: + 20: + identifier: Text + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/30.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/30.rst new file mode 100644 index 0000000000000000000000000000000000000000..fa3b38e94c9c0107393f21f54e7ec423950e57c2 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/30.rst @@ -0,0 +1,57 @@ +formEditor.propertyCollections.validators.30 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.30 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Textarea: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.StringLength.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.minlength + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.maxlength + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/30/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/30/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..43b81a92087614faec43bc39bcae69569faa60cf --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/30/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.30.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.30.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.StringLength.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/30/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/30/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..bf248cc7d343180691c48fdaa5119d28b7291a28 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/30/editors/200.rst @@ -0,0 +1,39 @@ +formEditor.propertyCollections.validators.30.editors.200 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.30.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + editors: + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.minlength + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/30/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/30/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..df026687fd79b50563e1181dfdcf0e50424efde4 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/30/editors/300.rst @@ -0,0 +1,39 @@ +formEditor.propertyCollections.validators.30.editors.300 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.30.editors.300 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + editors: + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + additionalElementPropertyPaths: + 10: properties.fluidAdditionalAttributes.maxlength + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/30/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/30/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..b9d4a4c7ea3ed973cf3b8bab906d763ef8033934 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/30/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.30.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.30.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/30/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/30/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..bf3ad39a6ba8c3daa2c58cc8b1826d622c01ab51 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/30/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.30.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.30.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Textarea: + formEditor: + propertyCollections: + validators: + 30: + identifier: StringLength + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/40.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/40.rst new file mode 100644 index 0000000000000000000000000000000000000000..7063deed4fcf2c9bd94fffccfa3ed20274af3166 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/40.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.40 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.40 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Textarea: + formEditor: + propertyCollections: + validators: + 40: + identifier: EmailAddress + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.EmailAddress.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/40/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/40/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..822b3e886fc24de94e6c8927a2cc911c74cd6c68 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/40/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.40.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.40.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 40: + identifier: EmailAddress + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.EmailAddress.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/40/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/40/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..574dc45a07d81ada32207ddf57e29721c263a11b --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/40/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.40.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.40.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 40: + identifier: EmailAddress + editors: + 100: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/40/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/40/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..e82834c6961adbeed2be83489569d72bba0e27e0 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/40/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.40.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.40.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Textarea: + formEditor: + propertyCollections: + validators: + 40: + identifier: EmailAddress + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/50.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/50.rst new file mode 100644 index 0000000000000000000000000000000000000000..7a646f7822b979782c346203a2bbb7e0e6b0197f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/50.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.50 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.50 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Textarea: + formEditor: + propertyCollections: + validators: + 50: + identifier: Integer + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Integer.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/50/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/50/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..b0e2efb9fccbe8663fbf2390e895cdfebded8048 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/50/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.50.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.50.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 50: + identifier: Integer + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Integer.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/50/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/50/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..f6cbf23afaf56acf81a673f3fe605b886a35fbfe --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/50/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.50.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.50.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 50: + identifier: Integer + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/50/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/50/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..7c557a547dafd9379b96976ac45ad9e832315ed0 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/50/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.50.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.50.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Textarea: + formEditor: + propertyCollections: + validators: + 50: + identifier: Integer + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/60.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/60.rst new file mode 100644 index 0000000000000000000000000000000000000000..9c35228d1dd1f89272fba4e72f94d1cd21df11fe --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/60.rst @@ -0,0 +1,35 @@ +formEditor.propertyCollections.validators.60 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.60 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Textarea: + formEditor: + propertyCollections: + validators: + 60: + identifier: Float + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Float.editor.header.label + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/60/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/60/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..e05cdfa1cebf7561f066598e393f8e9fa60de65f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/60/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.60.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.60.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 60: + identifier: Float + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.Float.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/60/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/60/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..32e188e6b7a7b5185fd2fecde077a7d13c02e52e --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/60/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.60.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.60.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 60: + identifier: Float + editors: + 100: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/60/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/60/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..72c21fc36c9aa84c1a788d14f362c158967d32d3 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/60/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.60.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.60.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Textarea: + formEditor: + propertyCollections: + validators: + 60: + identifier: Float + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/70.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/70.rst new file mode 100644 index 0000000000000000000000000000000000000000..42c6258b7ff54dbd0dd7e899d1e6898ff4a0f2e9 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/70.rst @@ -0,0 +1,53 @@ +formEditor.propertyCollections.validators.70 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.70 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Textarea: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.NumberRange.editor.header.label + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/70/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/70/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..778e179ffc32e797ed8dabd03e41d15f1a6aeb11 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/70/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.70.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.70.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.NumberRange.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/70/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/70/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..1ac2c3e8470567d7184d817c151c56e85225c895 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/70/editors/200.rst @@ -0,0 +1,37 @@ +formEditor.propertyCollections.validators.70.editors.200 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.70.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + editors: + 200: + identifier: minimum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label + propertyPath: options.minimum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/70/editors/300.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/70/editors/300.rst new file mode 100644 index 0000000000000000000000000000000000000000..851a82b95d778d13b08a122360e4695efdd2ed65 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/70/editors/300.rst @@ -0,0 +1,36 @@ +formEditor.propertyCollections.validators.70.editors.300 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.70.editors.300 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + editors: + 300: + identifier: maximum + templateName: Inspector-TextEditor + label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label + propertyPath: options.maximum + propertyValidatorsMode: OR + propertyValidators: + 10: Integer + 20: FormElementIdentifierWithinCurlyBracesExclusive diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/70/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/70/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..cd450bff7a037e9cf0ea55dca4e22eafd1131496 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/70/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.70.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.70.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + editors: + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/70/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/70/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..95247ebb13eeb6ec2e5d814f5f86d7066b006c9a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/70/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.70.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.70.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Textarea: + formEditor: + propertyCollections: + validators: + 70: + identifier: NumberRange + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/80.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/80.rst new file mode 100644 index 0000000000000000000000000000000000000000..e025e3d57af2918e3c2b136850d359c9d732e743 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/80.rst @@ -0,0 +1,43 @@ +formEditor.propertyCollections.validators.80 +-------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.80 + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5- + + Textarea: + formEditor: + propertyCollections: + validators: + 80: + identifier: RegularExpression + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.header.label + 200: + identifier: regex + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.label + fieldExplanationText: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.fieldExplanationText + propertyPath: options.regularExpression + propertyValidators: + 10: NotEmpty + 9999: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/80/editors/100.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/80/editors/100.rst new file mode 100644 index 0000000000000000000000000000000000000000..a53746ef6de017f399f82b959099edf418be174a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/80/editors/100.rst @@ -0,0 +1,32 @@ +formEditor.propertyCollections.validators.80.editors.100 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.80.editors.100 + +:aspect:`Data type` + array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 80: + identifier: RegularExpression + editors: + 100: + identifier: header + templateName: Inspector-CollectionElementHeaderEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.header.label + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/80/editors/200.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/80/editors/200.rst new file mode 100644 index 0000000000000000000000000000000000000000..d71312eb0bee48f9605076e4014a8891cfb4b9ad --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/80/editors/200.rst @@ -0,0 +1,36 @@ +formEditor.propertyCollections.validators.80.editors.200 +-------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.80.editors.200 + +:aspect:`Data type` + array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 80: + identifier: RegularExpression + editors: + 200: + identifier: regex + templateName: Inspector-TextEditor + label: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.label + fieldExplanationText: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.fieldExplanationText + propertyPath: options.regularExpression + propertyValidators: + 10: NotEmpty + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/80/editors/9999.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/80/editors/9999.rst new file mode 100644 index 0000000000000000000000000000000000000000..b0d978fcc6b0e4e67b826408ebed259aaf7d589f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/80/editors/9999.rst @@ -0,0 +1,31 @@ +formEditor.propertyCollections.validators.80.editors.9999 +--------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.80.editors.9999 + +:aspect:`Data type` + array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>` + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 8- + + Textarea: + formEditor: + propertyCollections: + validators: + 80: + identifier: RegularExpression + editors: + 100: + identifier: removeButton + templateName: Inspector-RemoveElementEditor + diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/80/identifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/80/identifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..3726ff30f865a6783edbdb1e9880c4aa75e1160c --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/formEditor/propertyCollections/validators/80/identifier.rst @@ -0,0 +1,33 @@ +formEditor.propertyCollections.validators.80.identifier +------------------------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.propertyCollections.validators.80.identifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + Textarea: + formEditor: + propertyCollections: + validators: + 80: + identifier: RegularExpression + +:aspect:`Good to know` + - :ref:`"Inspector"<concepts-formeditor-inspector>` + - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>` + +:aspect:`Description` + Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..a724373139c5dab578bbffd1c26480a6065f2dc8 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/implementationClassName.rst @@ -0,0 +1,34 @@ +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + No + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + Textarea: + implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Classname which implements the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/properties/containerClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/properties/containerClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..1a0758a653f705620b30e1da2481c2319444b289 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/properties/containerClassAttribute.rst @@ -0,0 +1,37 @@ +properties.containerClassAttribute +---------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.properties.containerClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Textarea: + properties: + containerClassAttribute: input + elementClassAttribute: xxlarge + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is typically wrapped around the form elements. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/properties/elementClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/properties/elementClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..260dce894d8e21ffd99ddd2c54d16a3cf9fa8817 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/properties/elementClassAttribute.rst @@ -0,0 +1,37 @@ +properties.elementClassAttribute +-------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.properties.elementClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + Textarea: + properties: + containerClassAttribute: input + elementClassAttribute: xxlarge + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class written to the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/properties/elementErrorClassAttribute.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/properties/elementErrorClassAttribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..94eaf29d17adc0688d4fe8bf7944f217c1563342 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/Textarea/properties/elementErrorClassAttribute.rst @@ -0,0 +1,37 @@ +properties.elementErrorClassAttribute +------------------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Textarea.properties.elementErrorClassAttribute + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Overwritable within form definition` + Yes + +:aspect:`form editor can write this property into the form definition (for prototype 'standard')` + No + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 5 + + Textarea: + properties: + containerClassAttribute: input + elementClassAttribute: xxlarge + elementErrorClassAttribute: error + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + A CSS class which is written to the form element if validation errors exists. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formEngine/Index.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formEngine/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..78db186cb55028ab1cdb8550a4eca43a4262292f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formEngine/Index.rst @@ -0,0 +1,45 @@ +.. include:: ../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formengine: + +============ +[formEngine] +============ + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formengine-properties: + +Properties +========== + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.formengine.translationfile: + +translationFile +--------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formEngine.translationFile + +:aspect:`Data type` + string/ array + +:aspect:`Needed by` + Backend (plugin) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + formEngine: + translationFile: 'EXT:form/Resources/Private/Language/Database.xlf' + +:aspect:`Good to know` + - :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>` + +:aspect:`Description` + Filesystem path(s) to translation files which should be searched for form plugin translations. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/Index.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..fcb13dfeabce27707f2a3583a4f2a86fe33dce24 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/Index.rst @@ -0,0 +1,292 @@ +.. include:: ../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition: + +====================== +[validatorsDefinition] +====================== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.*: + +[validatorsDefinition] +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + .. code-block:: yaml + :linenos: + + prototypes: + <prototypeIdentifier>: + validatorsDefinition: + [...] + +:aspect:`Good to know` + - :ref:`"Custom validator implementations"<concepts-frontendrendering-codecomponents-customvalidatorimplementations>` + +:aspect:`Description` + Array which defines the available serverside validators. Every key within this array is called the ``<validatoridentifier>``. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.<validatoridentifier>: + +<validatorIdentifier> +--------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.<validatorIdentifier> + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + + prototypes: + standard: + NotEmpty: + [...] + DateTime: + [...] + Alphanumeric: + [...] + Text: + [...] + StringLength: + [...] + EmailAddress: + [...] + Integer: + [...] + Float: + [...] + NumberRange: + [...] + RegularExpression: + [...] + Count: + [...] + +:aspect:`Related options` + - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.\<formElementTypeIdentifier>.formEditor.propertyCollections.validators.[*].identifier"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.propertycollections.validators.*.identifier>` + - :ref:`"[ValidatorsEditor] selectOptions.[*].value"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.selectoptions.*.value-validatorseditor>` + - :ref:`"[RequiredValidatorEditor] validatorIdentifier"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.validatoridentifier-requiredvalidatoreditor>` + +:aspect:`Good to know` + - :ref:`"Custom validator implementations"<concepts-frontendrendering-codecomponents-customvalidatorimplementations>` + +:aspect:`Description` + This array key identifies a validator. This identifier could be used to attach a validator to a form element. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.<validatoridentifier>-commonproperties: + +Common <validatorIdentifier> properties +======================================= + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.validatorsdefinition.<validatoridentifier>.implementationClassName: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.<validatorIdentifier>.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + Depends (see :ref:`concrete validators configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Custom validator implementations"<concepts-frontendrendering-codecomponents-customvalidatorimplementations>` + +:aspect:`Description` + .. include:: properties/implementationClassName.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.validatorsdefinition.<validatoridentifier>.options: + +options +------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.<validatorIdentifier>.options + +:aspect:`Data type` + array + +:aspect:`Needed by` + Frontend/ Backend (form editor) + +:aspect:`Mandatory` + Depends (see :ref:`concrete validators configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>-concreteconfigurations>`) + +:aspect:`Default value` + Depends (see :ref:`concrete validators configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Custom validator implementations"<concepts-frontendrendering-codecomponents-customvalidatorimplementations>` + +:aspect:`Description` + Array with validator options. + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.validatorsdefinition.<validatoridentifier>.formeditor: + +formEditor +---------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.<validatorIdentifier>.formEditor + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Recommended + +:aspect:`Default value` + Depends (see :ref:`concrete validators configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>-concreteconfigurations>`) + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + Array with configurations for the ``form editor`` + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.validatorsdefinition.<validatoridentifier>.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.<validatorIdentifier>.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + Depends (see :ref:`concrete validators configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>-concreteconfigurations>`) + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.validatorsdefinition.<validatoridentifier>.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.<validatorIdentifier>.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value` + Depends (see :ref:`concrete validators configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>-concreteconfigurations>`) + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: properties/label.rst + + +.. _typo3.cms.form.prototypes.<prototypeIdentifier>.validatorsdefinition.<validatoridentifier>.formeditor.predefineddefaults: + +formeditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.<validatorIdentifier>.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value` + Depends (see :ref:`concrete validators configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>-concreteconfigurations>`) + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: properties/predefinedDefaults.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.<validatoridentifier>-concreteconfigurations: + +Concrete configurations +======================= + +.. toctree:: + + validators/Alphanumeric + validators/Count + validators/DateTime + validators/EmailAddress + validators/Float + validators/Integer + validators/NotEmpty + validators/NumberRange + validators/RegularExpression + validators/StringLength + validators/Text diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/properties/iconIdentifier.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/properties/iconIdentifier.rst new file mode 100644 index 0000000000000000000000000000000000000000..8284530e2ef07ff5bd27c54b8cacd50d8662e85a --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/properties/iconIdentifier.rst @@ -0,0 +1,2 @@ +An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``. +This icon will be shown within the - :ref:`"Inspector [CollectionElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` if the validator is selected. diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/properties/implementationClassName.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/properties/implementationClassName.rst new file mode 100644 index 0000000000000000000000000000000000000000..60f3d0b2062ca509c315ad44cb6f6581bd72ab47 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/properties/implementationClassName.rst @@ -0,0 +1 @@ +Classname which implements the validator. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/properties/label.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/properties/label.rst new file mode 100644 index 0000000000000000000000000000000000000000..758c71d1d0494aafecd3f1a5197eef150dc5175f --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/properties/label.rst @@ -0,0 +1 @@ +This label will be shown within the - :ref:`"Inspector [CollectionElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` if the validator is selected. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/properties/predefinedDefaults.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/properties/predefinedDefaults.rst new file mode 100644 index 0000000000000000000000000000000000000000..4b30701c1526e85361961adc8d3619af5e3ab4e7 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/properties/predefinedDefaults.rst @@ -0,0 +1 @@ +Defines predefined defaults for validator options which are prefilled, if the validator is added to a form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/Alphanumeric.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/Alphanumeric.rst new file mode 100644 index 0000000000000000000000000000000000000000..f468c046f5531a7d55ba3cb61b0912f599c9e6b3 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/Alphanumeric.rst @@ -0,0 +1,122 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.alphanumeric: + +============== +[Alphanumeric] +============== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.alphanumeric-validationerrorcodes: + +validation error codes +====================== + +- 1221551320 + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.alphanumeric-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.alphanumeric.implementationClassName: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.Alphanumeric.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + Alphanumeric: + implementationClassName: TYPO3\CMS\Extbase\Validation\Validator\AlphanumericValidator + +:aspect:`Good to know` + - :ref:`"Custom validator implementations"<concepts-frontendrendering-codecomponents-customvalidatorimplementations>` + +:aspect:`Description` + .. include:: ../properties/implementationClassName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.alphanumeric.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.Alphanumeric.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Alphanumeric: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.Alphanumeric.label + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.alphanumeric.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.Alphanumeric.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + Alphanumeric: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.Alphanumeric.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: ../properties/label.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/Count.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/Count.rst new file mode 100644 index 0000000000000000000000000000000000000000..207b12eb5255b08775d2c8404f54dcb950b437c1 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/Count.rst @@ -0,0 +1,207 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.validatorsdefinition.count: + +======= +[Count] +======= + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.count-validationerrorcodes: + +validation error codes +====================== + +- 1475002976 +- 1475002994 + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.count-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.count.implementationClassName: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.Count.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + Count: + implementationClassName: TYPO3\CMS\Form\Mvc\Validation\CountValidator + +:aspect:`Good to know` + - :ref:`"Custom validator implementations"<concepts-frontendrendering-codecomponents-customvalidatorimplementations>` + +:aspect:`Description` + .. include:: ../properties/implementationClassName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.count.options.minimum: + +options.minimum +--------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.Count.options.minimum + +:aspect:`Data type` + int + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + undefined + +:aspect:`Description` + The minimum count to accep. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.count.options.maximum: + +options.maximum +--------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.Count.options.maximum + +:aspect:`Data type` + int + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + undefined + +:aspect:`Description` + The maximum count to accep. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.count.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.Count.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Count: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.MultiSelectionMixin.validators.Count.editor.header.label + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.count.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.Count.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + Count: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.MultiSelectionMixin.validators.Count.editor.header.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: ../properties/label.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.count.formeditor.predefineddefaults: + +formeditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.Count.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + Count: + formEditor: + predefinedDefaults: + options: + minimum: '' + maximum: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/predefinedDefaults.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/DateTime.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/DateTime.rst new file mode 100644 index 0000000000000000000000000000000000000000..f294f47a2d295c38a0026c28703a7c29cc73d887 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/DateTime.rst @@ -0,0 +1,122 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.datetime: + +========== +[DateTime] +========== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.datetime-validationerrorcodes: + +validation error codes +====================== + +- 1238087674 + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.datetime-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.datetime.implementationClassName: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.DateTime.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + DateTime: + implementationClassName: TYPO3\CMS\Extbase\Validation\Validator\DateTimeValidator + +:aspect:`Good to know` + - :ref:`"Custom validator implementations"<concepts-frontendrendering-codecomponents-customvalidatorimplementations>` + +:aspect:`Description` + .. include:: ../properties/implementationClassName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.datetime.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.DateTime.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + DateTime: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.DatePicker.validators.DateTime.editor.header.label + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.datetime.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.DateTime.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + DateTime: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.DatePicker.validators.DateTime.editor.header.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: ../properties/label.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/EmailAddress.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/EmailAddress.rst new file mode 100644 index 0000000000000000000000000000000000000000..30db13b679a7aec4b0464107fde0e6593b7e1378 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/EmailAddress.rst @@ -0,0 +1,125 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.validatorsdefinition.emailaddress: + +============== +[EmailAddress] +============== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.emailaddress-validationerrorcodes: + +validation error codes +====================== + +- 1221559976 + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.emailaddress-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.emailaddress.implementationClassName: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.EmailAddress.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + EmailAddress: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.EmailAddress.label + +:aspect:`Good to know` + - :ref:`"Custom validator implementations"<concepts-frontendrendering-codecomponents-customvalidatorimplementations>` + +:aspect:`Description` + .. include:: ../properties/implementationClassName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.emailaddress.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.EmailAddress.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + EmailAddress: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.EmailAddress.label + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.emailaddress.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.EmailAddress.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + EmailAddress: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.EmailAddress.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: ../properties/label.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/Float.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/Float.rst new file mode 100644 index 0000000000000000000000000000000000000000..ae6d04c2f6f7ef962006af21fe9e3f454dea3c08 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/Float.rst @@ -0,0 +1,122 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.validatorsdefinition.float: + +======= +[Float] +======= + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.float-validationerrorcodes: + +validation error codes +====================== + +- 1221560288 + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.float-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.float.implementationClassName: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.Float.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + Float: + implementationClassName: TYPO3\CMS\Extbase\Validation\Validator\FloatValidator + +:aspect:`Good to know` + - :ref:`"Custom validator implementations"<concepts-frontendrendering-codecomponents-customvalidatorimplementations>` + +:aspect:`Description` + .. include:: ../properties/implementationClassName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.float.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.Float.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Float: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.Float.label + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.float.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.Float.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + Float: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.Float.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: ../properties/label.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/Integer.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/Integer.rst new file mode 100644 index 0000000000000000000000000000000000000000..97c26eac5a197bc3b8d36a91dd415fe00a195a33 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/Integer.rst @@ -0,0 +1,122 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.validatorsdefinition.integer: + +========= +[Integer] +========= + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.integer-validationerrorcodes: + +validation error codes +====================== + +- 1221560494 + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.integer-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.integer.implementationClassName: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.Integer.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + Integer: + implementationClassName: TYPO3\CMS\Extbase\Validation\Validator\IntegerValidator + +:aspect:`Good to know` + - :ref:`"Custom validator implementations"<concepts-frontendrendering-codecomponents-customvalidatorimplementations>` + +:aspect:`Description` + .. include:: ../properties/implementationClassName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.integer.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.Integer.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Integer: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.Integer.label + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.integer.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.Integer.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + Integer: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.Integer.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: ../properties/label.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/NotEmpty.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/NotEmpty.rst new file mode 100644 index 0000000000000000000000000000000000000000..20db7fc82ba99f614503c1fe9202207b26bf1387 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/NotEmpty.rst @@ -0,0 +1,125 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.notempty: + +========== +[NotEmpty] +========== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.notempty-validationerrorcodes: + +validation error codes +====================== + +- 1221560910 +- 1221560718 +- 1347992400 +- 1347992453 + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.notempty-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.notempty.implementationClassName: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.NotEmpty.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + NotEmpty: + implementationClassName: TYPO3\CMS\Extbase\Validation\Validator\NotEmptyValidator + +:aspect:`Good to know` + - :ref:`"Custom validator implementations"<concepts-frontendrendering-codecomponents-customvalidatorimplementations>` + +:aspect:`Description` + .. include:: ../properties/implementationClassName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.notempty.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.NotEmpty.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + NotEmpty: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.FormElement.editor.requiredValidator.label + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.notempty.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.NotEmpty.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + NotEmpty: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.FormElement.editor.requiredValidator.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: ../properties/label.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/NumberRange.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/NumberRange.rst new file mode 100644 index 0000000000000000000000000000000000000000..c2d5d1a64a8c883309f95ef34027c7a6f0fc6300 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/NumberRange.rst @@ -0,0 +1,207 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.validatorsdefinition.numberrange: + +============= +[NumberRange] +============= + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.numberrange-validationerrorcodes: + +validation error codes +====================== + +- 1221563685 +- 1221561046 + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.numberrange-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.numberrange.implementationClassName: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.NumberRange.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + NumberRange: + implementationClassName: TYPO3\CMS\Extbase\Validation\Validator\NumberRangeValidator + +:aspect:`Good to know` + - :ref:`"Custom validator implementations"<concepts-frontendrendering-codecomponents-customvalidatorimplementations>` + +:aspect:`Description` + .. include:: ../properties/implementationClassName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.numberrange.options.minimum: + +options.minimum +--------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.NumberRange.options.minimum + +:aspect:`Data type` + int + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + undefined + +:aspect:`Description` + The minimum value to accep. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.numberrange.options.maximum: + +options.maximum +--------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.NumberRange.options.maximum + +:aspect:`Data type` + int + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + undefined + +:aspect:`Description` + The maximum value to accep. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.numberrange.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.NumberRange.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + NumberRange: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.NumberRange.label + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.numberrange.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.NumberRange.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + NumberRange: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.NumberRange.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: ../properties/label.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.numberrange.formeditor.predefineddefaults: + +formeditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.NumberRange.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + NumberRange: + formEditor: + predefinedDefaults: + options: + minimum: '' + maximum: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/predefinedDefaults.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/RegularExpression.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/RegularExpression.rst new file mode 100644 index 0000000000000000000000000000000000000000..a9c989d538ccd29cc958640b37b19df37660ec58 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/RegularExpression.rst @@ -0,0 +1,181 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.validatorsdefinition.regularexpression: + +=================== +[RegularExpression] +=================== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.regularexpression-validationerrorcodes: + +validation error codes +====================== + +- 1221565130 + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.regularexpression-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.regularexpression.implementationClassName: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.RegularExpression.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + RegularExpression: + implementationClassName: TYPO3\CMS\Extbase\Validation\Validator\RegularExpressionValidator + +:aspect:`Good to know` + - :ref:`"Custom validator implementations"<concepts-frontendrendering-codecomponents-customvalidatorimplementations>` + +:aspect:`Description` + .. include:: ../properties/implementationClassName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.regularexpression.options.regularExpression: + +options.regularExpression +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.RegularExpression.options.regularExpression + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + undefined + +:aspect:`Description` + The regular expression to use for validation, used as given. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.regularexpression.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.RegularExpression.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + RegularExpression: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.RegularExpression.label + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.regularexpression.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.RegularExpression.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + RegularExpression: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.RegularExpression.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: ../properties/label.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.regularexpression.formeditor.predefineddefaults: + +formeditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.RegularExpression.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + RegularExpression: + formEditor: + predefinedDefaults: + options: + regularExpression: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/predefinedDefaults.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/StringLength.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/StringLength.rst new file mode 100644 index 0000000000000000000000000000000000000000..fcbac4b16b6298ce926be1bf21206f40a6fc64a6 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/StringLength.rst @@ -0,0 +1,210 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.validatorsdefinition.stringlength: + +============== +[StringLength] +============== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.stringlength-validationerrorcodes: + +validation error codes +====================== + +- 1238110957 +- 1269883975 +- 1428504122 +- 1238108068 +- 1238108069 + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.stringlength-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.stringlength.implementationClassName: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.StringLength.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + StringLength: + implementationClassName: TYPO3\CMS\Extbase\Validation\Validator\StringLengthValidator + +:aspect:`Good to know` + - :ref:`"Custom validator implementations"<concepts-frontendrendering-codecomponents-customvalidatorimplementations>` + +:aspect:`Description` + .. include:: ../properties/implementationClassName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.stringlength.options.minimum: + +options.minimum +--------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.StringLength.options.minimum + +:aspect:`Data type` + int + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + undefined + +:aspect:`Description` + The minimum value to accep. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.stringlength.options.maximum: + +options.maximum +--------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.StringLength.options.maximum + +:aspect:`Data type` + int + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + undefined + +:aspect:`Description` + The maximum value to accep. + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.stringlength.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.StringLength.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + StringLength: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.StringLength.label + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.stringlength.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.StringLength.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + StringLength: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.StringLength.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: ../properties/label.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.stringlength.formeditor.predefineddefaults: + +formeditor.predefinedDefaults +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.StringLength.formEditor.predefinedDefaults + +:aspect:`Data type` + array + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + No + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3- + + StringLength: + formEditor: + predefinedDefaults: + options: + minimum: '' + maximum: '' + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/predefinedDefaults.rst diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/Text.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/Text.rst new file mode 100644 index 0000000000000000000000000000000000000000..20c66cd7a2431af180c8ca453b78cd520a985d60 --- /dev/null +++ b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/validatorsDefinition/validators/Text.rst @@ -0,0 +1,122 @@ +.. include:: ../../../../Includes.txt + + +.. _typo3.cms.form.prototypes.validatorsdefinition.text: + +====== +[Text] +====== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.text-validationerrorcodes: + +validation error codes +====================== + +- 1221565786 + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.text-properties: + +Properties +========== + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.text.implementationClassName: + +implementationClassName +----------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.Text.implementationClassName + +:aspect:`Data type` + string + +:aspect:`Needed by` + Frontend + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 2 + + Text: + implementationClassName: TYPO3\CMS\Extbase\Validation\Validator\TextValidator + +:aspect:`Good to know` + - :ref:`"Custom validator implementations"<concepts-frontendrendering-codecomponents-customvalidatorimplementations>` + +:aspect:`Description` + .. include:: ../properties/implementationClassName.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.text.formeditor.iconidentifier: + +formeditor.iconIdentifier +------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.Text.formEditor.iconIdentifier + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + Text: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.Text.label + +.. :aspect:`Good to know` + ToDo + +:aspect:`Description` + .. include:: ../properties/iconIdentifier.rst + + +.. _typo3.cms.form.prototypes.<prototypeidentifier>.validatorsdefinition.text.formeditor.label: + +formeditor.label +---------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition.Text.formEditor.label + +:aspect:`Data type` + string + +:aspect:`Needed by` + Backend (form editor) + +:aspect:`Mandatory` + Yes + +:aspect:`Default value (for prototype 'standard')` + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + Text: + formEditor: + iconIdentifier: t3-form-icon-validator + label: formEditor.elements.TextMixin.editor.validators.Text.label + +:aspect:`Good to know` + - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>` + +:aspect:`Description` + .. include:: ../properties/label.rst diff --git a/typo3/sysext/form/Documentation/FAQ/Index.rst b/typo3/sysext/form/Documentation/FAQ/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..264076710ef8f7a49837fbd88cfc57b4032c73e7 --- /dev/null +++ b/typo3/sysext/form/Documentation/FAQ/Index.rst @@ -0,0 +1,153 @@ +.. include:: ../Includes.txt + + +.. _faq: + +=== +FAQ +=== + + +.. _faq-override-frontend-templates: + +How do I override the frontend templates? +========================================= + +There are 2 possible ways to override the frontend templates. + + +Globally extend the fluid search paths +-------------------------------------- + +Since EXT:form mainly uses YAML as configuration language you need to +register your own additional YAML files. Let us assume you are using a +sitepackage ``EXT:my_site_package`` which contains your whole frontend +integration. + + +EXT:my_site_package/Configuration/TypoScript/setup.txt +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +First of all, register a new EXT:form configuration for the frontend via +TypoScript. + +.. code-block:: typoscript + + plugin.tx_form { + settings { + yamlConfigurations { + # register your own additional configuration + # choose a number higher than 30 (below is reserved) + 100 = EXT:my_site_package/Configuration/Yaml/CustomFormSetup.yaml + } + } + } + + +EXT:my_site_package/Configuration/Yaml/CustomFormSetup.yaml +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Next, define the additional fluid template search paths via YAML. + +.. code-block:: yaml + + TYPO3: + CMS: + Form: + prototypes: + standard: + formElementsDefinition: + Form: + renderingOptions: + templateRootPaths: + 20: 'EXT:my_site_package/Resources/Private/Form/Frontend/Templates/' + partialRootPaths: + 20: 'EXT:my_site_package/Resources/Private/Form/Frontend/Partials/' + layoutRootPaths: + 20: 'EXT:my_site_package/Resources/Private/Form/Frontend/Layouts/' + +.. note:: + The preview within the form editor (backend module) uses the frontend + templates as well. If you want the preview to show your customized + templates, register the new paths for the backend module as well. + + +EXT:my_site_package/ext_typoscript_setup.txt +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Register your EXT:form configuration for the backend via TypoScript. Read +the :ref:`chapter <concepts-configuration-yamlregistration-backend>` to +learn why we recommend using the concept behind ``ext_typoscript_setup.txt``. + +.. code-block:: typoscript + + module.tx_form { + settings { + yamlConfigurations { + 100 = EXT:my_site_package/Configuration/Yaml/CustomFormSetup.yaml + } + } + } + + +.. _faq-migrate-from-v7: + +How do I migrate from EXT:form v7? +================================== + +The old form extension (used in TYPO3 v7, which is compatible to TYPO3 v6) +was moved into an own extension called ``form_legacy``. This extension can +be found within the official `TER <https://typo3.org/extensions/repository/view/form_legacy>`_. +When upgrading to TYPO3 v8 an upgrade wizard will tell you if form_legacy is +still needed. + + +.. _faq-frontend-validation: + +Is there a frontend validation? +=============================== + +Yes, an HTML 5 based frontend validation is implemented. Nevertheless, +there is no JavaScript validation. This has to be integrated manually. +Reliable and maintained projects are `Parsley <https://github.com/guillaumepotier/Parsley.js>`_ +and `jQuery Validation <https://github.com/jquery-validation/jquery-validation>`_. + + +.. _faq-localize-client-side-validations: + +How do I localize the client side validations in the frontend? +============================================================== + +The displayed validation message is a browser specific text. The output is +not generated by TYPO3 and therefore you cannot change it easily. +Nevertheless, there is a JavaScript solution for changing the validation +message. See `Stack Overflow <http://stackoverflow.com/questions/5272433/html5-form-required-attribute-set-custom-validation-message>`_ +for more information. + + +.. _faq-date-picker: + +How does the date picker work? +============================== + +EXT:form ships a datepicker form element. To unfold its full potential you +should add jquery JavaScript files and jqueryUi JavaScript and CSS files to +your frontend. + + +.. _faq-user-registration: + +Is it possible to build a frontend user registration with EXT:form? +=================================================================== + +Possible, yes. But we are not aware of an integration. + + +.. _faq-export-module: + +Is there some kind of export module for saved forms? +==================================================== + +Currently, there are no plans to implement such a feature. There are huge +concerns regarding the data privacy when it comes to storing user data in +your TYPO3 database permanently. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/Images/basic_code_components.png b/typo3/sysext/form/Documentation/Images/basic_code_components.png new file mode 100644 index 0000000000000000000000000000000000000000..7e6612f9d21bedc1a42ca1359bf3b2e96787ed41 Binary files /dev/null and b/typo3/sysext/form/Documentation/Images/basic_code_components.png differ diff --git a/typo3/sysext/form/Documentation/Images/form_manager.png b/typo3/sysext/form/Documentation/Images/form_manager.png new file mode 100644 index 0000000000000000000000000000000000000000..d2352c73c75711d79e4d69c2bba2968327a408b0 Binary files /dev/null and b/typo3/sysext/form/Documentation/Images/form_manager.png differ diff --git a/typo3/sysext/form/Documentation/Images/introduction_form_editor.png b/typo3/sysext/form/Documentation/Images/introduction_form_editor.png new file mode 100644 index 0000000000000000000000000000000000000000..6ed471625139e352cf6de5e827eebc0775d5b522 Binary files /dev/null and b/typo3/sysext/form/Documentation/Images/introduction_form_editor.png differ diff --git a/typo3/sysext/form/Documentation/Images/javascript_module_interaction.png b/typo3/sysext/form/Documentation/Images/javascript_module_interaction.png new file mode 100644 index 0000000000000000000000000000000000000000..1b133d67d7ef418a487a4e4e1bdea4821100ef10 Binary files /dev/null and b/typo3/sysext/form/Documentation/Images/javascript_module_interaction.png differ diff --git a/typo3/sysext/form/Documentation/Includes.txt b/typo3/sysext/form/Documentation/Includes.txt new file mode 100644 index 0000000000000000000000000000000000000000..a7ddd8f2479dfa66d6a91f73625169fb564ef93d --- /dev/null +++ b/typo3/sysext/form/Documentation/Includes.txt @@ -0,0 +1,13 @@ +.. This is 'Includes.txt'. It is included at the very top of each and + every ReST source file in THIS documentation project (= manual). + +.. role:: aspect (emphasis) +.. role:: html(code) +.. role:: js(code) +.. role:: php(code) +.. role:: typoscript(code) +.. role:: ts(typoscript) + :class: typoscript + +.. highlight:: php +.. default-role:: code \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/Index.rst b/typo3/sysext/form/Documentation/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..d7e632afbdeede2c8953876fc3620762c70c60b6 --- /dev/null +++ b/typo3/sysext/form/Documentation/Index.rst @@ -0,0 +1,55 @@ +.. include:: Includes.txt + + +.. _Start: + +==== +Form +==== + + +:Extension key: + form + +:Version: + 8 + +:Language: + en + +:Description: + Form framework, form editor and plugin + + +:Keywords: + form + +:Copyright: + 2000-2017 + +:Author: + TRITUM GmbH + +:License: + Open Content License available from `www.opencontent.org/openpub/ + <http://www.opencontent.org/openpub/>`_ + +:Rendered: + |today| + +The content of this document is related to TYPO3, + +a GNU/GPL CMS/Framework available from `www.typo3.org +<https://www.typo3.org/>`_ + + + +**Table of Contents** + +.. toctree:: + + Introduction/Index + Concepts/Index + ConfigurationReference/Index + ApiReference/Index + FAQ/Index \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/Introduction/Index.rst b/typo3/sysext/form/Documentation/Introduction/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..15bfb6500d0a4c0a56220d7a95d1d866c41544fe --- /dev/null +++ b/typo3/sysext/form/Documentation/Introduction/Index.rst @@ -0,0 +1,86 @@ +.. include:: ../Includes.txt + + +.. _introduction: + +============ +Introduction +============ + +.. note:: + This documentation will be extended on a constant basis. If you have + problems understanding a certain aspect, or if you notice something + missing, contribute to improve it. This will help you and everyone else! + + Get in touch with us: + + - Find us on `Slack <https://typo3.slack.com>`_ and join the channel + ``#ext:form``. + - Use the "Edit me on Github" function. + + +.. _what-does-it-do: + +What does it do? +---------------- + +The ``form`` extension acts as a flexible, extendible, yet easy to use form +framework. It equally allows editors, integrators, and developers to build +all types of forms. For this task, different interfaces and techniques are +available. + +As a non-technical editor, you can use the "Forms" backend module. It +allows you to create and manage your individual forms with the help of a +nifty drag and drop interface. Your work can be previewed instantly. + +As an experienced integrator, you are able to build ambitious forms which +are stored directly in your site package. Those forms can utilize hefty +finishers and ship localization files. + +As a developer, you can use the PHP API to forge interfaces with conditional +form elements, register new validators and finishers, as well as create +custom form elements. Plenty of hooks allow you to manipulate the generation +and processing of the both form and data. + +.. figure:: ../Images/introduction_form_editor.png + :alt: The form creation wizard + + Form editor displaying a new form in the abstract view + + +Features List +------------- + +The following list names some features of the form framework: + +* form editor + * fully customisable editor for building complex forms + * replaceable and extendible form editor components + * JS API to extend form editor +* PHP API + * entire forms via API + * own renderers for form and/ or form elements + * conditional steps, form elements and validators based on other form + elements +* configuration + * YAML as configuration and definition language including inheritances + and overrides + * file based + * behaviour and design of the frontend, plugin, and form editor can be + adapted on a per form basis + * 'prototypes' can be used as boilerplate +* form elements + * own form elements possible + * uploads handled as FAL objects +* finishers + * ships a bunch of built-in finishers, like email, redirect, and save to + database + * own finishers possible + * finisher configuration can be overridden within the form plugin +* validators + * own validators possible +* miscellaneous + * multiple language support + * multiple step support + * multiple forms on one page + * built-in spam protection (honeypot) \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/Settings.cfg b/typo3/sysext/form/Documentation/Settings.cfg new file mode 100644 index 0000000000000000000000000000000000000000..2c04e0d473a3e8593793a76644084476f9ee51cc --- /dev/null +++ b/typo3/sysext/form/Documentation/Settings.cfg @@ -0,0 +1,18 @@ +[general] + +project = Form Framework +version = 8 +release = 8 +t3author = TRITUM GmbH +copyright = 1997-2017 + +description = This is the documentation of TYPO3's system + extension 'form'. This extension implements a very. + flexible form framework. It ships the "Forms" backend + module and a plugin. + + +[html_theme_options] + +project_issues = https://forge.typo3.org/projects/typo3cms-core/issues +project_repository = https://git.typo3.org/Packages/TYPO3.CMS.git \ No newline at end of file