Attention
TYPO3 v11 has reached end-of-life as of October 31th 2024 and is no longer being maintained. Use the version switcher on the top left of this page to select documentation for a supported version of TYPO3.
Need more time before upgrading? You can purchase Extended Long Term Support (ELTS) for TYPO3 v11 here: TYPO3 ELTS.
Form.checkbox ViewHelper <f:form.checkbox>
ViewHelper which creates a simple checkbox <input type="checkbox">.
Examples
Simple one
<f:form.checkbox name="myCheckBox" value="someValue" />
Output:
<input type="checkbox" name="myCheckBox" value="someValue" />
Preselect
<f:form.checkbox name="myCheckBox" value="someValue" checked="{object.value} == 5" />
Output:
<input type="checkbox" name="myCheckBox" value="someValue" checked="checked" />
Depending on bound object to surrounding f:form.
Bind to object property
<f:form.checkbox property="interests" value="TYPO3" multiple="1" />
Output:
<input type="checkbox" name="user[interests][]" value="TYPO3" checked="checked" />
Depending on property interests.
Source code
Go to the source code of this ViewHelper: CheckboxViewHelper.php (GitHub).
Arguments
The following arguments are available for <f::
additionalAttributes
-
- Type
- mixed
Additional tag attributes. They will be added directly to the resulting HTML tag.
data
-
- Type
- mixed
Additional data-* attributes. They will each be added with a "data-" prefix.
aria
-
- Type
- mixed
Additional aria-* attributes. They will each be added with a "aria-" prefix.
name
-
- Type
- string
Name of input tag
value
-
- Type
- string
- Required
true
Value of input tag. Required for checkboxes
property
-
- Type
- string
Name of Object Property. If used in conjunction with <f:form object="...">, the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value.
disabled
-
- Type
- string
Specifies that the input element should be disabled when the page loads
errorClass
-
- Type
- string
- Default
'f3-form- error'
CSS class to set if there are errors for this ViewHelper
class
-
- Type
- string
CSS class(es) for this element
dir
-
- Type
- string
Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left)
id
-
- Type
- string
Unique (in this file) identifier for this HTML element.
lang
-
- Type
- string
Language for this element. Use short names specified in RFC 1766
style
-
- Type
- string
Individual CSS styles for this element
title
-
- Type
- string
Tooltip text of element
accesskey
-
- Type
- string
Keyboard shortcut to access this element
tabindex
-
- Type
- integer
Specifies the tab order of this element
onclick
-
- Type
- string
JavaScript evaluated for the onclick event
checked
-
- Type
- boolean
Specifies that the input element should be preselected
multiple
-
- Type
- boolean
Specifies whether this checkbox belongs to a multivalue (is part of a checkbox group)