Number With Icon Widget

class NumberWithIconWidget

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

Widgets using this class will show a widget with a number, some additional text and an icon.

This kind of widgets are useful if you want to show some simple stats.

Number with icon widget with the number of failed backend logins — The widget "Failed backend logins" shipped with the dashboard extension is a number with icon widget.

Example

Excerpt from EXT:dashboard/Configuration/Services.yaml

services:
  dashboard.widget.failedLogins:
    class: 'TYPO3\CMS\Dashboard\Widgets\NumberWithIconWidget'
    arguments:
      $dataProvider: '@TYPO3\CMS\Dashboard\Widgets\Provider\NumberOfFailedLoginsDataProvider'
      $options:
        title: 'LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.failedLogins.title'
        subtitle: 'LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.failedLogins.subtitle'
        icon: 'content-elements-login'
        refreshAvailable: true
    tags:
      - name: dashboard.widget
        identifier: 'failedLogins'
        groupNames: 'systemInfo'
        title: 'LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.failedLogins.title'
        description: 'LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.failedLogins.description'
        iconIdentifier: 'content-widget-number'

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.

title

Type: string
Example: LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.failedLogins.title

The main title that will be shown in the widget as an explanation of the shown number. You can either enter a normal string or a translation string.

subtitle

Type: string
Example: LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.failedLogins.subtitle

The optional subtitle that will give some additional information about the number and title. You can either enter a normal string or a translation string.

icon

Type: string

The icon-identifier of the icon that should be shown in the widget. You should register your icon with the Icon API.

Dependencies

$dataProvider

Type: \TYPO3\CMS\Dashboard\Widgets\NumberWithIconDataProviderInterface

This class should provide the number to show. This data provider needs to implement the NumberWithIconDataProviderInterface.