Email Input
Collects and validates an email address.
Examples
Basic Example
The following example demonstrate some of the available functionality for read_email
from abstra.forms import read_email
email = read_email("What is your email?")
Parameters
| Name | Description | Type |
|---|---|---|
| label | The label to display to the user | str |
| initial_value | The initial value to display to the user. Defaults to "". | str |
| placeholder | The placeholder text to display to the user. Defaults to "". | str |
| invalid_email_message | Invalid e-mail message | 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 |
|---|---|
| str | The value entered by the user |