List Widget

class \TYPO3\CMS\Dashboard\Widgets\ ListWidget

Widgets using this class will show a simple list of items provided by a data provider.

Example

Configuration/Services.yaml:

services:

  dashboard.widget.testList:
    class: 'TYPO3\CMS\Dashboard\Widgets\ListWidget'
    arguments:
      $dataProvider: '@Vendor\Ext\Widgets\Provider\TestListWidgetDataProvider'
      $view: '@dashboard.views.widget'
      $options:
         refreshAvailable: true
    tags:
      - name: dashboard.widget
        identifier: 'testList'
        groupNames: 'general'
        title: 'List widget'
        description: 'Description of widget'
        iconIdentifier: 'content-widget-list'
        height: 'large'
        width: 'large'
Copied!

Options

refreshAvailable

Boolean value, either false or true.

Provides a refresh button to backend users to refresh the widget. If the option is omitted false is assumed.

Dependencies

$dataProvider

This class should provide the items to show.

<<<<<<< HEAD (a598d0 [TASK] Allow execution of acceptance tests with local chrome)
This data provider needs to implement the .
$view

Used to render a Fluidtemplate. This should not be changed. The default is to use the pre configured Fluid StandaloneView for EXT:dashboard.

See Using Fluid for further information.

This data provider needs to implement the ListDataProviderInterface.