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. You can choose to extend it to more levels by customizing the CSS.
\kartik\widgets namespace, this widget can be also installed from the yii2-widget-sidenav repository
and can also be accessed via \kartik\sidenav\SideNav namespace.
Not seeing the updated content on this page! Hard refresh your browser to clean cache for this page (e.g. SHIFT-F5 on Windows Chrome)
View this complete demo that shows a complete usage of the Side Navigation menu with configurable options.
Side Nav supports configuration of the bootstrap library version so that you can use this either with any Bootstrap version 3.x and above. For setting up the bootstrap version for your extension, you can configure the Side Nav::bsVersion property to one of the following.
To use with bootstrap 3 library - you can set Side Nav::bsVersion property to any string starting with 3 (e.g. 3 or 3.3.7 or 3.x)
To use with bootstrap 4 library - you can set Side Nav::bsVersion property to any string starting with 4 (e.g. 4 or 4.6.0 or 4.x)
To use with bootstrap 5 library - you can set Side Nav::bsVersion property to any string starting with 5 (e.g. 5 or 5.1.0 or 5.x)
Generally, you may also want to set a default version globally for all Krajee Extensions (instead of setting it for each widget or extension separately). In order to do this, you can setup the bsVersion property within Yii 2 application params (i.e. Yii::$app->params['bsVersion']). To set this up, add this section of code to your application params configuration file (e.g. config/params.php):
'params' => [
'bsVersion' => '5.x', // this will set globally `bsVersion` to Bootstrap 5.x for all Krajee Extensions
// other settings
// 'adminEmail' => 'admin@example.com'
]
If Side Nav::bsVersion property is set, in addition to Yii::$app->params['bsVersion'], the extension level setting (Side Nav::bsVersion property) will override the Yii::$app->params['bsVersion']. If Side Nav::bsVersion property is not set, and Yii::$app->params['bsVersion'] is also not set, Side Nav::bsVersion property will default to 3.x (i.e. Bootstrap 3.x version will be assumed as default).
You need to install one of yiisoft/yii2-bootstrap or yiisoft/yii2-bootstrap4 or yiisoft/yii2-bootstrap5 extensions manually in your application to enable Bootstrap 3.x or 4.x or 5.x functionality respectively. This dependency has not been pre-built into the composer configuration for Krajee extensions, to allow better control to the developers in configuring their bootstrap library version. If bsVersion is set to 5.x and yiisoft/yii2-bootstrap5 is not installed, then an exception message will be thrown mentioning you to install the yiisoft/yii2-bootstrap5 extension. If bsVersion is set to 4.x and yiisoft/yii2-bootstrap4 is not installed, then an exception message will be thrown mentioning you to install the yiisoft/yii2-bootstrap4 extension. Similarly, if bsVersion is set to 3.x and yiisoft/yii2-bootstrap is not installed, an exception message will be thrown mentioning you to install the yiisoft/yii2-bootstrap extension.
To install yiisoft/yii2-bootstrap5, add the repo to the require section of your application's composer.json.
"yiisoft/yii2-bootstrap5": "@dev"
To install yiisoft/yii2-bootstrap4, add the repo to the require section of your application's composer.json.
"yiisoft/yii2-bootstrap4": "@dev"
To install yiisoft/yii2-bootstrap, add the repo to the require section of your application's composer.json.
"yiisoft/yii2-bootstrap": "@dev"
The Krajee extension asset bundle(s) by default depend on one of the following asset bundles to load the Bootstrap CSS and JS:
yii\bootstrap\BootstrapAsset and/or yii\bootstrap\BootstrapPluginAsset for bootstrap 3.x (bsVersion = 3 setting)
yii\bootstrap4\BootstrapAsset and/or yii\bootstrap4\BootstrapPluginAsset for bootstrap 4.x ( bsVersion = 4 setting)
yii\bootstrap5\BootstrapAsset and/or yii\bootstrap5\BootstrapPluginAsset for bootstrap 5.x (bsVersion = 5 setting)
This is controlled by the property bsDependencyEnabled within the asset bundle (which defaults to true). One can override this and prevent the default yii2 bootstrap assets (CSS & JS) from loading by doing one or all of the following:
Global Override: Set Yii::$app->params['bsDependencyEnabled'] to false in your Yii 2 application config params.php. This setting will be applied for all Krajee Extension Asset Bundles that depend on Bootstrap assets.
'params' => [
'bsDependencyEnabled' => false, // this will not load Bootstrap CSS and JS for all Krajee extensions
// you need to ensure you load the Bootstrap CSS/JS manually in your view layout before Krajee CSS/JS assets
//
// other params settings below
// 'bsVersion' => '5.x',
// 'adminEmail' => 'admin@example.com'
]
Asset Bundle Specific Override: Set bsDependencyEnabled to false for the specific asset bundle within Yii2 Asset Manager component in your Yii 2 application config file.
// ...
'components' => [
'assetManager' => [
'bundles' => [
'kartik\form\ActiveFormAsset' => [
'bsDependencyEnabled' => false // do not load bootstrap assets for a specific asset bundle
],
],
],
],
When setting bsDependencyEnabled to false, you need to ensure that your app code/view layout loads the Bootstrap CSS and JS on your view before the Krajee CSS/JS are loaded to ensure that the Krajee extension JS plugins and CSS styles do not get broken.
Bootstrap 5.x / 4.x does not include glyphicons or any other icons framework bundled with the library. Krajee extensions therefore will use Font Awesome 5.x icons instead of glyphicons when working with Bootstrap 5.x / 4.x. You can download Font Awesome 5.x icons from the icons website. Alternatively, you can load the free version of Font Awesome from their CDN.
For Krajee extensions and demos, the Font Awesome Free version is used and loaded as the Icons Display Package on all the Yii2 demo layouts. To include font awesome assets on your page, include the following markup on the HEAD section of your view layout file, when bsVersion is set to 4.x or 5.x.
Option 1: Font CSS version of Font Awesome:
<!-- on your view layout file HEAD section --> <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.3.1/css/all.css">
Option 2: SVG / JS version of Font Awesome (recommended for cleaner scaling vector icons and features like icon layers):
<!-- on your view layout file HEAD section --> <script defer src="https://use.fontawesome.com/releases/v5.3.1/js/all.js" crossorigin="anonymous"></script>
Alternatively, you can use the FontAwesomeAsset from the kartik-v/yii2-icons package to load the SVG/JS version.
// on your view layout file use kartik\icons\FontAwesomeAsset; FontAwesomeAsset::register($this);
The yii2-widget-sidenav extension can be installed automatically or manually using one of these options:
Installation via Composer is the recommended and most easy option to install Krajee Yii2 extensions. You can install yii2-widget-sidenav via composer package manager. Either run:
$ php composer.phar require kartik-v/yii2-widget-sidenav "dev-master"
or add:
"kartik-v/yii2-widget-sidenav": "dev-master"
to your application's composer.json file.
You may also manually install the extension to your project (in case your composer install does not work). Just download the source ZIP or TAR ball and extract the extension asset files and folders into your project. You may need to install dependencies manually and also set the namespaces to the extensions in your Yii2 extensions configurations manually.
bsVersion:
string | int, the bootstrap library version to be used for the extension. Refer the Bootstrap Info section for details and pre-requisites on setting this property.
To use with Bootstrap library - you can set this to any string starting with
3 (e.g. 3 or 3.3.7 or 4.x / 3.x)
To use with bootstrap 4 - you can set this to any string starting with
4 (e.g. 4 or 4.6.0 or 4.x)
To use with bootstrap 5 - you can set this to any string starting with
4 (e.g. 5 or 5.1.0 or 5.x)
bsColCssPrefixes:
array, the bootstrap grid column css prefixes mapping, the key is the bootstrap versions, and the value is an array containing the sizes and their corresponding grid column css prefixes. The class using this trait, must implement kartik\base\BootstrapInterface. If not set will default to:.
[
3 => [
self::SIZE_X_SMALL => 'col-xs-',
self::SIZE_SMALL => 'col-sm-',
self::SIZE_MEDIUM => 'col-md-',
self::SIZE_LARGE => 'col-lg-',
self::SIZE_X_LARGE => 'col-lg-',
self::SIZE_XX_LARGE => 'col-lg-',
],
4 => [
self::SIZE_X_SMALL => 'col-',
self::SIZE_SMALL => 'col-sm-',
self::SIZE_MEDIUM => 'col-md-',
self::SIZE_LARGE => 'col-lg-',
self::SIZE_X_LARGE => 'col-xl-',
self::SIZE_XX_LARGE => 'col-xl-',
],
5 => [
self::SIZE_X_SMALL => 'col-',
self::SIZE_SMALL => 'col-sm-',
self::SIZE_MEDIUM => 'col-md-',
self::SIZE_LARGE => 'col-lg-',
self::SIZE_X_LARGE => 'col-xl-',
self::SIZE_XX_LARGE => 'col-xxl-',
],
];
type: string, the contextual type of SideNav. Defaults to SideNav::TYPE_DEFAULT. You can set it to one of the following
SideNav::TYPE_DEFAULT or 'default'
SideNav::TYPE_SECONDARY or 'secondary'
SideNav::TYPE_PRIMARY or 'primary'
SideNav::TYPE_INFO or 'info'
SideNav::TYPE_SUCCESS or 'success'
SideNav::TYPE_DANGER or 'danger'
SideNav::TYPE_WARNING or 'warning'
heading: string | boolean, the heading markup for the SideNav menu. To hide the heading set it to boolean false or an empty string.
Else provide a plain text or HTML markup. Note that this is not HTML encoded.
headingOptions: array, HTML attribute options for the sidenav heading
containerOptions: array, HTML attribute options for the sidenav container panel
indItem: string, HTML markup for the indicator to be placed before a menu sub-item, defaults to: »
indMenuOpen: string, HTML markup indicator placed to the right of an opened sub-menu. Defaults to the following based on bsVersion:
<i class="indicator fas fa-chevron-down"></i> when bsVersion is 3.x
<i class="indicator fas fa-angle-down"></i> when bsVersion is 4.x
indMenuClose: string, HTML markup indicator placed to the right of a closed sub-menu. Defaults to the following based on bsVersion:
<i class="indicator fas fa-chevron-right"></i> when bsVersion is 3.x
<i class="indicator fas fa-angle-right"></i> when bsVersion is 4.x
addlCssClass: string, additional CSS class to be appended to each navigation item link. For a submenu toggle, this class will be
automatically removed when submenu is opened and added back when closed. You can add multiple class separated by spaces. This defaults to:
empty string when bsVersion is 3.x
text-secondary when bsVersion is 4.x
linkTemplate property.items: array, the menu items configuration. this is the most important configuration parameter of the lot.
label: string, optional, specifies the menu item label. When encodeLabels is true, the label will be HTML-encoded. If the label is not specified, an empty string will be used.
icon: string, optional, specifies the glyphicon name to be placed before label.
url: string | array, optional, specifies the URL of the menu item. It will be processed by Url::to. When this is set, the actual menu item content will be generated using linkTemplate; otherwise, labelTemplate will be used.
visible: boolean, optional, whether this menu item is visible. Defaults to true.
items: array, optional, specifies the sub-menu items. Its format is the same as the parent items.
active: boolean, optional, whether this menu item is in active state (currently selected). If a menu item is active, its CSS class will be appended with activeCssClass. If this option is not set, the menu item will be set active automatically when the current request is triggered by url. For more details, please refer to isItemActive().
template: string, optional, the template used to render the content of this menu item. The token `{url}` will be replaced by the URL associated with this menu item, and the token `{label}` will be replaced by the label of the menu item. If this option is not set, it will default to '#'.
options: array, optional, the HTML attributes for each menu item.
iconPrefix: string, prefix for the icon in [[items]]. This string will be prepended before the icon name to get the icon CSS class. This defaults to:
fas fa- when bsVersion is 3.x
fas fa- when bsVersion is 4.x
View this complete demo that shows a complete usage of the Side Navigation menu with configurable options.
echo SideNav::widget(['items' => $items, 'headingOptions' => ['class'=>'head-style']);
Comments & Discussion
Note
You can now visit the Krajee Webtips Q & A forum for searching OR asking questions OR helping programmers with answers on these extensions and plugins. For asking a question click here. Select the appropriate question category (i.e. Krajee Plugins) and choose this current page plugin in the question related to field.
The comments and discussion section below are intended for generic discussions or feedback for this plugin. Developers may not be able to search or lookup here specific questions or tips on usage for this plugin.