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

The following arguments are available for the form.checkbox ViewHelper:

accesskey
Type
string
Keyboard shortcut to access this element
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
class
Type
string
CSS class(es) for this element
data
Type
array
Additional data-* attributes. They will each be added with a "data-" prefix.
dir
Type
string
Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left)
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
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
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
onclick
Type
string
JavaScript evaluated for the onclick event
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.
style
Type
string
Individual CSS styles for this element
tabindex
Type
integer
Specifies the tab order of this element
title
Type
string
Tooltip text of element
value
Type
string
Required
1
Value of input tag. Required for checkboxes