.. include:: /Includes.rst.txt .. _typo3.cms.form.prototypes..formeditor: ============ [formEditor] ============ .. _typo3.cms.form.prototypes..formeditor-properties: Properties ========== .. _typo3.cms.form.prototypes..formeditor.translationfiles: translationFiles ---------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..formeditor.translationFiles :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: translationFiles: 10: 'EXT:form/Resources/Private/Language/Database.xlf' :aspect:`Good to know` - :ref:`"Translate form editor settings"` :aspect:`Description` Filesystem path(s) to translation files which should be searched for form editor translations. .. _typo3.cms.form.prototypes..formeditor.dynamicrequirejsmodules.app: dynamicRequireJsModules.app --------------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..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"` :aspect:`Description` RequireJS path for the form editor JavaScript app. .. _typo3.cms.form.prototypes..formeditor.dynamicrequirejsmodules.mediator: dynamicRequireJsModules.mediator -------------------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..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"` :aspect:`Description` RequireJS path for the form editor JavaScript mediator. .. _typo3.cms.form.prototypes..formeditor.dynamicrequirejsmodules.viewmodel: dynamicRequireJsModules.viewModel --------------------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..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"` :aspect:`Description` RequireJS path for the form editor JavaScript view model. .. _typo3.cms.form.prototypes..formeditor.dynamicrequirejsmodules.additionalviewmodelmodules: dynamicRequireJsModules.additionalViewModelModules -------------------------------------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..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"` - :ref:`"Register custom JavaScript modules"` :aspect:`Description` Array with RequireJS paths for custom JavaScript modules. .. _typo3.cms.form.prototypes..formeditor.addinlinesettings: addInlineSettings ----------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..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"` :aspect:`Description` Adds Javascript Inline Setting. This will occur in TYPO3.settings - object. .. _typo3.cms.form.prototypes..formeditor.maximumundosteps: maximumUndoSteps ---------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..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: 2 formEditor: maximumUndoSteps: 10 :aspect:`Good to know` - :ref:`"Form editor"` :aspect:`Description` Define the maximum possible undo steps within the form editor. .. _typo3.cms.form.prototypes..formeditor.stylesheets: stylesheets ----------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..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"` :aspect:`Description` The CSS files to be used by the ``form editor``. .. _typo3.cms.form.prototypes..formeditor.formeditorfluidconfiguration: formEditorFluidConfiguration ---------------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..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"` - :ref:`"view/inspector/editor/insert/perform"` :aspect:`Description` Basic fluid template search path configurations. .. _typo3.cms.form.prototypes..formeditor.formeditorfluidconfiguration.templatepathandfilename: formEditorFluidConfiguration.templatePathAndFilename ---------------------------------------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..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"` :aspect:`Description` Internal setting. Template which render the inline HTML templates which are used by the form editor JavaScript. .. _typo3.cms.form.prototypes..formeditor.formeditorfluidconfiguration.partialrootpaths: formEditorFluidConfiguration.partialRootPaths --------------------------------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..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"` - :ref:`"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..formeditor.formeditorfluidconfiguration.layoutrootpaths: formEditorFluidConfiguration.layoutRootPaths -------------------------------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..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"` - :ref:`"view/inspector/editor/insert/perform"` :aspect:`Description` Internal setting. Array with fluid layout search paths. .. _typo3.cms.form.prototypes..formeditor.formeditorpartials: formEditorPartials ------------------ :aspect:`Option path` TYPO3.CMS.Form.prototypes..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-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 FormElement-Email: 'Stage/SimpleTemplate' FormElement-Telephone: 'Stage/SimpleTemplate' FormElement-Url: 'Stage/SimpleTemplate' FormElement-Number: 'Stage/SimpleTemplate' FormElement-Date: 'Stage/SimpleTemplate' 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-ValidationErrorMessageEditor: 'Inspector/ValidationErrorMessageEditor' Inspector-Typo3WinBrowserEditor: Inspector/Typo3WinBrowserEditor :aspect:`Good to know` - :ref:`"Form editor"` - :ref:`"Common Abstract view formelement templates"` - :ref:`"available inspector editors".formelementsdefinition.\.formEditor.editors-availableinspectoreditors>` - :ref:`"view/inspector/editor/insert/perform"` :aspect:`Description` Array with mappings for the inline HTML templates. The keys are identifiers which could be used within the JavaScript code. The values are partial paths, relative to :ref:`"TYPO3.CMS.Form.prototypes.\.formeditor.formEditorFluidConfiguration.partialRootPaths".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..formeditor.formelementpropertyvalidatorsdefinition: formElementPropertyValidatorsDefinition --------------------------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..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 FileSize: errorMessage: formEditor.formElementPropertyValidatorsDefinition.FileSize.label RFC3339FullDate: errorMessage: formEditor.formElementPropertyValidatorsDefinition.RFC3339FullDate.label :aspect:`Related options` - :ref:`"[TextEditor] propertyValidators".formelementsdefinition.\.formeditor.editors.*.propertyvalidators-texteditor>` - :ref:`"[Typo3WinBrowserEditor] propertyValidators".formelementsdefinition.\.formeditor.editors.*.propertyvalidators-typo3winbrowsereditor>` :aspect:`Good to know` - :ref:`"Form editor"` :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 an identifier. .. _typo3.cms.form.prototypes..formeditor.formelementpropertyvalidatorsdefinition..errormessage: formElementPropertyValidatorsDefinition..errorMessage --------------------------------------------------------------------------------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..formeditor.formElementPropertyValidatorsDefinition..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 FileSize: errorMessage: formEditor.formElementPropertyValidatorsDefinition.FileSize.label RFC3339FullDate: errorMessage: formEditor.formElementPropertyValidatorsDefinition.RFC3339FullDate.label :aspect:`Related options` - :ref:`"[TextEditor] propertyValidators".formelementsdefinition.\.formeditor.editors.*.propertyvalidators-texteditor>` - :ref:`"[Typo3WinBrowserEditor] propertyValidators".formelementsdefinition.\.formeditor.editors.*.propertyvalidators-typo3winbrowsereditor>` :aspect:`Good to know` - :ref:`"Form editor"` :aspect:`Description` The error message for an inspector editor property validator which is shown if the validation fails. .. _typo3.cms.form.prototypes..formeditor.formelementgroups: formElementGroups ----------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..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 html5: label: 'formEditor.formElementGroups.html5.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.\.formElementsDefinition.AdvancedPassword.formEditor.group".formelementsdefinition.advancedpassword.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.Checkbox.formEditor.group".formelementsdefinition.checkbox.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.ContentElement.formEditor.group".formelementsdefinition.contentelement.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.Date.formEditor.group".formelementsdefinition.date.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.DatePicker.formEditor.group".formelementsdefinition.datepicker.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.Email.formEditor.group".formelementsdefinition.email.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.Fieldset.formEditor.group".formelementsdefinition.fieldset.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.FileUpload.formEditor.group".formelementsdefinition.fileupload.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.GridRow.formEditor.group".formelementsdefinition.gridrow.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.Hidden.formEditor.group".formelementsdefinition.hidden.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.ImageUpload.formEditor.group".formelementsdefinition.imageupload.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.MultiCheckbox.formEditor.group".formelementsdefinition.multicheckbox.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.MultiSelect.formEditor.group".formelementsdefinition.multiselect.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.Number.formEditor.group".formelementsdefinition.number.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.Page.formEditor.group".formelementsdefinition.page.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.Password.formEditor.group".formelementsdefinition.password.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.RadioButton.formEditor.group".formelementsdefinition.radiobutton.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.SingleSelect.formEditor.group".formelementsdefinition.singleselect.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.StaticText.formEditor.group".formelementsdefinition.statictext.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.SummaryPage.formEditor.group".formelementsdefinition.summarypage.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.Telephone.formEditor.group".formelementsdefinition.telephone.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.Text.formEditor.group".formelementsdefinition.text.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.Textarea.formEditor.group".formelementsdefinition.textarea.formeditor.group>` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.Url.formEditor.group".formelementsdefinition.url.formeditor.group>` :aspect:`Good to know` - :ref:`"Form editor"` :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..formeditor.formelementgroups..label: formElementGroups..label ---------------------------------------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..formeditor.formElementGroups..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"` :aspect:`Description` The label for a group within the ``form editor`` "new Element" modal.