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

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

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

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

# Checkbox

Checkbox is data input component that lets your members check a checkbox.

This component has the following settings:

![checkbox_settings_en](checkbox_settings_en.png)

* **Label** — label displayed on the checkbox;
* **Description** — description displayed on the checkbox 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 key
  will contain this identifier with the boolean value representing whether this checkbox was checked.

  Thus, this way [Action] can determine if checkbox was checked.
  :::
* **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.