menu.list ViewHelper `<vhs:menu.list>`¶

Arguments¶

additionalAttributes¶

DataType: mixed
Required: false
Description: Additional tag attributes. They will be added directly to the resulting HTML tag.

data¶

DataType: mixed
Required: false
Description: Additional data-* attributes. They will each be added with a "data-" prefix.

aria¶

DataType: mixed
Required: false
Description: Additional aria-* attributes. They will each be added with a "aria-" prefix.

class¶

DataType: string
Required: false
Description: CSS class(es) for this element

dir¶

DataType: string
Required: false
Description: Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left)

lang¶

DataType: string
Required: false
Description: Language for this element. Use short names specified in RFC 1766

style¶

DataType: string
Required: false
Description: Individual CSS styles for this element

title¶

DataType: string
Required: false
Description: Tooltip text of element

accesskey¶

DataType: string
Required: false
Description: Keyboard shortcut to access this element

tabindex¶

DataType: integer
Required: false
Description: Specifies the tab order of this element

onclick¶

DataType: string
Required: false
Description: JavaScript evaluated for the onclick event

forceClosingTag¶

DataType: boolean
Required: false
Description: If TRUE, forces the created tag to use a closing tag. If FALSE, allows self-closing tags.

hideIfEmpty¶

DataType: boolean
Required: false
Description: Hide the tag completely if there is no tag content

contenteditable¶

DataType: string
Required: false
Description: Specifies whether the contents of the element are editable.

contextmenu¶

DataType: string
Required: false
Description: The value of the id attribute on the menu with which to associate the element as a context menu.

draggable¶

DataType: string
Required: false
Description: Specifies whether the element is draggable.

dropzone¶

DataType: string
Required: false
Description: Specifies what types of content can be dropped on the element, and instructs the UA about which actions to take with content when it is dropped on the element.

translate¶

DataType: string
Required: false
Description: Specifies whether an elements attribute values and contents of its children are to be translated when the page is localized, or whether to leave them unchanged.

spellcheck¶

DataType: string
Required: false
Description: Specifies whether the element represents an element whose contents are subject to spell checking and grammar checking.

hidden¶

DataType: string
Required: false
Description: Specifies that the element represents an element that is not yet, or is no longer, relevant.

showAccessProtected¶

DataType: boolean
Required: false
Description: If TRUE links to access protected pages are always rendered regardless of user login status

classAccessProtected¶

DataType: string
Default: 'protected'
Required: false
Description: Optional class name to add to links which are access protected

classAccessGranted¶

DataType: string
Default: 'access-granted'
Required: false
Description: Optional class name to add to links which are access protected but access is actually granted

useShortcutUid¶

DataType: boolean
Required: false
Description: If TRUE, substitutes the link UID of a shortcut with the target page UID (and thus avoiding redirects) but does not change other data - which is done by using useShortcutData.

useShortcutTarget¶

DataType: boolean
Required: false
Description: Optional param for using shortcut target instead of shortcut itself for current link

useShortcutData¶

DataType: boolean
Required: false
Description: Shortcut to set useShortcutTarget and useShortcutData simultaneously

tagName¶

DataType: string
Default: 'ul'
Required: false
Description: Tag name to use for enclosing container

tagNameChildren¶

DataType: string
Default: 'li'
Required: false
Description: Tag name to use for child nodes surrounding links. If set to "a" enables non-wrapping mode.

entryLevel¶

DataType: integer
Required: false
Description: Optional entryLevel TS equivalent of the menu

levels¶

DataType: integer
Default: 1
Required: false
Description: Number of levels to render - setting this to a number higher than 1 (one) will expand menu items that are active, to a depth of $levels starting from $entryLevel

expandAll¶

DataType: boolean
Required: false
Description: If TRUE and $levels > 1 then expands all (not just the active) menu items which have submenus

classFirst¶

DataType: string
Required: false
Description: Optional class name for the first menu elment

classLast¶

DataType: string
Required: false
Description: Optional class name for the last menu elment

classActive¶

DataType: string
Default: 'active'
Required: false
Description: Optional class name to add to active links

classCurrent¶

DataType: string
Default: 'current'
Required: false
Description: Optional class name to add to current link

substElementUid¶

DataType: boolean
Required: false
Description: Optional parameter for wrapping the link with the uid of the page

showHiddenInMenu¶

DataType: boolean
Required: false
Description: Include pages that are set to be hidden in menus

showCurrent¶

DataType: boolean
Default: true
Required: false
Description: If FALSE, does not display the current page

linkCurrent¶

DataType: boolean
Default: true
Required: false
Description: If FALSE, does not wrap the current page in a link

linkActive¶

DataType: boolean
Default: true
Required: false
Description: If FALSE, does not wrap with links the titles of pages that are active in the rootline

titleFields¶

DataType: string
Default: 'nav_title,title'
Required: false
Description: CSV list of fields to use as link label - default is "nav_title,title", change to for example "tx_myext_somefield,subtitle,nav_title,title". The first field that contains text will be used. Field value resolved AFTER page field overlays.

includeAnchorTitle¶

DataType: boolean
Default: true
Required: false
Description: If TRUE, includes the page title as title attribute on the anchor.

includeSpacers¶

DataType: boolean
Required: false
Description: Wether or not to include menu spacers in the page select query

deferred¶

DataType: boolean
Required: false
Description: If TRUE, does not output the tag content UNLESS a v:page.menu.deferred child ViewHelper is both used and triggered. This allows you to create advanced conditions while still using automatic rendering

as¶

DataType: string
Default: 'menu'
Required: false
Description: If used, stores the menu pages as an array in a variable named after this value and renders the tag content. If the tag content is empty automatic rendering is triggered.

rootLineAs¶

DataType: string
Default: 'rootLine'
Required: false
Description: If used, stores the menu root line as an array in a variable named according to this value and renders the tag content - which means automatic rendering is disabled if this attribute is used

excludePages¶

DataType: mixed
Required: false
Description: Page UIDs to exclude from the menu. Can be CSV, array or an object implementing Traversable.

forceAbsoluteUrl¶

DataType: boolean
Required: false
Description: If TRUE, the menu will be rendered with absolute URLs

doktypes¶

DataType: mixed
Required: false
Description: DEPRECATED: Please use typical doktypes for starting points like shortcuts.

divider¶

DataType: string
Required: false
Description: Optional divider to insert between each menu item. Note that this does not mix well with automatic rendering due to the use of an ul > li structure

pages¶

DataType: mixed
Required: true
Description: Page UIDs to include in the menu. Can be CSV, array or an object implementing Traversable.

menu.list ViewHelper <vhs:menu.list>¶

Page: List Menu ViewHelper¶

Arguments¶

additionalAttributes¶

data¶

aria¶

class¶

dir¶

id¶

lang¶

style¶

title¶

accesskey¶

tabindex¶

onclick¶

forceClosingTag¶

hideIfEmpty¶

contenteditable¶

contextmenu¶

draggable¶

dropzone¶

translate¶

spellcheck¶

hidden¶

showAccessProtected¶

classAccessProtected¶

classAccessGranted¶

useShortcutUid¶

useShortcutTarget¶

useShortcutData¶

tagName¶

tagNameChildren¶

entryLevel¶

levels¶

expandAll¶

classFirst¶

classLast¶

classActive¶

classCurrent¶

substElementUid¶

showHiddenInMenu¶

showCurrent¶

linkCurrent¶

linkActive¶

titleFields¶

includeAnchorTitle¶

includeSpacers¶

deferred¶

as¶

rootLineAs¶

excludePages¶

forceAbsoluteUrl¶

doktypes¶

divider¶

pages¶

menu.list ViewHelper `<vhs:menu.list>`¶