Checkbox

Checkbox

Component properties

Eximee Designer property	Attribute name in Source	Description
Button checked (section Others)	checked	Specifies whether the field should be checked by default (initially set to "false"). Equivalent of the default value for other fields.
Value of the checked button (section Others)	valueYes	The value the checkbox takes when checked - by default, if no other value is set, the returned value is "true".
Value of the unchecked button (section Others)	valueNo	The value the checkbox takes when unchecked - by default, if no other value is set, the returned value is "false".
Checkbox placement (section Others)	tickPosition	Availability of the functionality depends on the license and may not be available in all deployments. By default empty (set to DEFAULT), places the checkbox in the center of the component in vertical orientation. Set to TOP places the checkbox at the top of the component in vertical orientation.
Content (section Basic properties)	text	Text displayed next to the component. It is possible to reference variables or fields e.g.: ${sessionVariable1} or ${GesTextField1}
Description (section Others)	description	Availability of the functionality depends on the license and may not be available in all deployments. Specifies the business description of the field - the display method depends on the specific implementation of the component.

More information about component properties: Common component properties

Feeding the checkbox text with different contents

If the text next to the checkbox should depend on a condition and display different (or formatted) content, it can be fed from the Content (TextContent) component. To do this, attach a External data source service TextContentService, in which we provide as the input parameter component an artifact containing the text to display. In the output parameters for the attribute text and value we select the output parameter artifact.

A button directing to detailed information can be placed inside the Content (TextContent) by placing the tag <div class="ex-checkbox-more-info-label"></div>.

Content defined in moreInfoLabel can be defined dynamically (for example fed from a Text Field or another component placed on the form).

Component state information

Information about the current value of a given component property, which can then be used on the form e.g. to populate another field with this property's value, can be obtained using the construction COMPONENT_ID$PROPERTY_NAME

For the checkbox you can retrieve the following properties:

Key	Description
moreInfoButtonClicked	true - if the link to detailed information was clicked at least once

Example: feeding the property Data source from another field (valueSourceId) via GesCheckbox1$moreInfoButtonClicked returns the true/false value telling us whether the checkbox's more info button was clicked.

Available events

Name	Description
CHECK	Event emitted when the checkbox is checked
UNCHECK	Event emitted when the checkbox is unchecked

Available actions

Action documentation: Actions

Name	Description
CHECK	Checking the checkbox. NOTE: does not emit the CHECK event
UNCHECK	Unchecking the checkbox. NOTE: does not emit the UNCHECK event
TOGGLE	Change the checkbox value to the opposite. NOTE: does not emit CHECK and UNCHECK events

Illustration 1. Example of checkbox position set to TOP and default (DEFAULT)

Illustration 2. Example appearance of the component on the form

Illustration 3. Example appearance of the component on the form in switch presentation

Demo forms: demoCheckbox, demoPopup

♿WCAG: WCAG best practices for low-code dev