Actions

Difference between revisions of "Checkbox form field type"

From Joomla! Documentation

(Marked this version for translation)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
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.
+
<noinclude><languages /></noinclude>
 +
<translate><!--T:1-->
 +
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.</translate>
  
* '''type''' (mandatory) must be checkbox
+
<translate><!--T:2-->
 +
* '''type''' (mandatory) must be checkbox</translate>
 
* '''name''' (mandatory) is the unique name of the parameter.
 
* '''name''' (mandatory) is the unique name of the parameter.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
+
<translate><!--T:3-->
* '''value''' (optional) is the value of the parameter if this checkbox is set (usually 1).
+
* '''label''' (mandatory) (translatable) is the descriptive title of the field.</translate>
* '''default''' (optional) is the default value (usually 0 or 1).
+
<translate><!--T:4-->
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the label.
+
* '''value''' (optional) is the value of the parameter if this checkbox is set (usually 1).</translate>
* '''class''' (optional) is a CSS class name for the HTML form field.  If omitted this will default to 'inputbox'.
+
<translate><!--T:5-->
<noinclude>
+
* '''default''' (optional) is the default value (usually 0 or 1).</translate>
Example XML field definition:
+
<translate><!--T:6-->
 +
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the label.</translate>
 +
<translate><!--T:7-->
 +
* '''class''' (optional) is a CSS class name for the HTML form field.  If omitted this will default to 'inputbox'.</translate>
  
 +
<translate><!--T:8-->
 +
Example XML field definition:</translate>
 
<source lang="xml"><field name="show_title" type="checkbox" label="Show title" description="Show the title of the item" value="1" /></source>
 
<source lang="xml"><field name="show_title" type="checkbox" label="Show title" description="Show the title of the item" value="1" /></source>
  
Example XML field definition (unchecked):
+
<translate><!--T:9-->
 +
Example XML field definition (unchecked):</translate>
  
 
<source lang="xml"><field name="show_title" type="checkbox" label="Show title" description="Show the title of the item" value="1" default="0" /></source>
 
<source lang="xml"><field name="show_title" type="checkbox" label="Show title" description="Show the title of the item" value="1" default="0" /></source>
  
=== See also ===
+
 
* [[Standard form field types|List of standard form field types]]
+
{{warning|<translate><!--T:10-->
[[Category:Standard form field types]]</noinclude>
+
Special care needs to be taken with saving a checkbox from a form!! This is a common mistake. <br>You see, on saving a form with a checkbox that is unchecked, there is no variable for it in the POST information and joomla does not take care of that yet! <br>See Discussion on [[Talk:Checkbox form field type|this page]] for more.</translate>}}
 +
<translate>=== See also === <!--T:11--></translate>
 +
<translate><!--T:12-->
 +
* [[S:MyLanguage/Standard form field types|List of standard form field types]]</translate>
 +
 
 +
<noinclude>
 +
<translate>
 +
<!--T:13-->
 +
[[Category:Standard form field types]]
 +
</translate>
 +
</noinclude>

Latest revision as of 14:20, 10 August 2015

Other languages:
English • ‎français

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.
  • 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.
  • class (optional) is a CSS class name for the HTML form field. If omitted this will default to 'inputbox'.

Example XML field definition:

<field name="show_title" type="checkbox" label="Show title" description="Show the title of the item" value="1" />

Example XML field definition (unchecked):

<field name="show_title" type="checkbox" label="Show title" description="Show the title of the item" value="1" default="0" />


Stop hand nuvola.svg.png
Warning!

Special care needs to be taken with saving a checkbox from a form!! This is a common mistake.
You see, on saving a form with a checkbox that is unchecked, there is no variable for it in the POST information and joomla does not take care of that yet!
See Discussion on this page for more.

See also