Phone Input

A phone inputs with country code and national number.

Examples

Basic Example

The following example demonstrate some of the available functionality for read_phone

from abstra.forms import read_phone

phone = read_phone("What is your phone number?")
number = phone.raw  # eg: 5521999999999
masked = phone.masked  # eg: +55 (21) 99999-9999

Parameters

Name	Description	Type
label	The label to display to the user	str
initial_value	The initial value to display to the user. It contains two keys: 'country_code' (string with optional + sign or number) and 'national_number' (str). Ex: {'country_code': '55', 'national_number': '21999990000'}.	dict
placeholder	The placeholder text to display in the national number input. Defaults to "".	str
invalid_message	The message to display when the input is invalid	str
disabled	whether the input is disabled. Defaults to False.	bool
required	Whether the input is required or not eg. "this field is required". Defaults to True.	Union[bool, str]
hint	A tooltip displayed to the user. Defaults to None.	str
end_program	Whether the program should end after the widget is shown. Defaults to False.	bool
full_width	Whether the input should use full screen width. Defaults to False.	bool
button_text	What text to display on the button when the widget is not part of a Page. Defaults to 'Next'.	str

Return Values

Type	Description
PhoneResponse	A dict containing the value entered by the user ({"country_code": str, "national_number": str})