CheckboxField

CheckboxField is similar to a Checkbox 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.

Function signature

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

checkbox = CheckboxField(
    title="Title",
    description="Description",
)

checked

Whether Checkbox is checked.

type: bool

default value: False

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.

checkbox = CheckboxField(
    title="Title",
    description="Description",
)
checkbox.is_checked() # False

set()

Set title, description, and checked properties.

checkbox.set(title="New title", description="New description", checked=True)

check()

Enable checked property.

checkbox.check()

uncheck()

Disable checked property.

checkbox.uncheck()

@value_changed

Decorator function is handled when checkbox value is changed.

@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

Import libraries

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:

if sly.is_development():
    load_dotenv("local.env")
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api()

Initialize CheckboxField widget

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.

card = Card(
    title="CheckboxField",
    content=checkbox_field,
)

Create the app using a layout

Create an app object with a layout parameter.

app = sly.Application(layout=card)

Add function to control widget from code

@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)