Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
60 changes: 37 additions & 23 deletions Documentation/Global/Be/TableList.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:navigation-title: be.tableList
git :navigation-title: be.tableList

.. include:: /Includes.rst.txt
.. _typo3-fluid-be-tablelist:
Expand All @@ -7,40 +7,54 @@
Be.tableList ViewHelper `<f:be.tableList>`
==========================================

.. figure:: /Images/BeTablelistCategory.png
:alt: Screenshot of a table of categories.

.. typo3:viewhelper:: be.tableList
:source: ../../Global.json
:display: tags,description,gitHubLink,arguments
:display: tags,description,gitHubLink
:noindex:

.. contents:: Table of contents

.. _typo3-fluid-be-tablelist-example:

Examples
========

Minimal::
Display and make editable the content elements of page 1 and its direct children:

.. tabs::

.. group-tab:: Code example

.. literalinclude:: /Global/Be/_TableList/_Content.html
:caption: EXT:my_extension/Resources/Private/Backend/Templates/MyModule.html

.. group-tab:: Screenshot

<f:be.tableList tableName="fe_users" />
.. figure:: /Images/BeTablelist.png
:alt: Screenshot of a table of content elements with edit options.

List of all "Website user" records stored in the configured storage PID.
Records will be editable, if the current backend user has got edit rights for the table ``fe_users``.
List all categories on page 5 and make them editable when clicking the title:

Only the title column (username) will be shown.
.. tabs::

Context menu is active.
.. group-tab:: Code example

Full::
.. literalinclude:: /Global/Be/_TableList/_Category.html
:caption: EXT:my_extension/Resources/Private/Backend/Templates/MyModule.html

<f:be.tableList tableName="fe_users" fieldList="{0: 'name', 1: 'email'}"
storagePid="1"
levels="2"
filter="foo"
recordsPerPage="10"
sortField="name"
sortDescending="true"
readOnly="true"
enableClickMenu="false"
enableControlPanels="true"
clickTitleMode="info"
/>
.. group-tab:: Screenshot

List of "Website user" records with a text property of ``foo`` stored on PID ``1`` and two levels down.
Clicking on a username will open the TYPO3 info popup for the respective record
.. figure:: /Images/BeTablelistCategory.png
:alt: Screenshot of a table of categories.

.. _typo3-fluid-be-tablelist-arguments:

Arguments
=========

.. typo3:viewhelper:: be.tableList
:source: ../../Global.json
:display: arguments-only
6 changes: 6 additions & 0 deletions Documentation/Global/Be/_TableList/_Category.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<f:be.tableList
tableName="sys_category"
fieldList="{0: 'title', 1: 'parent'}"
storagePid="4"
clickTitleMode="edit"
/>
7 changes: 7 additions & 0 deletions Documentation/Global/Be/_TableList/_Content.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<f:be.tableList
tableName="tt_content"
fieldList="{0: 'header', 1: 'CType'}"
storagePid="1"
levels="2"
enableControlPanels="1"
/>
Binary file added Documentation/Images/BeTablelist.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Documentation/Images/BeTablelistCategory.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.