Skip to main content

TextInput

Text input widget for collecting single-line text.

Signature

def TextInput(
label: str,
key: str = None,
placeholder: str = '',
required: bool = True,
hint: str = None,
full_width: bool = False,
disabled: bool = False,
errors: Union[List[str], str] = None,
mask: str = None,
max_length: int = None,
min_length: int = None
)

Parameters

NameDescriptionTypeDefault
label (required)Text label displayed above the input.strNone
keyIdentifier for the widget, defaults to label if not provided.strNone
placeholderPlaceholder text displayed when the input is empty.str''
requiredWhether the input must be filled before proceeding.boolTrue
hintHelp text displayed below the input.strNone
full_widthWhether the input should take up the full width of its container.boolFalse
disabledWhether the input is non-interactive.boolFalse
errorsPre-defined validation error messages to display.Union[List[str], str]None
maskString pattern for input masking.strNone
max_lengthMaximum number of characters allowed.intNone
min_lengthMinimum number of characters required.intNone