NpsInput

Net Promoter Score input widget for collecting customer feedback scores.

Examples

Basic Usage

This example runs a form with a single page containing the widget

Example Code

from abstra.forms import NpsInput, run

# Create a page with the widget
example_page = [
    NpsInput(label="Nps Input", key="my-nps_input"),
]

# Run the form
result = run([example_page])

# Print the result
print(result)

Parameters

Name	Description	Type	Default
label (required)	Text label displayed above the input.	str	None
key	Identifier for the widget, defaults to label if not provided.	str	None
required	Whether a score must be selected before proceeding.	bool	True
min	Minimum score value.	int	0
max	Maximum score value.	int	10
min_hint	Text displayed beneath the minimum score value.	str	'Not at all likely'
max_hint	Text displayed beneath the maximum score value.	str	'Extremely likely'
hint	Help text displayed below the input.	str	None
full_width	Whether the input should take up the full width of its container.	bool	False
disabled	Whether the input is non-interactive.	bool	False
errors	Pre-defined validation error messages to display.	Union[List[str], str]	None
value	Initial value of the score.	int	0

State Value

int: The NPS score selected by the user.

info

This is the type of the value that this widget holds. It will show up when accessing widget's state item.

This also defines which value type can be used on initial_state