List Widget

class ListWidget

Fully qualified name: \TYPO3\CMS\Dashboard\Widgets\ListWidget

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

Example

Excerpt from EXT:dashboard/Configuration/Services.yaml

services:
  dashboard.widget.testList:
    class: 'TYPO3\CMS\Dashboard\Widgets\ListWidget'
    arguments:
      $dataProvider: '@Vendor\Ext\Widgets\Provider\TestListWidgetDataProvider'
      $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'

Options

refreshAvailable

Type: boolean
Default: false

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

Type: \TYPO3\CMS\Dashboard\Widgets\ListDataProviderInterface

This class should provide the items to show. This data provider needs to implement the TYPO3CMSDashboardWidgetsListDataProviderInterface.