---
title: "List Widget"
manual: "Dashboard"
version: "main"
permalink: "https://docs.typo3.org/permalink/typo3/cms-dashboard:list-widget@main"
source: "Widgets/ListWidget.rst"
rendered: "2026-09-30T05:15:21+00:00"
---

# List Widget {#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](../Images/Widgets/ListWidget.png)

## Example {#list-widget-example}

**Excerpt from EXT:dashboard/Configuration/Services.yaml**

```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 {#list-widget-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 {#list-widget-dependencies}

-   **$dataProvider**

    -   *Type:* `\TYPO3\CMS\Dashboard\Widgets\NumberWithIconDataProviderInterface`

    This class should provide the items to show.
    This data provider needs to implement the
    `\TYPO3\CMS\Dashboard\Widgets\NumberWithIconDataProviderInterface`.