Skip to content

integration-guide.md

Latest commit

 

History

History
53 lines (37 loc) · 2.19 KB

integration-guide.md

File metadata and controls

53 lines (37 loc) · 2.19 KB

Integration guide

Meganav was designed to be as clean and easy for developers as it is for editors to use.

Strongly typed models

Out of the box Meganav can return strongly typed models for a given navigation.

The following properties are available in the MeganavItem class:

Property Type Description
Id Int The node ID of the selected content item. For external linking nav items this will be "0"
Title String The link title, often the node name
Target String The link target
Url String The link url
Level Int The level in the overall navigation that the current item sits at
Content IPublishedContent The IPublishedContent for the selected content item. For external linking nav items this will be null
Children List The picked child / sub items for the current item

Implementing Razor

Meganav was designed to closely follow the "Umbraco way" of doing things so we don't impose our own styles or markup on you.

The package ships with a very basic MVC partial to render a multi-level navigation. We recommend using this as a reference for a best practice way to implement your navigation.

/Views/Partials/ExampleNavigation.cshtml

Alternatively, it's just as easy to write your own Razor:

<ul>
    @foreach (var item in Model.Content.GetPropertyValue<IEnumerable<MeganavItem>("mainNavigation")))
    {
        <li>
            ...
        </li>
    }
</ul>

Note: For large navigations with multiple levels it is highly recommended that you cache your navigation for optimal performance.

Complex navigation

Meganav can build any size of navigation, from a small single level list to a large multi-level menu.

Based on the flexible implementation described above it would be possible to create a complex navigation varying on a number of factors, such as:

  • The level of an item (available via x.Level)
  • The doctype alias of an item (available via x.Content.DocumentTypeAlias)
  • Any custom property (available via x.Content.GetPropertyValue("..."))
  • Countless more...!