Dropdown¶

Use a dropdown to pick one option from a large number of options.

Basic¶

Set mode='menu' to show a dropdown menu.

mode= can be elided when there are more than 7 options.

choice = view(box('Choose a color', mode='menu', options=[
    'yellow', 'orange', 'red', 'black'
]))
view(f'You chose {choice}.')

Screenshot

Set initial selection¶

Set value= to pre-select an option having that value.

choice = view(box('Choose a color', mode='menu', value='yellow', options=[
    option('green', 'Green'),
    option('yellow', 'Yellow'),
    option('orange', 'Orange'),
    option('red', 'Red'),
]))
view(f'You chose {choice}.')

Screenshot

Mark options as selected¶

Set selected=True to pre-select an option.

choice = view(box('Choose a color', mode='menu', options=[
    option('green', 'Green'),
    option('yellow', 'Yellow', selected=True),
    option('orange', 'Orange'),
    option('red', 'Red'),
]))
view(f'You chose {choice}.')

Screenshot

Group options¶

Options can have sub-options. This is useful for grouping options into categories.

mode=menu is implied if options are grouped.

choice = view(box('Choose a color', options=[
    option('primary', 'Primary Colors', options=[
        option('red', 'Red'),
        option('blue', 'Blue'),
        option('yellow', 'Yellow'),
    ]),
    option('secondary', 'Secondary Colors', options=[
        option('violet', 'Violet'),
        option('green', 'Green'),
        option('orange', 'Orange'),
    ]),
]))
view(f'You chose {choice}.')

Screenshot

Enable arbitrary input¶

Add editable to mode to allow arbitrary input in addition to the presented options.

mode=menu is implied if editable is set, and the box has options.

choice = view(box('Choose a color', mode='editable', options=[
    'yellow', 'orange', 'red', 'black'
]))
view(f'You chose {choice}.')

Screenshot

Handle changes immediately¶

Add live to mode to handle changes immediately.

choice = 'yellow'
while True:
    choice = view(
        box(
            'Choose a color',
            mode='live menu',
            value=choice,
            options=['green', 'yellow', 'orange', 'red'],
        ),
        f'You chose {choice}.'
    )

Screenshot

Disable¶

Set disabled=True to disable.

view(box('Choose a color', mode='menu', options=[
    'yellow', 'orange', 'red', 'black'
], disabled=True))

Screenshot