J1.5:List parameter type
From Joomla! Documentation
(Difference between revisions)
(New page: right The list parameter type provides a drop down list of custom-defined entries. If the parameter has a saved value this is selected when the page is first loa...) |
(This is a parameter, not a form field.) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
[[Image:Params.list.jpg|right]] | [[Image:Params.list.jpg|right]] | ||
| − | The list parameter type provides a drop down list of custom-defined entries. 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. | + | |
| + | {{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 [[List form field type]].}} | ||
| + | |||
| + | The '''list''' parameter type provides a drop down list of custom-defined entries. 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. | ||
* '''type''' (mandatory) must be ''list''. | * '''type''' (mandatory) must be ''list''. | ||
| Line 9: | Line 12: | ||
* '''class''' (optional) is a CSS class name for the HTML form field. If omitted this will default to 'inputbox'. | * '''class''' (optional) is a CSS class name for the HTML form field. If omitted this will default to 'inputbox'. | ||
| − | The XML < | + | The XML <code><param></code> element must include one or more <code><option></code> elements which define the list items. The text between the <code><option></code> and <code></option></code> tags is what will be shown in the drop down list and is a translatable string. The <option> tag takes the following argument: |
| − | value (mandatory) is the value that will be saved for the parameter if this item is selected. | + | |
| + | * '''value''' (mandatory) is the value that will be saved for the parameter if this item is selected. | ||
| − | Tip: Don't forget to close the parameter definition with < | + | Tip: Don't forget to close the parameter definition with <code></param></code>. |
Example XML parameter definition: | Example XML parameter definition: | ||
| Line 25: | Line 29: | ||
* [[Folderlist parameter type]] | * [[Folderlist parameter type]] | ||
* [[Imagelist parameter type]] | * [[Imagelist parameter type]] | ||
| − | * [[Standard parameter types| | + | * [[Standard parameter types|List of standard parameter types]] |
| − | + | [[Category:Standard parameter types]]</noinclude> | |
| − | [[Category: | + | |
Revision as of 07:32, 21 May 2011
| Parameters have been superseded by form fields in Joomla! 1.6. You may want to use the corresponding List form field type. |
The list parameter type provides a drop down list of custom-defined entries. 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.
- type (mandatory) must be list.
- name (mandatory) is the unique name of the parameter.
- label (mandatory) (translatable) is the descriptive title of the field.
- default (optional) is the default list item value.
- description (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
- class (optional) is a CSS class name for the HTML form field. If omitted this will default to 'inputbox'.
The XML <param> element must include one or more <option> elements which define the list items. The text between the <option> and </option> tags is what will be shown in the drop down list and is a translatable string. The <option> tag takes the following argument:
- value (mandatory) is the value that will be saved for the parameter if this item is selected.
Tip: Don't forget to close the parameter definition with </param>.
Example XML parameter definition:
<param name="mylistvalue" type="list" default="" label="Select an option" description=""> <option value="0">Option 1</option> <option value="1">Option 2</option> </param>
