Read a text value from the user simple text input

Basic Example

The following example demonstrate some of the available functionality for read_cards

Choose your character



Grass / Poison

There is a plant seed on its back right from the day this Pokémon is born. The seed slowly grows larger.




It has a preference for hot things. When it rains, steam is said to spout from the tip of its tail.




When it retracts its long neck into its shell, it squirts out water with vigorous force.

Function signature

def (label: str, options: list, **kwargs):

Positional parameters

label (str)
The text related to this input
options (list)
The options to display to the user, eg. [ {'title': 'Option 1', 'subtitle': 'Subtitle 1', 'image': 'https://image_1.png', 'description': 'option 1 description', 'topLeftExtra': 'Left 1', 'topRightExtra': 'Right 1' }, {'title': 'Option 2', 'subtitle': 'Subtitle 2', 'image': 'https://image_2.png', 'description': 'option 2 description', 'topLeftExtra': 'Left 2', 'topRightExtra': 'Right 2' }]

Keyword Arguments

multiple (bool)
Whether the user can select multiple options. Defaults to False.
initial_value (list)
The initial value to display to the user. Defaults to None.
searchable (bool)
Whether to show a search bar. Defaults to False.
layout (str)
Whether the cards layout should be 'list' or 'grid'. Defaults to 'list'.
disabled (bool)
whether the input is disabled. Defaults to False.
required (Union[bool, str])
Whether the input is required or not eg. "this field is required". Defaults to True.
hint (str)
A tooltip displayed to the user. Defaults to None.
end_program (bool)
Whether the program should end after the widget is shown. Defaults to False.
full_width (bool)
Whether the input should use full screen width. Defaults to False.
button_text (str)
What text to display on the button when the widget is not part of a Page. Defaults to 'Next'.


()list, any: The options/option selected by the user