J1.5:Radio parameter type
From Joomla! Documentation
(Difference between revisions)
m (Fixed category mess) |
(This is a parameter, not a form field.) |
||
| Line 1: | Line 1: | ||
[[Image:Params.radio.jpg|right]] | [[Image:Params.radio.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 [[Radio form field type]].}} | ||
| + | |||
The '''radio''' parameter type provides radio buttons to select different options. 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 '''radio''' parameter type provides radio buttons to select different options. 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 23: | Line 26: | ||
=== See also === | === See also === | ||
* [[List parameter type]] | * [[List parameter type]] | ||
| − | * [[Standard | + | * [[Standard parameter types|List of standard parameter types]] |
| − | [[Category:Standard | + | [[Category:Standard parameter types]]</noinclude> |
Revision as of 07:55, 21 May 2011
| Parameters have been superseded by form fields in Joomla! 1.6. You may want to use the corresponding Radio form field type. |
The radio parameter type provides radio buttons to select different options. 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 radio.
- name (mandatory) is the unique name of the parameter.
- label (mandatory) (translatable) is the descriptive title of the field.
- default (optional) is the default radio button 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.
The XML <param> element must include one or more <option> elements which define the individual radio button items. The text between the <option> and </option> tags is shown as the label for the radio button 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="myradiovalue" type="radio" default="0" label="Select an option" description=""> <option value="0">1</option> <option value="1">2</option> </param>
