Issue Task Closed

#107874Add RST file for deprecated and new JS events in dashboard

Stefan Froemken 10/28/25, 06:04 updated 08/06/26, 16:16

Description

Hello,

The js event “widgetContentRendered” was marked legacy (deprecated) and a lot of new events like DashboardWidgetContentRenderedEvent were implemented with https://review.typo3.org/c/Packages/TYPO3.CMS/+/84097, but no rst file was provided.

Stefan

Reviews 0

No change resolves or names this issue in its commit message, and no comment links one.

History 7

  1. Stefan Froemken commented <span data-processor="relativetime" data-value="2025-10-28T06:04:49+00:00" > 10/28/25, 06:04 </span>

    Example:

    dashboard.js:

    this.dispatchEvent(new DashboardWidgetContentRenderedEvent(widget));
    // Legacy event, kept for compatibility reasons
    this.dispatchEvent(new CustomEvent('widgetContentRendered', { bubbles: true, detail: this.widget.eventdata }));
  2. Stefan Froemken commented <span data-processor="relativetime" data-value="2025-10-28T06:10:27+00:00" > 10/28/25, 06:10 </span>

    TYPO3 11:

    new RegularEvent('widgetContentRendered', (): void => {
        dashboard.refreshItems().layout();
    }).delegateTo(document, '.dashboard-item');

    TYPO3 13:

    this.dispatchEvent(new CustomEvent('widgetContentRendered', { bubbles: true, detail: this.widget.eventdata }));

    So, this change is also breaking, as CustomEvent doesn’t have bindTo possibilities.

  3. Garvin Hicking commented and changed status New Closed <span data-processor="relativetime" data-value="2026-08-06T16:16:10+00:00" > 08/06/26, 16:16 </span>

    The dashboard has been reworked a lot and we don’t really cover much JS as API docs unless it’s combined with a feature ReST… so in these cases “the code is the docs” :-O