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" />

Output:

<input type="checkbox" name="user[interests][]" value="TYPO3" checked="checked" />

Depending on property interests.

Arguments

additionalAttributes

DataType

mixed

Required

false

Description

Additional tag attributes. They will be added directly to the resulting HTML tag.

data

DataType

mixed

Required

false

Description

Additional data-* attributes. They will each be added with a "data-" prefix.

aria

DataType

mixed

Required

false

Description

Additional aria-* attributes. They will each be added with a "aria-" prefix.

name

DataType

string

Required

false

Description

Name of input tag

value

DataType

string

Required

false

Description

Value of input tag. Required for checkboxes

property

DataType

string

Required

false

Description

Name of Object Property. If used in conjunction with <f:form object="...">, "name" and "value" properties will be ignored.

disabled

DataType

string

Required

false

Description

Specifies that the input element should be disabled when the page loads

errorClass

DataType

string

Default

'f3-form-error'

Required

false

Description

CSS class to set if there are errors for this ViewHelper

class

DataType

string

Required

false

Description

CSS class(es) for this element

dir

DataType

string

Required

false

Description

Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left)

id

DataType

string

Required

false

Description

Unique (in this file) identifier for this HTML element.

lang

DataType

string

Required

false

Description

Language for this element. Use short names specified in RFC 1766

style

DataType

string

Required

false

Description

Individual CSS styles for this element

title

DataType

string

Required

false

Description

Tooltip text of element

accesskey

DataType

string

Required

false

Description

Keyboard shortcut to access this element

tabindex

DataType

integer

Required

false

Description

Specifies the tab order of this element

onclick

DataType

string

Required

false

Description

JavaScript evaluated for the onclick event

checked

DataType

mixed

Required

false

Description

Specifies that the input element should be preselected

multiple

DataType

mixed

Required

false

Description

Specifies whether this checkbox belongs to a multivalue (is part of a checkbox group)