> ## Documentation Index
> Fetch the complete documentation index at: https://relevanceai.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Checkbox

> A Checkbox (boolean) object

## What is a Checkbox input

Checkbox input is an input component that allows you to enter a checkbox for boolean (i.e. True/False) values.

## When to use the Checkbox input component

The Checkbox input component is suitable for an entry showing a binary situation (e.g. True/False, Selected/Unselected).

## How to add a Checkbox input to my custom Tool

The Checkbox component is listed under User inputs. You can add it to your Tool using the main section
or the side-bar.

<img src="https://mintcdn.com/relevanceai/R4_uN_eHr7TJYC-q/images/build-custom-tools/user-input/checkbox-input-1.png?fit=max&auto=format&n=R4_uN_eHr7TJYC-q&q=85&s=d7c6614fc53a880d2661ba1a01daada8" alt="Checkbox" width="2934" height="1702" data-path="images/build-custom-tools/user-input/checkbox-input-1.png" />

## Checkbox input setting

<Snippet file="components/inputs/general-input-setting.mdx" />

<Snippet file="components/inputs/default-value-tip.mdx" />

## Access the value

To access the entered data use the variable mode `{{}}` and the input step name. Under the default setting it is accessible
via `{{checkbox}}` (or `params.checkbox` in  a JavaScript step).