Context Menu using AngularJS Directive

Since the SPA have emerged a lot in Web application market, creating MVC applications using Angular JS have become a mainstream trend.

Here is something reusable for your Angular JS Application to speed up your development – a context menu directive.

Check it out: Custom Context Menu Angular JS Directive/

How to use?

This directive is as simple as it could be. Plug the directive javascripts to you module.  Next assign the attribute to any HTML element.

<button context-menu>Show Options</button>

There is one required attribute ‘menu-items’ to pass your menu items.  This menu item has to be an Array of objects in your current scope with three properties. Example:

    //Menu Items Array
    $scope.menus = [
      {label: 'View',   action: 'callView',   active: true},
      {label: 'Delete', action: 'deleteItem', active: true},
      {label: 'Send',   action: 'sendItem',   active: false},
      {label: 'Share',  action: '',           active: true},
      {label: 'Active', action: 'deactivate', active: false}
    ];

Object structure:

  • label: Text to show on Menu item
  • action: This is the method, that would be executed when clicked on particular item.
  • active: A boolean to toggle the disable/enable of particular item from menu. It doesn’t hide though.

This array has to be accessible where the current context menu is being applied.  Then use that ‘menu-items’ attribute to pass the array reference:

<button context-menu menu-items="menus">Show Options</button>

And now the time to define your function, these function has to be within your scope chain and be accessible to be executed within scope.

    $scope.deleteItem = function(arg){
      console.warn('deleted ...')
    };

    $scope.callView = function(arg){
      console.info('View Call, another method')
    };

That’s all. You have a working context menu. Any time a user right clicks within that element range – context menu show up.

Other Options

There are other features, optional to use.

  • Fix pointer for opening context menu

If you wish your context menu to open always from a certain point, not where user has right clicked (cursor position) then all you gotta do is specify a pointer. For that you need an child element with your directive. Pass that element reference using pointer-node attribute. Example:

     <button context-menu menu-items="menus" pointer-node=".showHere">Show Options <span class="showHere">&gt;</span></button>

I recommend using a class selector to pass the reference to directive as I have done above.

Context Menu Behaviour

Once the element is clicked, a dropdown context menu pop down right below it. But this context menu is space sensitive. What I mean by that is, by default the menu tries to open on bottom right side of the element but for some reason of menu detects that it might go outside of window then menu will automatically reposition itself on eight top left, top right, left top, left bottom. Hence when the menu appears it would never be hidden in browser. How do you like that :P?

Full Code

Source Code is available in Github:  https://github.com/shekhardesigner/Context-Menu-Angular-Directive

Published by

Shekhar K. Sharma

$hekh@r d-Ziner is a Interface Developer, having expertise in Interface design/development, CSS, ASP.net design & web design trends & etc.