CpfInput
CPF (Brazilian individual taxpayer registry) input widget.
Examples
Basic Usage
This example runs a form with a single page containing the widget
Example Code
from abstra.forms import CpfInput, run
# Create a page with the widget
example_page = [
CpfInput(label="Cpf Input", key="my-cpf_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 |
| placeholder | Placeholder text displayed when the input is empty. | str | '000.000.000-00' |
| required | Whether the input must be filled 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 |
| invalid_message | Custom error message for invalid CPF numbers. | str | 'i18n_error_invalid_cpf' |
| errors | Pre-defined validation error messages to display. | Union[List[str], str] | None |
State Value
str: The CPF number entered 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