Skip to content

Rating Input

A user input component that allows users to provide a rating.

Fields

NameTypeDescriptionOptions
LabelText
FeedbackText
  • Stars
  • Faces
  • Hearts
Minimum valueNumberValid values are 0 and 1.
Max valueNumberValid values are between 2 and 11.
StepNumberValid values are between 0.25 and 1.
AccentColor
Primary textColor
Custom CSS classesTextCSS classes, separated by spaces. You can define classes in custom stylesheets.

Events

NameDescriptionUsage
ss-number-change

def onchange_handler(state, payload):

  # Set the state variable "rating" to the new value

  state["rating"] = payload

Low code usage

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

python
ui.RatingInput(content={
        "label": "", # str 
        "feedback": "stars", # str [stars, faces, hearts]
        "minValue": 0.0, # Union[float, str] 
        "maxValue": 0.0, # Union[float, str] 
        "valueStep": 0.0, # Union[float, str] 
        "accentColor": "", # str 
        "primaryTextColor": "", # str 
        "cssClasses": "", # str 
    },
    handlers={
        "ss-number-change": 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