Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation for fieldControl -> rendertype #1204

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add documentation for fieldControl -> rendertype #1204

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions Documentation/ColumnsConfig/Type/Group/_Properties/_FieldControl.rst.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,16 @@

.. include:: /CodeSnippets/GroupDb1.rst.txt

.. confval:: renderType
:name: group-fieldControl-addRecord-renderType
:type: string
:Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']['addRecord']['renderType']
:Required: true
:Default: addRecord

Use a render type from core or your own. Custom render types can be
registered with the `NodeFactory <https://docs.typo3.org/permalink/t3coreapi:FormEngine-Rendering-NodeFactory>`_.

.. confval:: editPopup
:name: group-fieldControl-editPopup
:Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']
Expand All @@ -55,6 +65,16 @@

.. include:: /CodeSnippets/GroupDb1.rst.txt

.. confval:: renderType
:name: group-fieldControl-editPopup-renderType
:type: string
:Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']['editPopup']['renderType']
:Required: true
:Default: editPopup

Use a render type from core or your own. Custom render types can be
registered with the `NodeFactory <https://docs.typo3.org/permalink/t3coreapi:FormEngine-Rendering-NodeFactory>`_.

.. confval:: listModule
:name: group-fieldControl-listModule
:Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']
Expand All @@ -77,6 +97,16 @@

.. include:: /CodeSnippets/GroupDb1.rst.txt

.. confval:: renderType
:name: group-fieldControl-listModule-renderType
:type: string
:Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']['listModule']['renderType']
:Required: true
:Default: listModule

Use a render type from core or your own. Custom render types can be
registered with the `NodeFactory <https://docs.typo3.org/permalink/t3coreapi:FormEngine-Rendering-NodeFactory>`_.

.. confval:: elementBrowser
:name: group-fieldControl-elementBrowser
:Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']
Expand All @@ -88,13 +118,34 @@
button to open an element browser. It is enabled by default if rendering a
group element.

.. confval:: renderType
:name: group-fieldControl-elementBrowser-renderType
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this need to be all lowercase or not?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

name needs to be lowercase

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is that really true? I have found others to be in the same format.

:type: string
:Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']['elementBrowser']['renderType']
:Required: true
:Default: elementBrowser

Use a render type from the Core or an Extension. Custom render types can be
registered with the `NodeFactory <https://docs.typo3.org/permalink/t3coreapi:FormEngine-Rendering-NodeFactory>`_.
simonschaufi marked this conversation as resolved.
Show resolved Hide resolved
linawolf marked this conversation as resolved.
Show resolved Hide resolved


.. confval:: insertClipboard
:name: group-fieldControl-insertClipboard
:Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']
:type: array
:Scope: fieldControl
:Types: :ref:`group <columns-group>`

.. confval:: renderType
:name: group-fieldControl-insertClipboard-renderType
:type: string
:Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']['insertClipboard']['renderType']
:Required: true
:Default: insertClipboard

Use a render type from core or your own. Custom render types can be
registered with the `NodeFactory <https://docs.typo3.org/permalink/t3coreapi:FormEngine-Rendering-NodeFactory>`_.

The clipboard control adds a control button for :code:`type='group'` to paste records from
a users clipboard into the selection. It is enabled by default for :code:`type='group'` and
shown below the **element browser** if the
Expand Down