首页 > 代码库 > Custom Managed Navigation in SharePoint 2013

Custom Managed Navigation in SharePoint 2013


技术分享

SharePoint provide the default control,

but the design is ugly. in general, we can add css to cover the default style, but it is not free and hard to custom its UI. now we have found a grate way to implement it. 

The default managed navigation UI:

技术分享

Managed Metadata Service:

技术分享

The result of the custom Managed Naviagtion:

Menu 1:

技术分享

Menu 2:

技术分享


Menu 3:

技术分享

Implement in detail


1. Create http handle service to provide the term store data for client


I have attempted different ways to get the navigation data and its struct. due to the data is from Term Store. seeSharepoint 2013 Retrieve Taxonomy Term Store via Javascript.  in detail .

success to get the data, but failed to general its struct since client object model execute in async, it is discouraged.

I have to create a service to retrieve the term store in server and return the json object, then call the service to get the json data  in client, finally, generate the navigation struct, it is a workaround way.

you can get the json data by the URL: /_layouts/15/yourproject/GetNavigation.ashx (learning how to create handle, see my blog in detail:Create and Call HttpHandler in SharePoint  )

a. Retrieve the term store using Server API, at the moment, it would improve the performance using Http context cache

public static  class CacheNavigation
    {
        const string AudienceGroupListCacheKey = "CacheKey";
        const string SessionNavigationKey = "navigationKey_";
        const int CacheExpritaionTimeInSeconds = 60; // 10 minutes
        const string LogFeatureName = "CacheNavigation";

        public class NavigationItem
        {
            public string Title { get; set; }
            public string Url { get; set; }
            public string Description { get; set; }
            public string ParentNode { get; set; }
            public Boolean HasChildNodes { get; set; }

            public NavigationItem(string title, string url, string description, string parentNode, Boolean hasChildNodes)
            {
                Url = url;
                Title = title;
                Description = description;
                ParentNode = parentNode;
                HasChildNodes = hasChildNodes;
            }
        }

        public static List<NavigationItem> GetTerms()
        {
            List<NavigationItem> groups = new List<NavigationItem>();
            groups = HttpContext.Current.Cache[AudienceGroupListCacheKey] as List<NavigationItem>;
            if (groups == null) {
                groups = new List<NavigationItem>();
                SiteMapNode rootNode = SiteMap.Providers["GlobalNavigationTaxonomyProvider"].RootNode;
                if (rootNode != null)
                {
                    foreach (SiteMapNode term in rootNode.GetAllNodes())
                    {
                        groups.Add(new NavigationItem(term.Title, term.Url, term.Description, term.ParentNode.Title, term.HasChildNodes));
                    }
                }
                HttpContext.Current.Cache.Insert(AudienceGroupListCacheKey, groups, null, DateTime.Now.AddSeconds(CacheExpritaionTimeInSeconds), TimeSpan.Zero);
            }
            return groups;
        }
    }


b. Create a handle

public class GetNavigation : IHttpHandler
    {
        public bool IsReusable
        {
            get { return true; }
        }
        /// <summary>
        /// Return json-serialized Dictionary url --> ToHide
        /// </summary> to 
        /// <param name="context"></param>
        public void ProcessRequest(HttpContext context)
        {
            if (context == null || context.Response == null)
            {
                throw new ArgumentNullException("context", "context can not be null");
            }

            JavaScriptSerializer jsonSerializer = new JavaScriptSerializer();
            context.Response.ContentType = "application/json";
            var jsonResult = new JsonResult();

            var currentuserNavigation = CacheNavigation.GetTerms();
            jsonResult.Data.Add(currentuserNavigation);
            context.Response.Write(jsonSerializer.Serialize(jsonResult));
        }
    }

2. Call the hande to get the navigation data and general html layout 


a. Call the handle to get data

Function.registerNamespace('StorePortal.GlobalNavigation');
<span style="font-family:Consolas;font-size:12px;"><span style="font-family:Consolas;font-size:12px;"></span></span><p>termNavigation = { $_index: [] };</p><p>// call handle service, and return json data
StorePortal.GlobalNavigation.GetNavigationJson = function() {
    $.ajax({
        url: _spPageContextInfo.webServerRelativeUrl + "/_layouts/15/../GetNavigation.ashx",
        type: "get",
        dataType: "json",
        success: function (result) {
            StorePortal.GlobalNavigation.GetNavigationData(result.Data[0]);
        }
    });
}</p>

b. Save the json object into Array

// retrieve json datan and convert it to array
StorePortal.GlobalNavigation.GetNavigationData = http://www.mamicode.com/function(result) {>

c. Generate the HTML and  render it

// General html layout
StorePortal.GlobalNavigation.GeneralNavigationLayout = function (termNavigation) {
    var HTML = '<ul class="nav-contains">';
    $.each(termNavigation.$_index, function (index1, key1) {
        var currentTop = termNavigation[termNavigation.$_index[index1]];
        //FOH
        if (currentTop.children.$_index.length != 0) {
            HTML += '<li class="nav-children ' + currentTop.Title.replace(/ /g, "").replace(/&/g, "") + '"><a href=http://www.mamicode.com/"' + currentTop.Url + '">' + currentTop.Title + ' ';>

d.  Add the relevant event in document ready

$(function () {
    StorePortal.GlobalNavigation.GetNavigationJson();
    $(".navigation").on("click", ".nav-children > a", function (event) {
        if ($(this).next().length > 0) {
            var target = $(event.target);
            event.preventDefault();
            if ($(this).next()[0].style.display == "none" || $(this).next()[0].style.display == "") {
                $(".nav-menu").hide();
                $(".fa-angle-up").hide();
                $(".fa-angle-down").show();
                $(this).next().toggle();
                $(this).find(".fa-angle-down").toggle();
                $(this).find(".fa-angle-up").toggle();
            }
            else {
                $(".fa-angle-up").hide();
                $(".fa-angle-down").show();
                $(this).next().hide();
            }
        }
    });
   
    $("body").on("click", function (event) {
        var target = $(event.target);
        if (target.closest(".nav-children").length==0 || !($.contains(target.closest(".nav-children")[0], event.target))) {
            $(".nav-menu").hide();
            $(".fa-angle-up").hide();
            $(".fa-angle-down").show();
        }
    });
});


e. Finally, Add the CSS

.navigation {
    margin-bottom:500px;
}

.navigation ul {
    padding: 0px;
}
a{
    white-space: nowrap;
}
.nav-children {
    position: relative;
    display: inline-block;
    padding: 8px 20px;
    color: #464646;
    letter-spacing: 0.02em;
    line-height: 24px;
}

.nav-contains > li {
    font-size: 20px;
    line-height: 24px;
}

.nav-menu {
    display: none;
    position: absolute;
    left: 0px;
    top: 40px;
    padding: 20px;
    padding-top: 10px;
    color: #fff;
    font-family: "Segoe UI light";
    z-index: 9999;
    border: 1px solid rgba(0, 0, 0, 0);
}

    .nav-menu .nav-title {
        display: inline-block;
        font-size: 36px;
        font-family: "Segoe UI light";
        margin: 30px 0;
    }

    .nav-menu a {
        color: white !important;
        font-family: "Segoe UI light";
    }

.nav-sub-row {
    display: table-row;
}

.nav-sub-cell {
    display: table-cell;
    padding-right: 60px;
    padding-bottom: 50px;
}

    .nav-sub-cell li {
        display: block;
        padding-top: 5px;
        padding-bottom: 5px;
    }

    .nav-sub-cell > a {
        display: block;
        font-size: 26px;
        white-space: nowrap;
        padding-bottom: 10px;
    }

    .nav-sub-cell li a {
        font-size: 15px;
        white-space: nowrap;
    }


.FrontofHouse .nav-menu {
    background-color: #B4009E;
}

.BackofHouse .nav-menu {
    background: #7A44A2;
}

.Learning .nav-menu {
   background: #107C10;
}

.HR .nav-menu {
    background: #008272;
}

.CompanyCulture .nav-menu {
   background: #D83B01;
}


.FrontofHouse > a:hover {
    color: #B4009E !important;
}

.BackofHouse > a:hover {
    color: #7A44A2 !important;
}

.Learning > a:hover {
   color: #107C10 !important;
}

.HR > a:hover {
    color: #008272 !important;
}

.CompanyCulture > a:hover {
   color: #D83B01 !important;
}

.SharePoint > a:hover {
    color: #B4009E !important;
}

.ObjectModel > a:hover {
    color: #7A44A2 !important;
}

.Top > a:hover {
   color: #107C10 !important;
}

.SharePoint .nav-menu {
    background-color: #B4009E;
}

.ObjectModel .nav-menu {
    background: #7A44A2;
}

.Top .nav-menu {
   background: #107C10;
}

please email to me if you want get the total code


































Custom Managed Navigation in SharePoint 2013