Skip to content

Text Input

A user input component that allows users to enter single-line text values.

Fields

NameTypeDescriptionOptions
LabelText
PlaceholderText
Password modeText
  • Yes
  • No
Custom CSS classesTextCSS classes, separated by spaces. You can define classes in custom stylesheets.

Events

NameDescriptionUsage
ss-changeCapture changes as they happen.

def onchange_handler(state, payload):

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

  state["new_val"] = payload
ss-change-finishCapture changes once this control has lost focus.

def onchange_handler(state, payload):

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

  state["new_val"] = payload

Low code usage

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

python
ui.TextInput(content={
        "label": "", # str 
        "placeholder": "", # str 
        "passwordMode": "no", # str [yes, no]
        "cssClasses": "", # str 
    },
    handlers={
        "ss-change": handle_event,
        "ss-change-finish": 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