(this page was created automatically. In case of formatting issues, please visit the official Wiki Page)

checkbox

General Properties

• displayName - Sets the display name of the component shown in the structure panel. For example, "ConsentCheckbox" allows for easy identification of the component's purpose in the UI builder interface.

Visual Properties

• labelTranslations - Sets the label text displayed next to the checkbox, with support for multiple languages. For example, {"en-US": "I accept the terms", "de-DE": "Ich akzeptiere die Bedingungen"} provides localized text for users.

• disabled - Determines whether the checkbox is interactive. When set to true, the checkbox appears grayed out and cannot be toggled by the user, useful for read-only information or conditional form elements.

• value - Sets the default checked state of the checkbox. When set to true, the checkbox will be checked by default when the form loads; when false, it will be unchecked.

• readonly - Controls whether the field is in read-only mode. When set to true, the component will display its current state but prevent changes, allowing for display of decisions without allowing modifications.

• defaultValue - Sets an initial value for the checkbox when first loaded. This value will be used when the form is reset or initially displayed before any user interaction.

• saveInLocalStorage -  Enables persisting the checkbox state in browser's local storage. When enabled, the state will be recalled even after page refresh, providing continuity in multi-page forms.

Non-Visual Properties

• dataField - Specifies the form field name where the checkbox value will be stored. For example, setting it to "acceptTerms" ensures the checkbox state is saved to that field in form submissions.
• controlsRequestType - Specifies how the checkbox data should be included in API requests. Options include "BODY" (in request body), "PATH" (in URL path), or "HEADER" (in HTTP headers).

Validation Properties

• validation - Configures validation rules for the checkbox:
  • required - When set to true, form submission is blocked unless the checkbox is checked.
  • requiredTrue - Specifically requires the checkbox to be checked (true) for validation to pass, commonly used for terms acceptance.

Event Actions

• events - Configures the events that the component can trigger and respond to:
  • ON_VALUE_CHANGE: Triggered when the checkbox is toggled. Can be used to dynamically show/hide other fields based on checkbox state.
  • ON_INIT_BASED_ON_USER_VIEW: Triggered when the component is initialized in user view. Useful for setup operations specific to normal viewing mode.
  • ON_INIT: Triggered when the component is initialized. Can be used for general setup operations.
  • ON_DESTROY: Triggered when the component is removed from the DOM. Useful for cleanup operations.