This is a super light-weight extension for wenzhixin's Bootstrap table that adds context menu support.
- Supports right or left clicking on a row to bring up a context menu.
- Supports clicking on a button on a row to bring up a context menu (good for touch devices).
- Works elegantly with Bootstrap dropdown menus and Font-Awesome.
- Events for menu and item clicks.
- Also programmatically invoke the context menu you want to show (good for multiple context menus).
- Also works on Mac OSX.
See it in action: demo here
###Bower
bower install bootstrap-table-contextmenu
Include this extension after Bootstrap-table (or add it to your gulpfile):
<script src="bootstrap-table-contextmenu.js"></script>
Simple example:
<body>
<div class="container">
<div class="row">
<table id='grid'>
<thead>
<tr>
<th data-field='itemid'>Item ID</th>
<th data-field='name'>Name</th>
<th data-field='price'>Price</th>
</tr>
</thead>
<tbody>
<tr><td>1</td><td>ABC</td><td>$1.00</td></tr>
<tr><td>2</td><td>DEF</td><td>$2.00</td></tr>
<tr><td>3</td><td>GHI</td><td>$3.00</td></tr>
<tr><td>4</td><td>XYZ</td><td>$4.00</td></tr>
</tbody>
</table>
</div>
</div>
<!-- context menu -->
<ul id="context-menu" class="dropdown-menu">
<li data-item="edit"><a>Edit</a></li>
<li data-item="delete"><a>Delete</a></li>
<li data-item="action1"><a>Action Here</a></li>
<li data-item="action2"><a>And Action Here</a></li>
</ul>
<script>
$(function() {
$('#grid').bootstrapTable({
contextMenu: '#context-menu',
onContextMenuItem: function(row, $el){
if($el.data("item") == "edit"){
alert(row.itemid);
}
}
});
});
</script>
</body>
| Name | Type | Default | Description |
|---|---|---|---|
| contextMenu | String | undefined | A jQuery selector that indicates the contextmenu. |
| contextMenuButton | String | undefined | A jQuery selector for a button on each table row to use to trigger open the contextmenu (good for touch screens). |
| contextMenuTrigger | 'right','left','both' | 'right' | Set what type of click will open the context menu. |
| contextMenuAutoClickRow | Boolean | false | When the context menu is opened, also perform a left click on the row to select it. |
| beforeContextMenuRow | Closure | function(e,row,buttonElement){ } | The closure will be called before the context menu is shown. If your closure returns false, then this prevents the context menu default show behavior from happening. You can use this along with the method showContextMenu to have more programmatic control. |
| Name | Parameter | Description | Example |
|---|---|---|---|
| showContextMenu | params | Manually invoke the context menu to show. The params contain 3 properties: event: (required) Pass your e event so that the menu can properly find the parent row index and data. Also so the menu can display at the correct coordinates. You can fake the event by just passing an object that has e.target, e.clientX, e.clientY. The target must be some child of the table row you want the menu to pull data from.contextMenu: (optional) Pass the selector for the context menu you want to show. If this param is not set, then the selector given in the table options above will be used. buttonElement: (optional) Pass a button element that you want the contextMenu to display correctly with. |
example here |
| Option Event | jQuery Event | Parameter | Description |
|---|---|---|---|
| onContextMenuItem | contextmenu-item.bs.table | row, $element | This is all you will typically need. Fires when you click on a li on the contextmenu. |
| onContextMenuRow | contextmenu-row.bs.table | row, $element | Fires when you right-click on a row. |