CTA Button Widget

Widgets using this class will show a CTA (=Call to action) button to easily go to a specific page or do a specific action. You can add a button to the widget by defining a button provider.

You can use this kind of widget to link to for example a manual or to an important website that is used a lot by the users.




    class: 'TYPO3\CMS\Dashboard\Widgets\CtaWidget'
      $view: '@dashboard.views.widget'
      $buttonProvider: '@dashboard.buttons.docGettingStarted'
        text: 'LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.documentation.gettingStarted.text'
      - name: dashboard.widget
        identifier: 'docGettingStarted'
        groupNames: 'documentation'
        title: 'LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.documentation.gettingStarted.title'
        description: 'LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.documentation.gettingStarted.description'
        iconIdentifier: 'content-widget-text'
        height: 'small'



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.


Adds an optional text to the widget to give some more background information about what a user can expect when clicking the button. You can either enter a normal string or a translation string e.g. LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.documentation.gettingStarted.text.



Provides the actual button to show within the widget. This button should be provided by a ButtonProvider that implements the interface ButtonProviderInterface.

See Adding button to Widget for further info and configuration options.


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.