Checkbox form field type
From Joomla! Documentation
Revision as of 11:29, 3 October 2012 by Phproberto (talk | contribs) (Add information about how to set the uncheck status)
Revision as of 11:29, 3 October 2012 by Phproberto (talk | contribs) (Add information about how to set the uncheck status)
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function 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 default value of the checkbox. If exist the checkbox will be checked by default.
- 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" />