{"id":19654102,"url":"https://github.com/dynamiatools/module-dashboard","last_synced_at":"2026-04-15T07:36:25.264Z","repository":{"id":57743305,"uuid":"186490974","full_name":"dynamiatools/module-dashboard","owner":"dynamiatools","description":"DynamiaTools extension to create and use simple dashboard and widgets","archived":false,"fork":false,"pushed_at":"2025-07-02T15:28:09.000Z","size":280,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-04T21:18:35.244Z","etag":null,"topics":["bootstrap","dahsboard","dynamia","zk"],"latest_commit_sha":null,"homepage":"https://www.dynamia.tools","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dynamiatools.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-05-13T20:29:42.000Z","updated_at":"2025-07-02T15:27:42.000Z","dependencies_parsed_at":"2025-01-28T12:25:54.644Z","dependency_job_id":"7df5e618-82bd-422c-8240-264990305928","html_url":"https://github.com/dynamiatools/module-dashboard","commit_stats":null,"previous_names":["dynamia-projects/module-dashboard"],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/dynamiatools/module-dashboard","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dynamiatools%2Fmodule-dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dynamiatools%2Fmodule-dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dynamiatools%2Fmodule-dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dynamiatools%2Fmodule-dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dynamiatools","download_url":"https://codeload.github.com/dynamiatools/module-dashboard/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dynamiatools%2Fmodule-dashboard/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31831847,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T07:17:56.427Z","status":"ssl_error","status_checked_at":"2026-04-15T07:17:30.007Z","response_time":63,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bootstrap","dahsboard","dynamia","zk"],"created_at":"2024-11-11T15:16:11.263Z","updated_at":"2026-04-15T07:36:25.212Z","avatar_url":"https://github.com/dynamiatools.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Maven Central](https://img.shields.io/maven-central/v/tools.dynamia.modules/tools.dynamia.modules.dashboard)](https://search.maven.org/search?q=tools.dynamia.modules.dashboard)\n![Java Version Required](https://img.shields.io/badge/java-17-blue)\n[![Maven Build](https://github.com/dynamiatools/module-dashboard/actions/workflows/maven.yml/badge.svg)](https://github.com/dynamiatools/module-dashboard/actions/workflows/maven.yml)\n\n# Dashboard Module\n\nWith this [DynamiaTools](https://dynamia.tools) extension you can create beautiful dashboards with custom widgets,\nresponsive design, charts, and more.\n\n![Screenshot](https://raw.githubusercontent.com/dynamiatools/module-dashboard/master/screenshots/dashboard.png)\n\n## Installation\n\nAdd the following dependencies to project classpath\n\n**Maven**\n\n```xml\n\n\u003cdependency\u003e\n    \u003cgroupId\u003etools.dynamia.modules\u003c/groupId\u003e\n    \u003cartifactId\u003etools.dynamia.modules.dashboard\u003c/artifactId\u003e\n    \u003cversion\u003e2.1.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n**Gradle**\n\n```groovy\ncompile 'tools.dynamia.modules:tools.dynamia.modules.dashboard:2.1.0'\n```\n\n## Usage\n\nCreate a view descriptor of type `dashboard` and add as fields all the widgets you want to show. This descriptor works\nlike the `FormView` descriptor\n\n```yaml\nview: dashboard\nid: mainDashboard\n\nfields:\n\n  monthSales:\n    params:\n      widget: sales-chart\n      type: month\n\n  totalSales:  #field\n    params:\n      widget: total-sales #widget id\n      range: lastMonth #custom widget params\n\n  newProducts:\n    params:\n      widget: products-table\n      type: NEW\n\n  newCustomers:\n    params:\n      widget: customers-table\n      type: NEW\n```\n\nInstall the dashboard using a `ViewerPage` in your `ModuleProvider`\n\n```java\nimport tools.dynamia.integration.sterotypes.Provider;\nimport tools.dynamia.navigation.Module;\nimport tools.dynamia.navigation.ModuleProvider;\nimport tools.dynamia.navigation.Page;\nimport tools.dynamia.zk.viewers.ViewerPage;\n\n@Provider\npublic class MyApplication implements ModuleProvider {\n\n    @Override\n    public Module getModule() {\n        var mod = new Module(\"myApp\",\"My App\");\n        //(pageId, name, dashboardId) \u003c---\n        mod.addPage(new ViewerPage(\"sales-dashboard\",\"Sales Dashboard\",\"mainDashboard\"));\n        \n        return mod;\n    }\n}\n```\n\nWidgets are created using a classes that implements `DashboardWidget` interface or \nextends `AbstractDashboardWidget` class for convenience. You should annotate this class with\n`@InstallDashboardWidget`\n\n\nExample: \n```java\n\nimport tools.dynamia.modules.dashboard.AbstractDashboardWidget;\nimport tools.dynamia.modules.dashboard.DashboardContext;\nimport tools.dynamia.modules.dashboard.InstallDashboardWidget;\nimport tools.dynamia.zk.ui.Infobox;\n\nimport java.math.BigDecimal;\nimport java.text.DecimalFormat;\nimport java.util.Date;\nimport java.util.List;\n\n/**\n * Dashboard Widget for total sales. It return an Infobox component\n * Instance of this class are created when the dashboard is rendered and live\n * all the time that the page of the dashboard is open.\n */\n@InstallDashboardWidget\npublic class TotalVentasDashboardWidget extends AbstractDashboardWidget\u003cInfobox\u003e {\n\n    /**\n     * Data for this widget. \n     */\n    private BigDecimal totalSales;\n    private Long numberSales;\n\n    /**\n     * Customize some widget properties here\n     */\n    public TotalVentasDashboardWidget() {\n        setTitle(\"Total Sales\");\n    }\n\n    /**\n     * This is the widget id used in view descriptor\n     * @return widgetId\n     */\n    @Override\n    public String getId() {\n        return \"total-sales\"; \n    }\n\n    /**\n     * Init the widget data. You can use context to get access to\n     * widget configuration\n     * @param context\n     */\n    @Override\n    public void init(DashboardContext context) {\n        // param from view descriptor\n        var range = (String)context.getField().getParam(\"range\");\n        \n        if(\"lastMonth\".equals(range)){\n            this.totalSales = doSomeCalculations();\n            this.numberSales = doSomeCalculations();\n        }\n    }\n\n    /**\n     * This is the view of the widget. Can be any ZK component or custom \n     * compnents\n     * @return\n     */\n    @Override\n    public Infobox getView() {\n        var infobox = new Infobox();\n        infobox.setIcon(\"fa fa-tags\");\n        infobox.setBackground(\"bg-primary color-white\");\n        infobox.setText(\"Total Sales\");\n        if (totalSales != null \u0026\u0026 numberSales != null) {\n            infobox.setNumber(DecimalFormat.getCurrencyInstance().format(totalSales));\n            infobox.setProgressDescription(numberSales + \" sales\");\n        }\n        infobox.setShowProgress(true);\n        if (numberSales \u003e 0) {\n            infobox.setProgress(100);\n        }\n\n        return infobox;\n    }\n}\n```\n\nWhen widgets are reinitialized the `init(context)` method is invoked again and when is\nre-rendered the `getView()` method is invoked. \n\n## License\n\nDynamiaTools Dashboard is available under Apache 2 License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdynamiatools%2Fmodule-dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdynamiatools%2Fmodule-dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdynamiatools%2Fmodule-dashboard/lists"}