form.checkbox¶
View Helper which creates a simple checkbox (<input type=”checkbox”>).
Examples¶
Example:
<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 $object)
Bind to object property:
<f:form.checkbox property="interests" value="TYPO3" />
Output:
<input type="checkbox" name="user[interests][]" value="TYPO3" checked="checked" />
(depending on property “interests”)
Arguments¶
additionalAttributes¶
- DataType
- mixed
- Required
- true
- Description
- Additional tag attributes. They will be added directly to the resulting HTML tag.
data¶
- DataType
- mixed
- Required
- true
- Description
- Additional data-* attributes. They will each be added with a “data-” prefix.
name¶
- DataType
- string
- Required
- true
- Description
- Name of input tag
value¶
- DataType
- string
- Required
- true
- Description
- Value of input tag. Required for checkboxes
property¶
- DataType
- string
- Required
- true
- Description
- Name of Object Property. If used in conjunction with <f:form object=”…”>, “name” and “value” properties will be ignored.
disabled¶
- DataType
- string
- Required
- true
- Description
- Specifies that the input element should be disabled when the page loads
errorClass¶
- DataType
- string
- Default
- ‘f3-form-error’
- Required
- true
- Description
- CSS class to set if there are errors for this view helper
class¶
- DataType
- string
- Required
- true
- Description
- CSS class(es) for this element
dir¶
- DataType
- string
- Required
- true
- Description
- Text direction for this HTML element. Allowed strings: “ltr” (left to right), “rtl” (right to left)
id¶
- DataType
- string
- Required
- true
- Description
- Unique (in this file) identifier for this HTML element.
lang¶
- DataType
- string
- Required
- true
- Description
- Language for this element. Use short names specified in RFC 1766
style¶
- DataType
- string
- Required
- true
- Description
- Individual CSS styles for this element
title¶
- DataType
- string
- Required
- true
- Description
- Tooltip text of element
accesskey¶
- DataType
- string
- Required
- true
- Description
- Keyboard shortcut to access this element
tabindex¶
- DataType
- integer
- Required
- true
- Description
- Specifies the tab order of this element
onclick¶
- DataType
- string
- Required
- true
- Description
- JavaScript evaluated for the onclick event
checked¶
- DataType
- mixed
- Required
- true
- Description
- Specifies that the input element should be preselected
multiple¶
- DataType
- mixed
- Required
- true
- Description
- Specifies whether this checkbox belongs to a multivalue (is part of a checkbox group)