Switch

/libs/granite/ui/components/coral/foundation/form/switch

A switch component to represent boolean concept (the “On”/”Off” toggle switch).

It extends Field component.

It has the following content structure:

granite:FormSwitch
  1. granite:FormField
namestring

The name that identifies the field when submitting the form.

deleteHintboolean
  1. true

true to generate the SlingPostServlet @Delete hidden input based on the name.

valuestring
  1. true

The value of the field.

uncheckedValuestring
  1. false

The submit value of the field when it is unchecked.

disabledboolean

Indicates if the field is in disabled state.

requiredboolean

Indicates if the field is mandatory to be filled.

validationstring
multiple

The name of the validator to be applied. E.g. foundation.jcr.name. See validation in Granite UI.

checkedboolean

true to pre-check this field, false otherwise.

ignoreDataboolean

If false, the checked status is based on matching the form values by name and value properties. Otherwise, the form values are not matched, and the checked status is based on checked property specified.

onTextstring
  1. On
i18n

The text for “On”.

offTextstring
  1. Off
i18n

The text for “Off”.

wrapperClassstring

The class for the wrapper element.