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

            Low code usage

            This component can be declared directly in Python, using backend-driven UI.

            ui.CheckboxInput(content={
                    "label": "", # str 
                    "options": {}, # Union[Dict, str] 
                    "orientation": "vertical", # str [vertical, horizontal]
                    "primaryTextColor": "", # str 
                    "accentColor": "", # str 
                    "cssClasses": "", # str 
                },
                handlers={
                    "wf-options-change": handle_event,
                }
            )
            

            A function, in this example handle_event, should be implemented in your code to handle events.

            def handle_event(state, payload, context, ui):
              pass
            

            Reference