A panel defines a block that will be rendered inside a layout region. In addition it allows the user to enter custom options into the panel form when updating the panel.
The panel class allows you to define the block code that will be rendered inside a layout region.
It extends yii\base\Model, allowing you to define custom settings which will be available for the user to
configure the panel via a form when updating the panel.
Place the following code into app/dashboard/panels/ExamplePanel.php:
<?php
namespace app\dashboard\panels;
class ExamplePanel extends \cornernote\dashboard\Panel
{
public $viewPath = '@app/views/dashboard/panels/example';
public $customSetting;
public function rules()
{
return [
[['customSetting'], 'required'],
];
}
}
The layout view will render the panel in "view" mode.
Place the following code into app/views/dashboard/panels/example/view.php:
<?php
/**
* @var $panel \app\dashboard\panels\ExamplePanel
* @var $this \yii\web\View
*/
?>
<div class="panel panel-default">
<div class="panel-heading">
<h3 class="panel-title">
<?= $panel->dashboardPanel->name ?>
<div class="pull-right">
<?= $this->render('@cornernote/dashboard/views/dashboard/panels/_buttons', ['panel' => $panel]) ?>
</div>
</h3>
</div>
<div class="panel-body">
<?php \yii\helpers\VarDumper::dump($panel->dashboardPanel->options); ?>
</div>
</div>
The panel update will render the panel in "update" mode. This provides a simplified panel when the user is moving the panel between regions.
Place the following code into app/views/dashboard/panels/example/update.php:
<?php
/**
* @var $panel \app\dashboard\panels\ExamplePanel
* @var $this \yii\web\View
*/
?>
<div class="panel panel-default">
<div class="panel-heading">
<h3 class="panel-title">
<?= $panel->dashboardPanel->name ?>
<div class="pull-right">
<?= $this->render('@cornernote/dashboard/views/dashboard/panels/_buttons', ['panel' => $panel]) ?>
</div>
</h3>
</div>
<div class="panel-body">
<?php \yii\helpers\VarDumper::dump($panel->dashboardPanel->options); ?>
</div>
</div>
The panel form will render form elements for the custom options available to your panel.
Place the following code into app/views/dashboard/panels/example/form.php:
<?php
/**
* @var $panel \app\dashboard\panels\ExamplePanel
* @var $this \yii\web\View
* @var $form \yii\bootstrap\ActiveForm
*/
?>
<?= $form->field($panel, 'customSetting')->textInput() ?>
Finally you will need to add your panel to the module configuration:
<?php
$config = [
'modules' => [
'dashboard' => [
'panels' => [
'example' => 'app\dashboard\panels\ExamplePanel',
],
],
],
];