Actions

J1.5

Difference between revisions of "Menu parameter type"

From Joomla! Documentation

m (Added more categorisations because this page is generic.)
(This is a parameter, not a form field.)
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
[[Image:Params.menu.jpg|right]]
 
[[Image:Params.menu.jpg|right]]
 +
 +
 +
{{Ambox|type=notice|text=[[Parameter|Parameters]] have been superseded by [[Form field|form fields]] in Joomla! 1.6. You may want to use the corresponding [[Menu form field type]].}}
 +
 
The '''menu''' parameter type provides a drop down list of the available menus from your Joomla site.  If the parameter has a saved value this is selected when the page is first loaded.  If not, the default value (if any) is selected.  
 
The '''menu''' parameter type provides a drop down list of the available menus from your Joomla site.  If the parameter has a saved value this is selected when the page is first loaded.  If not, the default value (if any) is selected.  
  
Line 11: Line 15:
  
 
Example XML parameter definition:
 
Example XML parameter definition:
<source lang="xml"><param name="mymenu" type="menu" default="mainmenu" label="Select a menu" description=”Select a menu” /></source>
+
<source lang="xml"><param name="mymenu" type="menu" default="mainmenu" label="Select a menu" description="Select a menu" /></source>
 
<noinclude>
 
<noinclude>
 
=== See also ===
 
=== See also ===
 
* [[Menuitem parameter type]]
 
* [[Menuitem parameter type]]
* [[Standard parameter types|Full list of standard parameter types]]
+
* [[Standard parameter types|List of standard parameter types]]
[[Category:Components]][[Category:Modules]][[Category:Plugins]][[Category:Templates]][[Category:Development]]</noinclude>
+
[[Category:Standard parameter types]]</noinclude>

Revision as of 07:36, 21 May 2011

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.
Params.menu.jpg


The menu parameter type provides a drop down list of the available menus from your Joomla site. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if any) is selected.

The first option on the list is always '- Select Menu -' (which is a translatable string) and is given the value 0.

  • type (mandatory) must be menu.
  • name (mandatory) is the unique name of the parameter.
  • label (mandatory) (translatable) is the descriptive title of the field.
  • default (optional) is the default menu. Note that this is the name of the menu shown in the Type column on the Menu Manager screen and not the menu ID number.
  • description (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.

Example XML parameter definition:

<param name="mymenu" type="menu" default="mainmenu" label="Select a menu" description="Select a menu" />

See also