PHPackages                             esoftslimited/yii2-dashboard - 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. esoftslimited/yii2-dashboard

ActiveYii2-extension

esoftslimited/yii2-dashboard
============================

Yii2 Dashboard is a module that allows you to create and manage dashboards using custom layouts and panels.

072PHP

Since Aug 29Pushed 10y ago2 watchersCompare

[ Source](https://github.com/ElijahGM/yii2-dashboard)[ Packagist](https://packagist.org/packages/esoftslimited/yii2-dashboard)[ RSS](/packages/esoftslimited-yii2-dashboard/feed)WikiDiscussions master Synced today

READMEChangelogDependenciesVersions (1)Used By (0)

Getting started with Yii2-dashboard
===================================

[](#getting-started-with-yii2-dashboard)

Yii2 Dashboard is a module that allows you to create and manage admin dashboards using custom layouts and panels.

Installation
------------

[](#installation)

Yii2-dashboard is designed to work out of the box, meaning that installation requires minimal steps. Only one configuration step should be taken and you are ready to have a dynamic dashboard on your Yii2 website.

### 1. Download

[](#1-download)

The preferred way to install this extension is through [composer](http://getcomposer.org/download/).

Either run

```
php composer.phar require --prefer-dist esoftslimited/yii2-dashboard "*"

```

or add

```
"esoftslimited/yii2-dashboard": "*"

```

to the require section of your `composer.json` file.

Usage
-----

[](#usage)

### 2. Configure

[](#2-configure)

Add following lines to your main configuration file:

> **NOTE:** Make sure that you don't have `dashboard` component or `module` configuration in your config files. otherwise this step will override it

```
'modules' => [
    'dashboard' => [
        'class' => 'esoftslimited\dashboard\Module',
    ],
],
```

Where do I go now?
------------------

[](#where-do-i-go-now)

You have Yii2-dashboard installed. Now you can start adding panels on to your dashboard using this method

```
\Yii::$app->dashboard->addPanel($name,$view,$section);
```

The addPanel() function accepts 3 parameters

```
$name; /** name of the panel **/
$view; /** content of the panel **/
$section; /** section where the panel will be displayed**/
```

> **NOTE:** You can add as many panel as you wish

Playing around with layouts?
----------------------------

[](#playing-around-with-layouts)

The dashboard component allows custom layouts using the following function

```
\Yii::$app->dashboard->setLayout(String $layout);
```

Displaying The panels?
----------------------

[](#displaying-the-panels)

On your admin/dashboad view invoke

```
\Yii::$app->dashboard->display;
```

to display your panels

Full Example?
-------------

[](#full-example)

On your dashboard view add the following

```
    $layout='{stats} {test2}';
   \Yii::$app->dashboard->setLayout($layout);
   \Yii::$app->dashboard->addPanel('{stats}',$testView);
   \Yii::$app->dashboard->addPanel('test2','Example');
   //\Yii::$app->dashboard->addPanel('test3','View3','left');
   \Yii::$app->dashboard->display;
```

What next after this? (Our Roadmap)
-----------------------------------

[](#what-next-after-this-our-roadmap)

The module is still on dev we are hoping to achieve a dynamic easy to use plugin

1. Add module hooks,where modules will be able to 'inject' thier panels to the dashboard on-the-fly
2. Allow using [yii\\widgets\\Block](http://www.yiiframework.com/doc-2.0/yii-widgets-block.html) on layouts
3. Utilize cache for enhacing performace
4. Add hooks for allowing draggable and saving user settings to the database
5. Add many useful functions on dashboard component;
6. Design default module for diplaying dashboard that is flexible and extensible
7. Organize this ToDo in order of priority
8. Relax and develop

###  Health Score

21

—

LowBetter than 21% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/c15a4181fc9ae5bef2ad3d22155544a07dd38c3c29e21da7cc134daf34d0c387?d=identicon)[Esofts](/maintainers/Esofts)

---

Top Contributors

[![ElijahGM](https://avatars.githubusercontent.com/u/918982?v=4)](https://github.com/ElijahGM "ElijahGM (8 commits)")

### Embed Badge

![Health badge](/badges/esoftslimited-yii2-dashboard/health.svg)

```
[![Health](https://phpackages.com/badges/esoftslimited-yii2-dashboard/health.svg)](https://phpackages.com/packages/esoftslimited-yii2-dashboard)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
