Skip to main content
A user input component that allows users to choose multiple values from a list of options using checkboxes.

​
Fields

NameTypeDescriptionOptions
LabelText--
OptionsKey-ValueKey-value object with options. Must be a JSON string or a state reference to a dictionary.-
OrientationTextSpecify how to lay out the options.
  1. Vertical
  2. Horizontal
Primary textColor--
AccentColor--
Custom CSS classesTextCSS classes, separated by spaces. You can define classes in custom stylesheets.-

​
Events

Sent when the selected options change.
def onchange_handler(state, payload):

# Set the state variable "selected" to the selected options.
# The payload will be a list, as multiple options are allowed.

state["selected"] = payload