1. Installation
2. Latest Release
3. Demo
4. Usage

This widget is a collapsible side navigation menu built to seamlessly work with Bootstrap framework. It is built over Bootstrap stacked nav component. This widget class extends the Yii Menu widget. Upto 3 levels of submenus are by default supported by the CSS styles to balance performance and useability. You can choose to extend it to more or less levels by customizing the CSS.

Note: This extension is a sub repo split of yii2-widgets. The split has been done since 08-Nov-2014 to allow developers to install this specific widget in isolation if needed. One can also use the extension the previous way with the whole suite of yii2-widgets.

Installation ¶

The preferred way to install this extension is through composer. Check the composer.json for this extension's requirements and dependencies. Read this web tip /wiki on setting the minimum-stability settings for your application's composer.json.

To install, either run

$ php composer.phar require kartik-v/yii2-widget-sidenav "@dev"

or add

"kartik-v/yii2-widget-sidenav": "@dev"

to the require section of your composer.json file.

Latest Release ¶

Note: The latest version of the module is v1.0.0 released on 08-Nov-2014. Refer the CHANGE LOG for details.

Demo ¶

You can refer detailed documentation and demos on usage of the extension.

Usage ¶

[php]
use kartik\sidenav\SideNav;
     
echo SideNav::widget([
	'type' => SideNav::TYPE_DEFAULT,
	'heading' => 'Options',
	'items' => [
		[
			'url' => '#',
			'label' => 'Home',
			'icon' => 'home'
		],
		[
			'label' => 'Help',
			'icon' => 'question-sign',
			'items' => [
				['label' => 'About', 'icon'=>'info-sign', 'url'=>'#'],
				['label' => 'Contact', 'icon'=>'phone', 'url'=>'#'],
			],
		],
	],
]);

## License

**yii2-widget-sidenav** is released under the BSD 3-Clause License. See the bundled `LICENSE.md` for details.

## Report
 * Report any issues on the [project page](https://github.com/kartik-v/yii2-widget-sidenav)
 * Use the [forum page](http://www.yiiframework.com/forum/index.php/topic/49263-yii2-widgets/) for any discussions on this extension

## Resources

 * [Github Project](https://github.com/kartik-v/yii2-widget-sidenav)
 * [Packagist Package](https://packagist.org/packages/kartik-v/yii2-widget-sidenav)
 * [Documentation & Demo](http://demos.krajee.com/widget-details/sidenav)