https://github.com/derekisbusy/yii2-panel

Collapsable Bootstrap panel widget
https://github.com/derekisbusy/yii2-panel

bootstrap-panel panel widget yii2-panel

Last synced: 2 months ago
JSON representation

Collapsable Bootstrap panel widget

• Host: GitHub
• URL: https://github.com/derekisbusy/yii2-panel
• Owner: derekisbusy
• License: mit
• Created: 2015-10-23T17:11:44.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2019-06-21T17:47:45.000Z (over 5 years ago)
• Last Synced: 2024-11-09T08:07:42.968Z (2 months ago)
• Topics: bootstrap-panel, panel, widget, yii2-panel
• Language: JavaScript
• Size: 6.84 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# yii2-panel

[![Packagist](https://img.shields.io/packagist/l/doctrine/orm.svg)](https://github.com/derekisbusy/yii2-panel/blob/master/LICENSE.md)

[![Packagist](https://img.shields.io/packagist/dt/derekisbusy/yii2-panel.svg)](https://packagist.org/packages/derekisbusy/yii2-panel)

Collapsable Bootstrap panel widget.

## Installation

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

Either run

```

$ composer require derekisbusy/yii2-panel "dev-master"

```

or add

```

"derekisbusy/yii2-panel": "dev-master"

```

to the ```require``` section of your `composer.json` file then run composer update.

## Options

 - **title**    title displayed in the head section of the panel

 

 - **content**  content displayed in the body section of the panel. Only use if using widget() method.

 

 - **footer** content displayed in the footer section of the panel.

 

 - **type** style to be applied to the panel.

  * info

  * default

  * danger

  * primary

  * success

  

- **collapsable** whether the panel is collapsable.

- **collapse** whether or not the panel is collapsed.

- **widget** whether or not to include javascript. Can be used to disable javascript if using as style element only.

## Examples

### Basic Example

```php

use derekisbusy\panel\PanelWidget;

echo PanelWidget::widget([

    'collapse'=>true,

    'title'=>'My Panel',

    'content'=>'...',

    'footer'=>'footer content'

    ])

]);

```

### Style Only

If you only need to create HTML for bootstrap panel and don't need any js functionality set widget to false.

```php

use derekisbusy\panel\PanelWidget;

echo PanelWidget::begin([

    'title'=>'My Panel',

    'widget'=>false, // no js included (ie. style only)

    'footer'=>'footer content'

]);

// the body

PanelWidget::end();

```

### Example with Form Widget

```php

use derekisbusy\panel\PanelWidget;

echo PanelWidget::begin([

    'title'=>$title,

    'widget'=>false,

    'footer'=>Html::submitButton($model->isNewRecord ? Yii::t('app', 'Create') : Yii::t('app', 'Update'), ['class' => $model->isNewRecord ? 'btn btn-success' : 'btn btn-primary'])

]);

// the form

PanelWidget::end();

```