README

yii2-context-menu

A context menu extension for Yii framework 2.0 that 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 multiple Bootstrap versions (3.x, 4.x, and 5.x). The widget uses the \yii\bootstrap\Dropdown or \kartik\bs4dropdown\Dropdown widget to generate a dropdown menu.

Demo

You can see detailed documentation on usage of the extension.

Latest Release

Refer the CHANGE LOG for details on changes to various releases.

Installation

The preferred way to install this extension is through composer.

Note: 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.

Either run

$ php composer.phar require kartik-v/yii2-context-menu "dev-master"

or add

"kartik-v/yii2-context-menu": "dev-master"

to the require section of your composer.json file.

Usage

ContextMenu

use kartik\cmenu\ContextMenu;
ContextMenu::begin([
    'items' => [
        ['label' => 'Action', 'url' => '#'],
        ['label' => 'Another action', 'url' => '#'],
        ['label' => 'Something else here', 'url' => '#'],
        '<li class="divider"></li>',
        ['label' => 'Separated link', 'url' => '#'],
    ],
]); 
// fill in any content within your target container
ContextMenu::end();

License

yii2-context-menu is released under the BSD-3-Clause License. See the bundled LICENSE.md for details.