The yii2-context-menu allows you to add and render a
context menu to any element on the page. A context menu is a pop up menu that one initiates on any element by right clicking the
mouse in that target element.
This widget is a wrapper for the bootstrap-contextmenu
plugin which is styled for Bootstrap library.
The widget uses the \yii\bootstrap\Dropdown widget to generate a dropdown menu.
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)
ContextMenu 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 ContextMenu::bsVersion property to one of the following.
To use with bootstrap 3 library - you can set ContextMenu::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 ContextMenu::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 ContextMenu::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 ContextMenu::bsVersion property is set, in addition to Yii::$app->params['bsVersion'], the extension level setting (ContextMenu::bsVersion property) will override the Yii::$app->params['bsVersion']. If ContextMenu::bsVersion property is not set, and Yii::$app->params['bsVersion'] is also not set, ContextMenu::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-context-menu 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-context-menu via composer package manager. Either run:
$ php composer.phar require kartik-v/yii2-context-menu "dev-master"
or add:
"kartik-v/yii2-context-menu": "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-',
],
];
items: array the list of menu items in the dropdown as required by the \yii\bootstrap\Dropdown
widget. Each array element can be either an HTML string, or an array representing a single menu with the following
structure:
label: string, required, the label of the item link
url: string, optional, the url of the item link. Defaults to "#".
visible: boolean, optional, whether this menu item is visible. Defaults to true.
linkOptions: array, optional, the HTML attributes of the item link.
options: array, optional, the HTML attributes of the item.
items: array, the structure is the same as this property.
Note that Bootstrap doesn't support dropdown submenu. You have to add your own CSS styles to support it.
To insert a divider use
<div class="dropdown-divider"></li> for Bootstrap 5.x / 4.x.
<li role="presentation" class="divider"></li> for Bootstrap.
encodeLabels: boolean whether the labels for header items should be HTML-encoded. This is exactly same
as the encodeLabels property in \yii\bootstrap\Dropdown.
menuOptions: array the HTML attributes for the dropdown menu UL tag. This is exactly same
as the options property in \yii\bootstrap\Dropdown.
menuContainer: array the HTML attributes for the dropdown menu container that will enclose the dropdown menu.
This container element id will be the target for the bootstrap-contextmenu plugin. The following special options are recognized:
tag: string, optional, the tag for rendering the dropdown menu container. Defaults to div.
options: array the HTML attributes for the context menu target container, within which the context
menu action will be triggered on mouse right click. The following special options are recognized:
tag: string, optional, the tag for rendering the context menu target container. Defaults to span.
pluginOptions: array the plugin settings/options for the bootstrap-contextmenu jquery plugin.
Refer the plugin options documentation
for details on the available configurable options.
pluginEvents: array the ContextMenu JQuery events. You must define events in
event-name=>event-function format. All events will be stacked in the sequence.
Refer the plugin events documentation for usage.
Events can be configured like below:
pluginEvents = [
"show.bs.context"=>"function() { log("show.bs.context"); }",
"hide.bs.context"=>"function() { log("hide.bs.context"); }",
];
A text to test context menu. Right click here.
Basic context menu usage on a specific text within a paragaph.
Context menu usage on a div container
Activate context menu within a div but not for spans within the div
use kartik\cmenu\ContextMenu;
$items = [
['label'=>'Action', 'url'=>'#'],
['label'=>'Another action', 'url'=>'#'],
['label'=>'Something else here', 'url'=>'#'],
'<div class="dropdown-divider"></div>',
['label'=>'Separated link', 'url'=>'#'],
];
// Basic context menu usage on a specific text within a paragaph.
ContextMenu::begin(['items'=>$items]);
echo '<span class="kv-context">Right click here.</span>';
ContextMenu::end();
// Context menu usage on a div container
ContextMenu::begin(['items'=>$items, 'options'=>['tag'=>'div']]);
echo '<div class="well card card-body bg-light kv-context">Right click anywhere inside this container.</div>';
ContextMenu::end();
// Activate context menu within a div but not for `spans` within the div
$script = <<< 'JS'
function (e, element, target) {
e.preventDefault();
if (e.target.tagName == 'SPAN') {
e.preventDefault();
this.closemenu();
return false;
}
return true;
}
JS;
ContextMenu::begin([
'items'=>$items,
'options'=>['tag'=>'div'],
'pluginOptions'=>['before'=>$script]
]);
echo '<div class="card p-3 bg-light">Right click anywhere inside this container but note that
<span class="text-danger">context is disabled in this highlighted span element</span></div>';
ContextMenu::end();
yii2-context-menu is released under the BSD-3-Clause License. See the bundled LICENSE.md for details.
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.