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" />
Copied!
Output:
<input type="checkbox" name="myCheckBox" value="someValue" />
Copied!
Preselect
<f:form.checkbox name="myCheckBox" value="someValue" checked="{object.value} == 5" />
Copied!
Output:
<input type="checkbox" name="myCheckBox" value="someValue" checked="checked" />
Copied!
Depending on bound object to surrounding f:form.
Bind to object property
<f:form.checkbox property="interests" value="TYPO3" multiple="1" />
Copied!
Output:
<input type="checkbox" name="user[interests][]" value="TYPO3" checked="checked" />
Copied!
Depending on property interests.
Source code
Go to the source code of this ViewHelper: Form\CheckboxViewHelper.php (GitHub).
Arguments
Allows arbitrary arguments
This ViewHelper allows you to pass arbitrary arguments not defined below directly
to the HTML tag created. This includes custom
data- arguments.
The following arguments are available for the form.checkbox ViewHelper:
additionalAttributes
-
- Type
- array
Additional tag attributes. They will be added directly to the resulting HTML tag.
aria
-
- Type
- array
Additional aria-* attributes. They will each be added with a "aria-" prefix.
checked
-
- Type
- bool
Specifies that the input element should be preselected
data
-
- Type
- array
Additional data-* attributes. They will each be added with a "data-" prefix.
errorClass
-
- Type
- string
- Default
- 'f3-form-error'
CSS class to set if there are errors for this ViewHelper
multiple
-
- Type
- bool
- Default
- false
Specifies whether this checkbox belongs to a multivalue (is part of a checkbox group)
name
-
- Type
- string
Name of input tag
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.
value
-
- Type
- string
- Required
- 1
Value of input tag. Required for checkboxes