Skip to main content

NpsInput

Net Promoter Score input widget for collecting customer feedback scores.

Signature

def NpsInput(
label: str,
key: str = None,
required: bool = True,
min: int = 0,
max: int = 10,
min_hint: str = 'Not at all likely',
max_hint: str = 'Extremely likely',
hint: str = None,
full_width: bool = False,
disabled: bool = False,
errors: Union[List[str], str] = None,
value: int = 0
)

Parameters

NameDescriptionTypeDefault
label (required)Text label displayed above the input.strNone
keyIdentifier for the widget, defaults to label if not provided.strNone
requiredWhether a score must be selected before proceeding.boolTrue
minMinimum score value.int0
maxMaximum score value.int10
min_hintText displayed beneath the minimum score value.str'Not at all likely'
max_hintText displayed beneath the maximum score value.str'Extremely likely'
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
valueInitial value of the score.int0