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.

List widget with four list items — A list widget showing the items returned by its 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.

itemsPerPage

Type: integer
Default: 10

Number of items shown at once. Only used if the data provider implements the PaginatedListDataProviderInterface.

Backend users can change the value in the widget settings, unless the option is set in the widget registration. In that case the value is fixed.

Dependencies

$dataProvider

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

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

If the data provider implements the PaginatedListDataProviderInterface instead, the widget renders a paginator in its footer and requests the items of the current page from the returned paginator.