Overview of the Magic Paths for Episerver Shell Menu Items

casper.rasmussen/ January 3, 2017/ Add-on, Episerver CMS/ 0 comments

Episerver relies on magic paths (via naming conventions) to enable developers to place custom plugin extensions in the out-of-the box Episerver Shell.
Over time, most Episerver developers has decompiled Episerver’s code to recollect these conventions. For that reason, the intent with this post is to outline the common paths, which are useful in most scenarios.

First off, if you aren’t familiar with how to register a new item in Episerver Shell, then please read the documentation around the topic here.

Let’s look at the different options.


Adding an item beneath “CMS”

cms

Convention
Simply use this magic string: /global/cms/[your path] – example /global/cms/organizations


Adding an item beneath “Commerce”

commerce

Convention
Simply use this magic string: /global/commerce/[your path] – example /global/commerce/organizations


Adding an item beneath “Find”

find

Convention
Simply use this magic string: /global/find[your path] – example /global/find/organizations


Adding an item in the Help dropdown

help

Convention
Simply use this magic string: /global/help/[your path] – example /global/help/organizations


Adding an item in the User dropdown

user

Convention
Simply use this magic string: /global/user/[your path] – example /global/user/organizations


Adding an item in the main navigation

global

global-right

Convention
Simply use this magic string: /global/[your path] – example /global/organizations.
My last sample uses the Alignment property to adjust the horizontal positioning.

Happy extending!

Leave a Comment

Your email address will not be published. Required fields are marked *

Please type the characters of this captcha image in the input box

Please type the characters of this captcha image in the input box
You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>
*
*