PHPackages hyva-themes/commerce-module-admin-dashboard-api - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Admin Panels](/categories/admin) 4. / 5. hyva-themes/commerce-module-admin-dashboard-api ActiveMagento2-module[Admin Panels](/categories/admin) hyva-themes/commerce-module-admin-dashboard-api =============================================== Stable contract package for Hyvä Admin Dashboard widgets 3.0.0(1mo ago)02423OSL-3.0PHPPHP >=8.1 Since Jun 8Pushed 1mo agoCompare [ Source](https://github.com/hyva-themes/commerce-module-admin-dashboard-api)[ Packagist](https://packagist.org/packages/hyva-themes/commerce-module-admin-dashboard-api)[ RSS](/packages/hyva-themes-commerce-module-admin-dashboard-api/feed)WikiDiscussions main Synced 1w ago READMEChangelogDependencies (1)Versions (4)Used By (3) Hyvä Themes - Admin Dashboard API ================================= [](#hyvä-themes---admin-dashboard-api) [![Hyvä Themes](https://camo.githubusercontent.com/6617ec88f9ece631287fcfcfea346057ad648dffe78a0867a0b43d8e0350a5d2/68747470733a2f2f687976612e696f2f6d656469612f777973697779672f6c6f676f2d636f6d706163742e706e67)](https://hyva.io/) hyva-themes/commerce-module-admin-dashboard-api ----------------------------------------------- [](#hyva-themescommerce-module-admin-dashboard-api) The purpose of this module is to let modules add dashboard widgets while remaining installable without Hyvä Commerce: only this contract module — distributed under the OSL — is required as a dependency, not the dashboard runtime itself. This module only ships only PHP interfaces, an XSD, and a small reusable `WidgetContext` value object — no runtime, no controllers, no templates. Modules that implement custom dashboard widgets only need to depend on this package; they do not need `hyva-themes/commerce-module-admin-dashboard` to be installed for `bin/magento setup:di:compile` to succeed. Installation ------------ [](#installation) This module usually is installed as a transitive dependency of packages implementing Hyvä Commerce Admin Dashboard Widgets. To install it explicitly, use ``` composer require hyva-themes/commerce-module-admin-dashboard-api bin/magento setup:upgrade ``` Scope ----- [](#scope) This package provides the **contract** for Hyvä Admin Dashboard widgets: - `Hyva\AdminDashboardApi\Api\V1\WidgetTypeInterface` — the widget contract; methods receive a `WidgetContextInterface` as the first argument - `Hyva\AdminDashboardApi\Api\V1\WidgetContextInterface` — read-only context exposed to widgets (merged config, ACL helper, chart-type defaults) - `Hyva\AdminDashboardApi\Api\V1\WidgetInstanceInterface` — slim read-only view of a saved widget instance - `Hyva\AdminDashboardApi\Api\V1\WidgetAuthInterface` — minimal ACL/authentication contract - `Hyva\AdminDashboardApi\Api\V1\Defaults\WidgetTypeDefaultsInterface` — backs `$ctx->getDisplayProperties()` / `getConfigurableProperties()` - `Hyva\AdminDashboardApi\Api\V1\Source\WidgetDateIntervalSourceInterface` — option source for date-interval widgets - `Hyva\AdminDashboardApi\Api\V1\Service\WidgetDateIntervalHelperInterface` — interval-data helper for date-interval widgets - `Hyva\AdminDashboardApi\Api\V1\ChartType\*WidgetTypeInterface` — five marker interfaces for bar / line / pie / number / date-interval widgets - `Hyva\AdminDashboardApi\Api\WidgetOptions` and `ConfigurationKeys` — constant holders - `Hyva\AdminDashboardApi\Model\WidgetContext` — concrete reusable `WidgetContextInterface` implementation - `etc/adminhtml/hyva_dashboard_widget.xsd` — XML schema for `` declarations The runtime that actually renders the dashboard lives in `hyva-themes/commerce-module-admin-dashboard`. Implementing a widget --------------------- [](#implementing-a-widget) See [docs/implementing-a-widget.md](docs/implementing-a-widget.md) for a full guide to implementing a custom dashboard widget. Backward compatibility ---------------------- [](#backward-compatibility) The legacy contract `Hyva\AdminDashboardFramework\Model\WidgetType\WidgetTypeInterface` and the `AbstractWidgetType` base class continue to work unchanged. The dashboard runtime in `hyva-themes/commerce-module-admin-dashboard` dispatches to both contracts via runtime `instanceof` checks. License ------- [](#license) This package is licensed under the **Open Software License (OSL 3.0)**. - **Copyright:** Copyright © Hyvä Themes. All rights reserved. - **License Text (OSL 3.0):** The full text of the OSL 3.0 license can be found in the `LICENSE.txt` file within this package, and is also available online at . ### Health Score 43 — FairBetter than 89% of packages Maintenance90 Actively maintained with recent releases Popularity16 Limited adoption so far Community15 Small or concentrated contributor base Maturity44 Maturing project, gaining track record Bus Factor1 Top contributor holds 60% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~11 days Total 3 Last Release 50d ago Major Versions 1.0.0 → 2.0.02026-06-17 2.0.0 → 3.0.02026-06-30 ### Community Maintainers ![](https://www.gravatar.com/avatar/1905417db5fbd31a61553b29bd441fdc66945da7cfb14f1b20a72275c68184e8?d=identicon)[vinai](/maintainers/vinai) ![](https://www.gravatar.com/avatar/7cd0062c670f61aa554c5d30193848ac11031b6cdb8f8616249b95a235eb475d?d=identicon)[wigman](/maintainers/wigman) ![](https://www.gravatar.com/avatar/1548630acefd0c1ac8002a37135d67741307f978296ac628422e3923b7a3766b?d=identicon)[JeroenBoersma](/maintainers/JeroenBoersma) --- Top Contributors [![pykettk](https://avatars.githubusercontent.com/u/40261741?v=4)](https://github.com/pykettk "pykettk (9 commits)")[![Vinai](https://avatars.githubusercontent.com/u/72463?v=4)](https://github.com/Vinai "Vinai (6 commits)") ### Embed Badge ![Health badge](/badges/hyva-themes-commerce-module-admin-dashboard-api/health.svg) ``` [![Health](https://phpackages.com/badges/hyva-themes-commerce-module-admin-dashboard-api/health.svg)](https://phpackages.com/packages/hyva-themes-commerce-module-admin-dashboard-api) ``` ### Alternatives [fastly/magento2 Fastly CDN Module for Magento 2.4.x 1564.5M1](/packages/fastly-magento2)[hyva-themes/module-magento2-admin This module aims to make creating grids and forms in the Magento 2 adminhtml area for developers joyful and fast 178395.6k15](/packages/hyva-themes-module-magento2-admin)[markshust/magento2-module-ordergrid The Order Grid module adds more details to the order grid in the admin. 9292.3k](/packages/markshust-magento2-module-ordergrid)[myparcelnl/magento A Magento 2 module that creates MyParcel labels 1861.2k](/packages/myparcelnl-magento)[loki/magento2-admin-components Admin Panel grids and forms created via Loki Components 178.3k9](/packages/loki-magento2-admin-components)[smile/module-seller Smile Retailer Suite - Seller Module 13550.1k4](/packages/smile-module-seller) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)