Joomla! Programmers Documentation

Manual Index

Quicktask Link and Icon

In general, a component has one or more links to its views. They are defined in the manifest file and added to the menu during installation.

<administration>
	<menu>
		COM_EXAMPLE
	</menu>
	
	[..]
</administration>

Sometimes it is useful to add a so called quicktask link which enables an action calling from the menu without first visiting the Overview. You can see this for Joomla core components, for example articles in com_content, here the quicktask is the plus icon and lets you add a new article in a single click. Your menu link is added in the manfest file during installation.

Quicktask Link and Title

A quicktask link and title are added as params to a menu item.

<menu link="option=com_example&amp;view=examples">
    COM_EXAMPLE
    <params>
        <menu-quicktask-title>COM_EXAMPLE_MENU_QUICKTASK_TITLE</menu-quicktask-title>
        <menu-quicktask>index.php?option=com_example&amp;view=example&amp;layout=edit</menu-quicktask>
    </params>
</menu>

The title translation string needs to appear in the language .sys.ini file for the extension

Quicktask Icon

The default icon is the '+' sign indicating create a new item as this is the most common usage in the built-in compponents.

You can specify a different icon, either as a simple name for the built in common aliased icons (the icon- prefix will be automatically added), or as the font-awesome specification.

<menu link="option=com_example&amp;view=examples">
    COM_EXAMPLE
    <params>
        <menu-quicktask-title>COM_EXAMPLE_MENU_QUICKTASK_TITLE</menu-quicktask-title>
        <menu-quicktask-icon>eye</menu-quicktask-icon>
        <menu-quicktask>index.php?option=com_example&amp;view=example&amp;layout=view</menu-quicktask>
    </params>
</menu>

Example

This example shows a complete menu entry with dashboard, submenu and a quicktask. The second item with a quicktask includes a fontawesome icon that has not been aliased.

<menu>
    COM_EXAMPLE
    <params>
        <dashboard>example</dashboard>
    </params>
</menu>
<submenu>
    <menu link="option=com_example">
        COM_EXAMPLE_MENU
        <params>
            <menu-quicktask-title>COM_EXAMPLE_MENU_QUICKTASK_TITLE</menu-quicktask-title>
            <menu-quicktask>index.php?option=com_example&amp;view=example&amp;layout=edit</menu-quicktask>
        </params>
    </menu>
    <menu link="option=com_categories&amp;extension=com_example">
        COM_EXAMPLE_MENU_CATEGORIES
        <params>
            <menu-quicktask-title>COM_EXAMPLE_MENU_CATEGORIES</menu-quicktask-title>
            <menu-quicktask-icon>fas fa-person-hiking</menu-quicktask-icon>
            <menu-quicktask>index.php?option=com_categories&amp;view=category&amp;layout=edit&amp;extension=com_example</menu-quicktask>
        </params>
    </menu>
    <menu link="option=com_fields&amp;view=fields&amp;context=com_example,example">COM_EXAMPLE_MENU_FIELDS</menu>
    <menu link="option=com_fields&amp;view=groups&amp;context=com_example,example">COM_EXAMPLE_MENU_FIELDS_GROUP</menu>
</submenu>