# CheckboxField
`CheckboxField` is similar to a [Checkbox](https://github.com/supervisely/developer-portal/blob/main/app-development/widgets/002_checkbox/README.md) widget, but it is used in a form field. It allows to specify a title and a description for the checkbox.
[Read this tutorial in developer portal.](https://developer.supervisely.com/app-development/widgets/controls/checkboxfield)
### Function signature
```python
CheckboxField(
title="Title",
description="Description",
checked=False,
widget_id=None,
)
```
### Parameters
| Parameters | Type | Description |
| :-----------: | :--------------: | :----------------------------------: |
| `title` | `str` | Checkbox title |
| `description` | `str` | Checkbox description |
| `checked` | `Optional[bool]` | Return `True` if checkbox is checked |
| `widget_id` | `Optional[str]` | ID of the widget |
### title
Checkbox title.
**type:** `str`
### description
Checkbox description.
**type:** `str`
```python
checkbox = CheckboxField(
title="Title",
description="Description",
)
```
### checked
Whether Checkbox is checked.
**type:** `bool`
**default value:** `False`
```python
checkbox = CheckboxField(
title="Title",
description="Description",
checked=True,
)
```
### widget\_id
ID of the widget.
**type:** `str`
**default value:** `None`
### Methods and attributes
| Attributes and Methods | Description |
| :--------------------: | ------------------------------------------------------------- |
| `is_checked()` | Return `True` if checked, else `False`. |
| `set()` | Set `title`, `description`, and `checked` properties. |
| `check()` | Enable `checked` property. |
| `uncheck()` | Disable `checked` property. |
| `@value_changed` | Decorator function is handled when checkbox value is changed. |
### is\_checked()
Return `True` if checked, else `False`.
```python
checkbox = CheckboxField(
title="Title",
description="Description",
)
checkbox.is_checked() # False
```
### set()
Set `title`, `description`, and `checked` properties.
```python
checkbox.set(title="New title", description="New description", checked=True)
```
### check()
Enable `checked` property.
```python
checkbox.check()
```
### uncheck()
Disable `checked` property.
```python
checkbox.uncheck()
```
### @value\_changed
Decorator function is handled when checkbox value is changed.
```python
@checkbox.value_changed
def on_checkbox_changed(checked):
print(f"Checkbox is checked: {checked}")
```
## Mini App Example
You can find this example in our Github repository:
[ui-widgets-demos/controls/010\_checkbox\_field/src/main.py](https://github.com/supervisely-ecosystem/ui-widgets-demos/blob/master/controls/010_checkbox_field/src/main.py)
### Import libraries
```python
import os
import supervisely as sly
from dotenv import load_dotenv
from supervisely.app.widgets import Card, CheckboxField
```
### Init API client
First, we load environment variables with credentials and init API for communicating with Supervisely Instance:
```python
if sly.is_development():
load_dotenv("local.env")
load_dotenv(os.path.expanduser("~/supervisely.env"))
api = sly.Api()
```
### Initialize `CheckboxField` widget
```python
checkbox_field = CheckboxField(
title="Title",
description="Description",
)
```
### Create app layout
Prepare a layout for the app using `Card` widget with the `content` parameter and place widget that we've just created in the `Container` widget.
```python
card = Card(
title="CheckboxField",
content=checkbox_field,
)
```
### Create the app using a layout
Create an app object with a layout parameter.
```python
app = sly.Application(layout=card)
```
### Add function to control widget from code
```python
@checkbox_field.value_changed
def get_value(is_checked):
print(is_checked)
if is_checked:
checkbox_field.set(title="Is Checked", checked=is_checked)
else:
checkbox_field.set(title="Is Not Checked", checked=is_checked)
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://developer.supervisely.com/app-development/widgets/controls/checkboxfield.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.