Menu Item

Menu Item

{{ menu_item }}

Name Type Description
object_type String Will always be datastore_item
is_valid Boolean True if this references a published menu_item
guid String The unique identifier for this menu_item
value String Contains the same value as guid
menu_guid String The unique identifier of the related menu
menu menu Reference to the related menu object
parent_menu_item_guid String The unique identifier of the parent menu_item, if applicable
parent_menu_item menu_item Reference to the parent menu_item object, if applicable
name text The lable used to display this menu_item in the navigation menu
href url Destination URL to navigate to when clicked
open_in_new_tab Boolean If true, the link should open in a new browser tab/window
description textarea Short descriptive text to display with this menu_item
content html HTML content to display with this menu_item
image_guid String The unique identifier of the related image
image image Reference to the related image object
depth Integer Hierarchy depth of this item within its parent structure, where top-level menu items have a depth of 1, their children have a depth of 2, and so on
order Integer Display order of this item relative to its siblings
items menu_items A list containing all of the menu items that are direct children of the current menu item
field_id String The identifier for this field
label String The label for this field
output String The default output that the menu_item produces when output directly to the template. The default output may change at any time. Template developers should avoid using this and should handle the output of menu items themselves

{{ menu_items }}

Contains multiple menu_items.

Name Type Description
output String The default output that the menu_items will produce when it is output directly to the template - using the "output_in_list" property of each menu_item in the items list

{% menu_item %}

{% menu_item
var|set|assign
 
Optional. Specify either "var", "set" or "assign" to change which scope this menu_item is stored on. "var" is the default behavior.
variable_name
 
Specify a variable name in order to save this menu_item to a variable. If not specified, it will be output to the template instead.
output_to_template
 
If included the menu_item will be output directly to the template.
=
%}

{% menu_items %}

{% menu_items
var|set|assign
 
Optional. Specify either "var", "set" or "assign" to change which scope this menu_items is stored on. "var" is the default behavior.
variable_name
 
Specify a variable name in order to save this menu_items to a variable. If not specified, it will be output to the template instead.
output_to_template
 
If included the menu_items will be output directly to the template.
=
prepend:value
 
Prepend the specified menu_items before the fetched results. All prepended input will be returned in the same order that it is input. Value may one or more menu_items, a guid, or a string.
append:value
 
Append the specified menu_items after the fetched results. All appended input will be returned in the same order that it is input. Value may one or more menu_items, a guid, or a string.
exclude:value
 
Prevent the specified menu_items from being included in the fetched results. Has no affect on prepended and appended items. Value may one or more menu_items, a guid, or a string.
exclude_prepended:true
 
Specifically exclude all prepended menu_items from the fetched results. If "unique:true" is specified this is the default behavior, although you may also specify "exclude_prepended:false" to allow any prepended items to be fetched along with other results anyway.
exclude_appended:true
 
Specifically exclude all appended menu_items from the fetched results. This is false by default - even if "unique:true" is specified - so that results are returned in the proper order.
unique:true
 
If set to true, each of the resulting lists (prepended, fetched, appended, and items) will be unique, although there may be duplicates between the prepended, fetched, and appended lists. The "items" list will include objects in the order in which they appear - with prepended items first, then fetched items, then appended items.
max_size:number
 
If specified, then the "items" list will only include up to the specified number of menu_items. The "limit" may be automatically lowered to only fetch the maximum number of articles that will be included in "items" following prepended items. Note that this may also impact both the "page" and "total_pages" values. In order to use pagination with a list loaded using "max_size" use "start" instead of "page" and "limit".
%}