Navigation Menu API
The Navigation Menu API lets you display a navigation menu on your website.
Some of the API parameters correspond with individual settings for the navigation menu so often times, if you don't need to override those values then you can simply omit them.
The first value after "ap_navgation" is the menu key for the individual navigation menu.
Learn more about APIs.
Minimum Tag
{{ _api.ap_navigation:menuKey }}
API Tag Parameters
| Parameter | Description |
|---|
| getParentItem |
Whether or not to include the parent navigation item when getting sub-navigation items.
Type: String
Accepted Values: yes, no, true or false
Default Value: no
Example: getParentItem('yes')
|
| parentId |
If this is set then only the sub-navigation items for the item with the specified id will be shown.
Type: Integer
Example:
parentId('3')
|
| preloadImages |
Whether or not to preload images if any of the navigation items use images instead of text.
Defaults to the value set for the navigation menu.
Type: String
Accepted Values: yes, no, true or false
Example: preloadImages('yes')
|
| setCurrentItem |
Required
Whether or not the mark the current parent item. If set to "false" then this will also not set the current parent item class.
Type: String
Accepted Values: yes, no, true or false
Example: setCurrentItem('yes')
|
| setCurrentItemClass |
Required
Whether or not to set the current item class on the current item.
Type: String
Accepted Values: yes, no, true or false
Example: setCurrentItemClass('yes')
|
| setCurrentParent |
Required
Whether or not to mark the current parent navigation item(s). If set to "false" then the current parent class will also not get set.
Type: String
Accepted Values: yes, no, true or false
Example: setCurrentParent('yes')
|
| setCurrentParentClass |
Required
Whether or not to set the current parent class on the current parent items.
Type: String
Accepted Values: yes, no, true or false
Example: setCurrentParentClass('yes')
|
| showSubNav |
Whether or not to show sub navigation.
Defaults to the value set for the navigation menu.
"yes" means to show sub navigation when necessary.
"all" means to show sub navigation all the time. this is useful for navigation needing drop-down styles.
"no" means to not show sub navigation ever.
Type: String
Accepted Values:
yes,all,no
Example:
showSubNav('all')
|
| templateId |
The numeric id of the navigation template to use to display the menu.
Defaults to the value set for the navigation menu.
Type: Integer
Example:
templateId('6')
|
