Difference between revisions of "Checkbox form field type"
From Joomla! Documentation
ADaneInSpain (talk | contribs) (Removed references to "default" as it is not relevant on a checkbox and added the attribute "checked" which was missing) |
(Added deprecation notice and link to Joomla Manual) |
||
| Line 1: | Line 1: | ||
<noinclude><languages /></noinclude> | <noinclude><languages /></noinclude> | ||
| + | {{Warning|This page has been superseded and is no longer maintained. Please go to [https://manual.joomla.org/docs/general-concepts/forms-fields/standard-fields/checkbox Joomla Manual Checkbox Field] instead}} | ||
| + | |||
<translate><!--T:1--> | <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> | 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> | ||
Latest revision as of 17:17, 15 July 2024
Warning!
This page has been superseded and is no longer maintained. Please go to Joomla Manual Checkbox Field instead
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).
- checked (optional) should be set to 1 to check the checkbox by default or 0 not to.
- 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 (checked):
<field name="show_title" type="checkbox" label="Show title" description="Show the title of the item" value="1" checked="1" />
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.