Skip to content

Widget Types: Legacy API

This section preserves the developer documentation for the widget contract that shipped with Admin Dashboard 1.0.0, before the introduction of the composition-based WidgetContextInterface API in hyva-themes/commerce-module-admin-dashboard-api.

Migrating to the new API

The legacy contract continues to work, since the dashboard runtime bridges both APIs through Hyva\AdminDashboardFramework\Model\WidgetType\WidgetTypeDispatcher. New widgets should be implemented against the composition-based API; for an existing widget the mechanical migration steps are outlined in the 1.3.0 upgrade notes.

For non-API-specific reference material (widget XML, configurable inputs, styles, the list of available widget classes), continue to use the unchanged pages: