Joomlafreaks: type=list was chagned to groupedlist, in the example code.

2012-03-30T11:30:59Z

type=list was chagned to groupedlist, in the example code.

Garnesson: Created page with "{{Ambox|type=notice|text=In Joomla! 1.5, form fields were parameters.}} The '''groupedlist''' form field type provides a drop ..."

2012-03-24T15:32:20Z

Created page with "<noinclude>{{Ambox|type=notice|text=In Joomla! 1.5, form fields were parameters.}}</noinclude> The '''groupedlist''' form field type provides a drop ..."

New page

<noinclude>{{Ambox|type=notice|text=In Joomla! 1.5, [[Form field|form fields]] were [[Parameter|parameters]].}}</noinclude>
The '''groupedlist''' form field type provides a drop down list or a list box of custom-defined entries which has the ability to show grouped data. If the field 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 ''groupedlist''.
* '''name''' (mandatory) is the unique name of the field.
* '''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'.
* '''multiple''' (optional) is whether multiple items can be selected at the same time (''true'' or ''false'').

The XML <code><field></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 <code><option></code> tag takes the following argument:

* '''value''' (mandatory) is the value that will be saved for the field if this item is selected.

Tip: Don't forget to close the field definition with <code></field></code>.

To group the data simply put a <code><group></code> before the <code><option></code> elements you want to group and a <code></group></code> after them. The <code><group></code> tag takes the following argument:

* '''label''' (translatable) is the text shown in the list.

Example XML field definition:
<source lang="xml"><field name="mylistvalue" type="list" default="" label="Select an option" description="">
<group label="Group 1">
<option value="0">Option 1</option>
<option value="1">Option 2</option>
</group>
<group label="Group 2">
<option value="3">Option 3</option>
<option value="4">Option 4</option>
</group>
<option value="5">Option 5</option>
<option value="6">Option 6</option>
</field>
</source>
<noinclude>
=== See also ===
* [[List form field type]]
* [[Filelist form field type]]
* [[Folderlist form field type]]
* [[Imagelist form field type]]
* [[Standard form field types|List of standard form field types]]
[[Category:Standard form field types]]</noinclude>

@@ Line 21: / Line 21: @@
 Example XML field definition:
-<source lang="xml"><field name="mylistvalue" type="list" default="" label="Select an option" description="">
+<source lang="xml"><field name="mylistvalue" type="groupedlist" default="" label="Select an option" description="">
    <group label="Group 1">
      <option value="0">Option 1</option>

Groupedlist form field type - Revision history

Joomlafreaks: type=list was chagned to groupedlist, in the example code.

Garnesson: Created page with "{{Ambox|type=notice|text=In Joomla! 1.5, form fields were parameters.}} The '''groupedlist''' form field type provides a drop ..."