RatingInput

Rating input widget for capturing user ratings on a scale.

Examples

Basic Usage

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

Example Code

from abstra.forms import RatingInput, run

# Create a page with the widget
example_page = [
    RatingInput(label="Rating Input", key="my-rating_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 rating must be selected before proceeding.	bool	True
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
max_value	Maximum value for the rating scale.	int	5

State Value

int: The rating value 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