Check Box

The Checkbox widget provides a standardized checkbox that allows users to make a binary choice. It can be either checked or unchecked.

Properties

Property
Description

value

A boolean that determines whether the checkbox is checked (true) or unchecked (false).

size

The size of the checkbox icon.

activeColor

The background color of the checkbox when it is checked.

inactiveColor

The background color of the checkbox when it is unchecked.

activeBorderColor

The border color of the checkbox when it is checked.

inactiveBorderColor

The border color of the checkbox when it is unchecked.

borderWidth

The width of the checkbox's border.

Shape Properties

Property
Description

value

The shape of the checkbox. Can be rectangle or circle.

borderRadius

If the shape is a rectangle, this defines the radius of the corners.

Icon Properties

You can customize the icons used for the checked and unchecked states.

Property
Description

activeIcon

The icon to display when the checkbox is checked. See Icon for properties.

inactiveIcon

The icon to display when the checkbox is unchecked. See Icon for properties.


Default Properties

The Checkbox widget the following sections of Default Properties:

Layout

  • width

  • height

  • padding

  • margin

  • align

Interactions

  • onClick — Used to add actions to the Checkbox widget.

Last updated