Checkbox form field type - Revision history

E-builds: Adding a warning about saving unchecked checkboxes. Apparently a lot of component developers come across this as they think joomla handles this. It does not!

2013-01-29T17:37:00Z

Adding a warning about saving unchecked checkboxes. Apparently a lot of component developers come across this as they think joomla handles this. It does not!

Waveywhite at 19:34, 12 October 2012

2012-10-12T19:34:17Z

Phproberto: Add information about how to set the uncheck status

2012-10-03T16:29:38Z

Add information about how to set the uncheck status

Mvangeest: Changed examples for consistency with other form field types

2012-08-24T16:00:05Z

Changed examples for consistency with other form field types

Enav at 16:28, 31 July 2012

2012-07-31T16:28:21Z

Enav at 16:22, 31 July 2012

2012-07-31T16:22:42Z

Deldadam: Example corrected as well

2012-03-25T21:40:52Z

Example corrected as well

Deldadam: There is no drop-down box screen element

2012-03-25T21:40:11Z

There is no drop-down box screen element

Deldadam at 21:11, 25 March 2012

2012-03-25T21:11:09Z

Samcoult: Created page with "The '''checkbox''' form field type provides a single checkbox. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if ..."

2012-01-15T19:23:27Z

Created page with "The '''checkbox''' form field type provides a single checkbox. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if ..."

New page

The '''checkbox''' form field type provides a single checkbox. 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 checkbox
* '''name''' (mandatory) is the unique name of the parameter.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''default''' (optional) is the default value of the checkbox
* '''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'.

Example XML parameter definition:
<source lang="xml"><field name="mycheckbox" type="checkbox" label="Show title" description="" default="0" /></source>
<noinclude>
=== See also ===
* [[Standard form field types|List of standard form field types]]
[[Category:Standard form field types]]</noinclude>

@@ Line 4: / Line 4: @@
 * '''name''' (mandatory) is the unique name of the parameter.
 * '''label''' (mandatory) (translatable) is the descriptive title of the field.
-* '''value''' (optional) is the default value of the checkbox. If exist the checkbox will be checked by default.
+* '''value''' (optional) is the value of the parameter if this checkbox is set (usually 1).
 * '''default''' (optional) is the default value (usually 0 or 1).
 * '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the label.

@@ Line 7: / Line 7: @@
 * '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the label.
 * '''class''' (optional) is a CSS class name for the HTML form field.  If omitted this will default to 'inputbox'.
 <noinclude>
-=== Examples XML parameter definition: ===
+<source lang="xml"><field name="show_title" type="checkbox" label="Show title" description="Show the title of the item" value="1" /></source>
-−
-==== Example ====
-<source lang="xml"><field name="mycheckbox" type="checkbox" label="Show title" description="" value="1" /></source>
-−
-==== Example ====
-<source lang="xml">
-<field
-	name="kitchen_distribution_option_1"
-	id="kitchen-distribution-option_1"
-	type="checkbox"
-	label="COM_COTIZACION_KITCHEN_DISTRIBUTION_OPTION_1_LABEL"
-	description="COM_COTIZACION_KITCHEN_DISTRIBUTION_OPTION_1_DESC"
-	value="1"
-/>
-</source>
-−
-−
-−
-−
 === See also ===
 * [[Standard form field types|List of standard form field types]]
 [[Category:Standard form field types]]</noinclude>

@@ Line 8: / Line 8: @@
 * '''class''' (optional) is a CSS class name for the HTML form field.  If omitted this will default to 'inputbox'.
 <noinclude>
-=== Example ===
+=== Examples XML parameter definition: ===
 <source>
 <field
 	name="kitchen_distribution_option_1"
@@ Line 23: / Line 26: @@
 />
 </source>