Skip to content

Latest commit

 

History

History
102 lines (71 loc) · 2.11 KB

README.md

File metadata and controls

102 lines (71 loc) · 2.11 KB

yii2-bootstrap-panel

Yii2 Bootstrap panel widget.

Installation

The preferred way to install this extension is through composer.

Either run

$ composer require is7/yii2-bootstrap-panel "dev-master"

or add

"is7/yii2-bootstrap-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.

  • titleOptions the tag options in terms of name-value pairs.

  • content content displayed in the body section of the panel.

  • footer content displayed in the footer section of the panel.

  • context context of the panel. Defaults to 'default'.

    • info
    • default
    • danger
    • primary
    • success
  • collapsible whether the panel is collapsible. Defaults to false.

  • collapsed whether or not the panel is initially collapsed. Defaults to false.

  • buttons array of buttons, that will be added to the title.

  • minimizable whether to add minimize button, which collapse panel to minimum size. Defaults to false

  • panelOptions the tag options in terms of name-value pairs.

Examples

Basic Example

use is7\bootstrap\Panel;

echo Panel::widget([    
    'title' => 'My Panel',
    'content' => '...',
    'footer' => 'footer content'
]);

Extended example

use is7\bootstrap\Panel;

echo Panel::begin([
    'title'=>'My Panel',
    'collapsible' => true,
    'context' => 'danger',    
    'footer'=>'footer content'
]);

// the body

Panel::end();

Panel with buttons

use is7\bootstrap\Panel;

echo Panel::widget([
    'title'=>'My Panel',
    'content' => '...',
    'context' => 'success',   
    'collapsible' => true,
    'minimizable' => true,
    'buttons' => [                    
        [
            'options' => [
                'class' => 'btn btn-default delete-button',
                'title' => 'Delete Panel'
            ],
            'icon' => 'trash' // Will be converted to the glyphicon-trash icon. HTML tag can be used instead
        ],
    ]
]);