Skip to content

Switch Input

A user input component with a simple on/off status.

Fields

NameTypeDescriptionOptions
LabelText
AccentColor
Primary textColor
SeparatorColor
Custom CSS classesTextCSS classes, separated by spaces. You can define classes in custom stylesheets.

Events

NameDescriptionUsage
ss-toggleSent when the switch is toggled.
def handle_toggle(state, payload):

  # The payload will be a bool 

  state["its_on"] = payload

Low code usage

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

python
ui.SwitchInput(content={
        "label": "", # str 
        "accentColor": "", # str 
        "primaryTextColor": "", # str 
        "separatorColor": "", # str 
        "cssClasses": "", # str 
    },
    handlers={
        "ss-toggle": handle_event,
    }
)
A function, in this example handle_event, should be implemented in your code to handle events.
python
def handle_event(state, payload, context, ui):
  pass

Reference