MegaMenu

Overview

The MegaMenu is the header navigation bar located at the top of every Sugar page. It is the primary tool used to navigate the front end of the Sugar application.

Layout Components

The MegaMenu layout, located in ./clients/base/layouts/header/header.php,  is composed of the module-list and  quicksearch layouts as well as the notifications,  profileactions and quickcreate views. To customize these components, you can create your own layout override in ./custom/clients/base/layouts/header/header.php to reference your own custom components.

Link Actions

The following properties define the navigation, display, and visibility of all links in the system:

Module Links

Module links are the top-level links for each available module, represented as tabs in the navigation bar (or, sometimes, the overflow menu). When a top-level link is clicked, the user is directed to the selected module's list view layout. These top-level links are also expandable elements that contain sub-navigation menu links, which are outlined in the following section.

Module Action Links

The module action links are displayed to the user when they click the down arrow next to a module link. 

Adding Module Action Links

The example below demonstrates how to add a module action link that points to the Leads module. To define your own module action link, you must create your own label extension for the link's display label:

./custom/Extension/application/Ext/Language/en_us.addModuleLink.php

<?php

//create the links label
$app_strings['LNK_LEADS_C'] = 'View Leads';

Now create the module action link extension:

./custom/Extension/modules/<module>/Ext/clients/base/menus/header/addModuleLink.php

<?php

$viewdefs['<module>']['base']['menu']['header'][] = array(
    'route'=>'#Leads',
    'label' =>'LNK_LEADS_C',
    'acl_module'=>'Leads',
    'icon' => 'icon-user',
);

Once you have created the extension files, navigate to Admin > Repair > Quick Repair and Rebuild. This will append your profile action item to the existing list of links.

Note: You may need to refresh the page to see the new profile menu items.

Removing Module Action Links

To remove a module action link, loop through the list of module actions and remove the item by one of its properties. For your reference, the stock module actions can be found in ./modules/<module>/clients/base/menus/header/header.php.

./custom/Extension/modules/<module>/Ext/clients/base/menus/header/removeModuleLink.php

if (isset($viewdefs['<module>']['base']['menu']['header'])) {
    foreach ($viewdefs['<module>']['base']['menu']['header'] as $key => $moduleAction) {
        //remove the link by label key
        if (in_array($moduleAction['label'], array('<link label key>'))) {
            unset($viewdefs['<module>']['base']['menu']['header'][$key]);
        }
    }
}

Once you have created the extension files, navigate to Admin > Repair > Quick Repair and Rebuild. This will remove the menu action item from the existing list of links.

Note: You may need to refresh the page to see the module menu items removed.

Profile Action Links

Profile actions are the links listed under the user's profile menu on the right side of the MegaMenu. Profile action extension files are located in ./custom/Extension/application/Ext/clients/base/views/profileactions/ and are compiled into  ./custom/application/Ext/clients/base/views/profileactions/profileactions.ext.php.

Adding Profile Action Links

The example below demonstrates how to add a profile action link to the Styleguide. To define your own profile action link, create your own label extension for the link's display label. 

./custom/Extension/application/Ext/Language/en_us.addProfileActionLink.php

<?php

//create the links label
$app_strings['LNK_STYLEGUIDE_C'] = 'Styleguide';

Next, create the profile action link extension:

./custom/Extension/application/Ext/clients/base/views/profileactions/addProfileActionLink.php

<?php

$viewdefs['base']['view']['profileactions'][] = array(
    'route' => '#Styleguide',
    'label' => 'LNK_STYLEGUIDE_C',
    'icon' => 'icon-link',
);

Once you have created the extension files, navigate to Admin > Repair > Quick Repair and Rebuild. This will append your profile action item to the existing list of links.

Note: You may need to refresh the page to see the new profile menu items.

Removing Profile Action Links

To remove a profile action link, loop through the list of profile actions and remove the item by one of its properties. For your reference, the stock profile actions can be found in ./clients/base/views/profileactions/profileactions.php.

./custom/Extension/application/Ext/clients/base/views/profileactions/removeProfileActionLink.php

<?php

if (isset($viewdefs['base']['view']['profileactions'])) {
    foreach ($viewdefs['base']['view']['profileactions'] as $key => $profileAction) {
        //remove the link by label key
        if (in_array($profileAction['label'], array('LNK_ABOUT'))) {
            unset($viewdefs['base']['view']['profileactions'][$key]);
        }
    }
}

Once you have created the extension files, navigate to Admin > Repair > Quick Repair and Rebuild. This will remove the profile action item from the existing list of links.

Note: You may need to refresh the page to see the profile menu items removed.