dropdown

class virtualitics_sdk.elements.dropdown.Dropdown(options, selected=None, include_nulls_visible=True, include_nulls_value=False, multiselect=False, title='', description='', show_title=True, show_description=True, required=True, label='', placeholder='')

Bases: InputElement

A Dropdown Input element.

Parameters:

  • options (List[str]) – The options in the dropdown menu.

  • selected (Optional[List[str]]) – The option the user selected, defaults to [].

  • include_nulls_visible (bool) – whether null values will be visible, defaults to True.

  • include_nulls_value (bool) – whether to include null values, defaults to False.

  • multiselect (bool) – whether the user can select multiple values, defaults to False.

  • title (str) – The title of the element, defaults to ‘’.

  • description (str) – The element’s description, defaults to ‘’.

  • show_title (bool) – whether to show the title on the page when rendered, defaults to True.

  • show_description (bool) – whether to show the description to the page when rendered, defaults to True.

  • required (bool) – whether a selection needs to be submitted for the step to continue, defaults to True

  • label (str) – The label of the element, defaults to ‘’.

  • placeholder (str) – The placeholder of the element, defaults to ‘’..

get_value()

Get the value of an element. If the user has interacted with the value, the default will be updated.

Return type:

Union[str, List[str]]

update_from_input_parameters()
update_from_user_input(user_input)

Updates the element default values from user input.

Parameters:

user_input (Union[str, List[str]]) – Input from a user on the platform.