---
url: https://docs.juniper.bot/en/message-templates/components/checkbox-group.md
description: Checkbox Group component used in Modal Forms.
---

[action]: ../../../cmd/custom/actions/index

[actions]: ../../../cmd/custom/actions/index

[`modal.values`]: ../../types/custom-commands/modal

# Checkbox Group

Checkbox Group is data input component that lets your members check a single of multiple checkboxes.

This component has the following settings:

![checkbox_group_settings_en](checkbox_group_settings_en.png)

* **Label** — label displayed on the checkbox group;
* **Description** — description displayed on the checkbox group with smaller font size;
* **Identifier** — component identifier, enter something related to the component;
  ::: info
  Identifier must be unique across all message components of this action.

  The message template of [Action] being executed by this modal will get [`modal.values`] variable map, which keys
  will be those identifiers and their values are data entered by member.

  Thus, this way [Action] can determine what exact values have been entered.
  :::
* **The minimum/maximum amount of checked options** — the amount of checked options limitation;;
* **Required** — the value will be required to fill if checked;
* **Checkboxes** — the list of checkboxes in the group (up to 10).

## Checkbox { #options }

Checkboxes have the following settings:

![checkbox_settings_en](checkbox_settings_en.png)

* **Label** — Label of the checkbox;
* **Value** — Value of the checkbox, enter something related to this option;
  ::: info
  It must be unique across all checkboxes of this group.

  List of those values will be passed to [`modal.values`] map's value related to this component.

  Thus, this way you can determine in [Action] what exact checkboxes were checked.
  :::
* **Description** — checkbox description;
* **Checked by default** — checking this will make this checkbox to be checked by default;

## Availability { #availability }

This component is only available for [Modal Form](../../../cmd/custom/actions/modal-form) actions.