Dionysopoulos.me

Normally not set. You can set it to separator. In this case do not set a link or view attribute; the text content of the menu item will be rendered as a non-linked header in the menu structure.

Only applies if you are using the link attribute. Corresponds to the <a> HTML tag's target attribute. Useful if you want to create a menu item linking to an external site and you'd like to open it in a new tab / window; in this case set target="_blank".

A link the browser will navigate to. You should ideally only use this to point to pages of components other than yours, e.g. index.php?option=com_categories&extension=com_example to display the categories management interface through Joomla's com_categories core component.

Note that a link pointing to another page in the site's backend is relative to /administrator. Do not put /administrator in front, though; this would break the menu for sites which are installed in subdirectories.

This attribute is mutually exclusive with view. If both are set, link will be applied.

The view of the current component you want to link to.

For example, if we are in the XML manifest of the com_example component and you set view="welcome" it's the same as if you had used link="index.php?option=com_example&view=welcome".

This attribute is mutually exclusive with link. If both are set, link will be applied.

While you will normally only see that in menu presets used in Dashboards, this is perfectly supported in the component's menu as well.

When set, a badge will appear next to the title. Joomla will perform an AJAX request to the URL provided in the value of this attribute. This URL is supposed to return a JSON document with the following keys:

{
  "success": true,
  "error": "",
  "data": "something"
}

If the success key is true Joomla will take the data key's value, sanitise its HTML (only allowing a subset of tags and attributes you can find in the build/media_source/system/js/core.es6.js file in Joomla's repository) and put that sanitised HTML in the badge.

This is typically used to display the number of items which require attention.

	Warning
	Do not go overboard with this feature! This AJAX request will run on every page of your site's backend, slowing everything down. I have not yet seen a practical use case where this is even remotely acceptable.

If set, it creates a dashboard icon next to the menu item's title, linking to the named dashboard.

Example: <dashboard>com_example.example</dashboard>.

The Joomla ACL permission the user needs to have to see this menu item (and all its sub-items, if any).

To use global permissions (set in the Permissions tab of Global Configuration) use the format <menu-permission>core.manage</menu-permission>

To use component-level permissions (set in the Permissions tab of a component) use the format <menu-permission>core.manage;com_example</menu-permission>

You can NOT ask Joomla to combine multiple permissions i.e. you cannot ask it to only display a menu item if two or more permissions are simultaneously granted; or if one of several permissions is granted. The reason for that can be found in the code of \Joomla\Module\Submenu\Administrator\Menu\Menu::preprocess.

Menu items can have an optional “quick task” shown next to them. This is a small button with an icon and no visible text (the text is only made available to users of assistive technologies for accessibility reasons). The value of this parameter is the URL to visit when the quick task button is used. It follows the same rules as the link attribute.

Example: <menu-quicktask>index.php?option=com_example&amp;task=item.add</menu-quicktask>

	Note
	While this is typically used to render a [+] icon button to add new items, this is not necessary. You can use whatever action feels right in context and whichever icon you think is appropriate for the action.

The icon class for the quick task. If it's not specified it will default to plus.

The contents of this parameter are prefixed with the string literal icon- to create the HTML class attribute. For example, <menu-quicktask-icon>cog</menu-quicktask-icon> will result in class="icon-cog" which displays a cog wheel icon.

A language string which describes the quick task to users of assistive technologies (e.g. screen readers, Braille displays, …). If not defined, the language string MOD_MENU_QUICKTASK_NEW (New Item) will be used.

Equivalent to menu-permission but applies to the quick task instead. Use this to limit who should be able to view the quick task icon.

The (relative) URL to an image file to use for the menu item.

This is mutually exclusive with the menu-icon parameter.

Note

It is generally bad form using images for menu items. Images, especially raster (bitmap) images, may not display very well and make the backend of the site look cheap and unprofessional. Images, unlike language strings, are untranslatable and cannot be replaced for different languages and cultures. Iconography with vector images may have radically different meanings depending on the cultural context and personal circumstances. For example, an open palm facing the user with fingers spread out means "stop" in the USA but is a vulgar gesture in Greece and Cyprus (it literally means “I spread feces on your face”). A beer mug is a relatively inoffensive icon unless you're putting that in front of Muslims who are required to abstain from alcohol per their religion or recovering alcoholics (or those who've lost a loved one to a DUI fatal accident) who may find that iconography triggering. You MUST NOT use an icon instead of human-readable text content for the title of the menu item. This is inaccessible to people with disabilities such as hard-of-seeing or blind people, people with cognitive disabilities etc.

When provided it will set the menu item's icon class to the string literal class- followed by the contents of this parameter. For example, <menu-image>cog<menu-image> will result in class="icon-cog" being applied to the menu item's icon <span> tag.

This is mutually exclusive with the menu_image parameter.

Only applies when the type="separator" attribute is used. When set to 1 it will render the separator as an <hr> tag instead of text.