PHP download

Download the PHP package hyva-themes/commerce-module-admin-dashboard-api without Composer

On this page you can find all versions of the php package hyva-themes/commerce-module-admin-dashboard-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download hyva-themes/commerce-module-admin-dashboard-api
More information about hyva-themes/commerce-module-admin-dashboard-api
Files in hyva-themes/commerce-module-admin-dashboard-api

Vendor hyva-themes
Package commerce-module-admin-dashboard-api
Short Description Stable contract package for Hyvä Admin Dashboard widgets
License OSL-3.0

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Informations about the package commerce-module-admin-dashboard-api

Hyvä Themes - Admin Dashboard API

hyva-themes/commerce-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

This module usually is installed as a transitive dependency of packages implementing Hyvä Commerce Admin Dashboard Widgets.

To install it explicitly, use

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 <widget> declarations

The runtime that actually renders the dashboard lives in hyva-themes/commerce-module-admin-dashboard.

Implementing a widget

See docs/implementing-a-widget.md for a full guide to implementing a custom dashboard widget.

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

This package is licensed under the Open Software License (OSL 3.0).

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 http://opensource.org/licenses/osl-3.0.php.

All versions of commerce-module-admin-dashboard-api with dependencies

PHP Build Version

Package Version

Version 3.0.0 Release 30. Jun 2026
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of commerce-module-admin-dashboard-api from vendor hyva-themes

Requires php Version >=8.1
magento/framework Version *

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package hyva-themes/commerce-module-admin-dashboard-api contains the following files

Loading the files please wait ...