Skip to content

Changelog - Admin Dashboard

All notable changes to Admin Dashboard are documented in this file. For the optional CMS Widgets and Google CrUX History Widget extensions, see the extensions changelog.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

3.0.0 Admin Dashboard API - 2026-06-30

First public release of hyva-themes/commerce-module-admin-dashboard-api (OSL-3.0), the stable contract package for Hyvä Admin Dashboard widgets.

Added

  • Hyva\AdminDashboardApi\Api\V1\WidgetTypeInterface — composition-based widget contract.
  • Hyva\AdminDashboardApi\Api\V1\WidgetContextInterface and the default WidgetContext value object.
  • Hyva\AdminDashboardApi\Api\V1\WidgetInstanceInterface — slim read-only view of a saved widget instance.
  • Hyva\AdminDashboardApi\Api\V1\WidgetAuthInterface — minimal auth contract.
  • Chart-type interfaces in Hyva\AdminDashboardApi\Api\V1\ChartType\
  • Hyva\AdminDashboardApi\Api\V1\Service\WidgetDateIntervalHelperInterface and Hyva\AdminDashboardApi\Api\V1\Source\WidgetDateIntervalSourceInterface — date-interval helpers that remove the need to extend AbstractDateIntervalWidget.
  • Hyva\AdminDashboardApi\Api\V1\Defaults\WidgetTypeDefaultsInterface — contract for chart-type defaults providers.
  • Hyva\AdminDashboardApi\Api\ConfigurationKeys and Hyva\AdminDashboardApi\Api\WidgetOptions constant classes.
  • etc/adminhtml/hyva_dashboard_widget.xsd — schema for hyva_dashboard_widget.xml.

2.0.1 Admin Dashboard - 2026-06-30

This is a backwards-incompatible change. The legacy widget contract continues to function thanks to the WidgetTypeDispatcher class which bridges the legacy API and the new API at runtime.

Added

  • Dashboard Views & Roles
    • Admins can save multiple named dashboards, switch between them, and assign them to admin roles.
    • New tables hyva_admin_dashboard_view, hyva_admin_dashboard_view_role, and hyva_admin_dashboard_user_active_view; new nullable view_id column on hyva_admin_dashboard_widget_instance.
    • Data patch Setup/Patch/Data/MigrateWidgetsToViews automatically moves existing widgets into a per-user "My Dashboard" view on upgrade.
  • New ACL resources
    • Hyva_AdminDashboardFramework::dashboard_views_create
    • Hyva_AdminDashboardFramework::dashboard_views_save
    • Hyva_AdminDashboardFramework::dashboard_views_delete
    • Hyva_AdminDashboardFramework::dashboard_views_assign
  • WidgetTypeDispatcher — routes widget method calls to either the legacy contract or the new Hyva\AdminDashboardApi\Api\V1\WidgetTypeInterface based on runtime instanceof checks, allowing both contracts to coexist on the same dashboard.
  • Per-chart-type defaults providers and WidgetContextFactory for the new contract.
  • New Widget Types
    • abandoned_carts — Abandoned-cart recovery overview with date intervals.
    • customer_order_totals — Top customers by order total with date intervals.
    • module_versions — Installed module and package versions.
    • top_coupons — Top-redeemed coupons with date intervals.
    • recently_edited_products, recently_edited_categories, recently_edited_cms_pages, recently_edited_cms_blocks — Recently edited catalog and CMS content.
  • New utility classes: Util/DateTimeFormatter, Util/CurrencyLocator, Util/Composer, Util/CategoryPathResolver, and Util/AllowedInstanceFilter.
  • New view models: View, SelectedRootCategories, SelectedWebsites, AdminUser.
  • Playwright e2e test suite under tests/playwright/.
  • New date-interval-table display type for table widgets that need an interval selector.

Changed

  • hyva-themes/commerce-module-admin-dashboard now requires hyva-themes/commerce-module-admin-dashboard-api: ^2.0.
  • Widget contracts relocated from Hyva\AdminDashboardFramework\Model\* to Hyva\AdminDashboardApi\Api\V1\*.
  • Direct use statements must be updated, although DI preferences resolve framework-side references automatically.
  • WidgetInstanceInterface widgets see is now the slim, read-only Hyva\AdminDashboardApi\Api\V1\WidgetInstanceInterface. Framework-internal repository access moves to Hyva\AdminDashboardFramework\Api\V1\WidgetInstance\WidgetInstanceRepositoryInterface.
  • WidgetTypeInterface::KEY_CONFIGURABLE_PROPERTIES and KEY_DISPLAY_PROPERTIES constants moved to Hyva\AdminDashboardApi\Api\ConfigurationKeys.
  • The framework's chart-base classes remain in place for legacy widgets; new widgets implement the matching *WidgetTypeInterface from Hyva\AdminDashboardApi\Api\V1\ChartType\ instead.
  • Hyvä Admin Dashboard system configuration now appears under the Hyvä Commerce section.

Removed

  • etc/adminhtml/hyva_dashboard_widget.xsd — moved to Hyva_AdminDashboardApi. Update widget XML files to reference urn:magento:module:Hyva_AdminDashboardApi:etc/adminhtml/hyva_dashboard_widget.xsd.

1.0.0 Admin Dashboard - 2026-03-16

Added

  • Restructured Module Architecture
    • Replaced Hyva_AdminDashboardBaseWidgets and Hyva_AdminDashboardCustomWidgets with Hyva_AdminDashboardWidgets
      • Abstract widget types, Alpine components, and templates have been moved to the Hyva_AdminDashboardFramework module
  • New Widget Types
    • average_order_value — Average order value with date intervals
    • best_selling_products — Table display with trailing action to reports
    • launchpad — Configurable launchpad/quick links
    • most_viewed_products — Table with report link
    • new_customers — Table with customer list link
    • sales_figures — Revenue/tax/shipping breakdown
    • search_activity — Search terms table
  • Date Interval System
    • New AbstractDateIntervalWidget base class with subinterval support
    • Centralized WidgetDateIntervals source model in framework di.xml
    • 19 intervals from 15 minutes to 5 years (intervals > 1 year disabled by default)
    • Each interval has subinterval config with step modifier and date format
  • Widget Caching
    • Per-widget configurable cache lifetimes via <cache_lifetime> in widget XML, default value of 86400 seconds
    • AdminDashboard cache class now handles save/load of widget display data
  • Widget Auth Utility Class
    • Wraps the Magento admin auth model and AuthorizationInterface into a single injectable dependency
  • New View Models
    • Locale
    • SelectedStoreViews
    • TrailingAction
    • Chart
    • Widget/Content
    • Widget/Input/DynamicRows
  • New Controller Actions
    • Controller/Adminhtml/WidgetInstance/Duplicate.php
    • Controller/Adminhtml/WidgetInstance/MassDelete.php
  • New Chart System Configuration Options
    • Light/dark theme toggle
    • Monochrome toggle
    • Custom colour palette
    • Fill types
  • Widget Layouts
    • New widget layout handles to improve extensibility and ease customisation
  • Widget/Dashboard Actions
    • Delete all dashboard widgets
    • Reload data for a specific widget instance
    • View the widget content in a full screen modal

Changed

  • Replaced Hyva_AdminDashboardBaseWidgets and Hyva_AdminDashboardCustomWidgets with Hyva_AdminDashboardWidgets
  • The Widget view model's booleanAttributes array is now configurable via di.xml instead of being a hardcoded class property
  • Updated the GridStack library from version 12.2.1 to 12.3.3
  • Refactored custom widget implementations to improve database query performance

Removed

  • Hyva_AdminDashboardBaseWidgets and Hyva_AdminDashboardCustomWidgets modules
  • Global description display property

0.1.0 Admin Dashboard - 2025-09-09

The 0.1.0 release for Admin Dashboard is the initial release.

Added

  • Widget Framework
  • Base Widget Display Types: Text, Links, Number, Bar Chart, Line Cart, Pie Chart
  • Base Widgets: Text, Links, Checkbox
  • Custom Widgets: Orders By Country, Order Volume, Recent Orders, Sales Funnel Activity
  • Ability to hide/show default dashboard content
  • Configuration for batch loading settings