Control Panel
Basic Options
NavEE’s basic Control Panel options.
Link Text
{exp:navee:nav} Link text is the client facing language which will output in your navigation.
{exp:navee:custom} Link text is available with the {text} variable.
Assign Link To Parent
This dropdown will output your current navigation, allowing you to select which navigation item you would like your new navigation item to appear beneath.
Create Link: Manual
The first of the three methods for entering a link. The Manual method exists for you to enter any kind of link which is appropriate for your navigation. Some examples:
- /index.php/your/content
- /your/content
- http://fromtheoutfit.com
- #content
{exp:navee:nav} Your link will output into your navigation as the href of the anchor tag, exactly as you enter it.
{exp:navee:custom} Your link is available with the {link} variable.
Create Link: Guided
New in NavEE 2 is the Guided method. Using this method, NavEE will dynamically generate your link for you using the template and entry information. Simply select a template, select a channel, and select an entry and NavEE will create something like:
- /template-group/template/url_title
- /template-group/url_title (if this is the index template for your group)
- /index.php/template-group/url_title (if you opted to include index.php in your links in the NavEE configuration page)
{exp:navee:nav} Your link will output into your navigation as the href of the anchor tag, exactly as you enter it.
{exp:navee:custom} Your link is available with the {link} variable.
Create Link: Pages
This tab will only appear if you have the Pages Module installed, and also have entries within that module. It simply allows you to select your link from a list of Pages entries you have created previously. If you update the URL to a Pages entry at a later date, this link will automatically update to the new link as well.
{exp:navee:nav} Your link will output into your navigation as the href of the anchor tag, exactly as you enter it.
{exp:navee:custom} Your link is available with the {link} variable.
More Options
These options are available by clicking the More Options link within your nav item.
Output
Include In Navigation: If set to false, this option will prevent your nav item from appearing in your navigation(s) by default. You can override this field by passing the ignore_include_in_nav parameter to any of your NavEE template tags.
Passive Node (No selected class): This field exists for when you have more than one entry in your navigation for the same page. Often, you may only want one of those nav items to get the selected class when you are on that page. By setting Passive Node to true, your node will no longer be assigned the class of selected.
Attributes
ID: When using the {exp:navee:nav} method, this ID will be assigned to the <li> surrounding your navigation item. When using the {exp:navee:custom} method this field is available as the {id} variable.
Class: When using the {exp:navee:nav} method, thia Class will be assigned to the <li> surrounding your navigation item. When using the {exp:navee:custom} method this field is available as the {class} variable.
Rel: When using the {exp:navee:nav} method, this Rel will be assigned to the <a> surrounding your navigation item. When using the {exp:navee:custom} method this field is available as the {rel} variable.
Name: When using the {exp:navee:nav} method, this Name will be assigned to the <a> surrounding your navigation item. When using the {exp:navee:custom} method this field is available as the {name} variable.
Title: When using the {exp:navee:nav} method, this Title will be assigned to the <a> surrounding your navigation item. When using the {exp:navee:custom} method this field is available as the {title} variable.
Access Key: When using the {exp:navee:nav} method, this Access Key will be assigned to the <a> surrounding your navigation item. When using the {exp:navee:custom} method this field is available as the {accesskey} variable.
Target: When using the {exp:navee:nav} method, this Target will be assigned to the <a> surrounding your navigation item. When using the {exp:navee:custom} method this field is available as the {target} variable.
Custom Attributes
Include additional html in <li>: This field is for any additional information you would like to inject into your navigation. If you are using the {exp:navee:nav} method, any information you enter here will be inserted into the <li> surrounding your nav item. When using the {exp:navee:custom} method this field is available as the {custom} variable.
Include additional html in <ul> of children: This field is for any additional information you would like to inject into your navigation element surrounding the child nodes of the element you are on. This element will only appear if the element you are on already has child elements assigned to it. If you are using the {exp:navee:nav} method, any information you enter here will be inserted into the <ul> surrounding the children of your nav item. When using the {exp:navee:custom} method this field is available as the {custom_kids} variable.
Regular Expression
The Regular Expression field allows you to flexibly make the assignment of the selected class onto the item you are working in. By default, NavEE is only able to find a match and apply the selected class if the url of the page you are on exactly matches link you have entered for this nav item. The Regular Expression field allows you to extend that reach a bit.
For example, let’s say that your nav item is for the News section of your site. You may have multiple items on which you want this element to receive a class of selected, for example:
- /news/article-name
- /news/article-name-2
- /news/archive
By entering /news/i into the Regular Expressions field, NavEE will catch all of the examples listed above. This example is intentionally basic, as the use of regular expressions is both very powerful and outside the scope of what we can support. This feature is designed for advanced users with understanding of how PHP’s regular expression functionality works. Put simply, this field passes its value as the pattern to the preg_match function, with the query string being passed as the string to the same function.
The internet is littered with information about regular expressions, but here are a few resources we feel may be helpful to you.
Member Groups
This is more easily explained with a video: