Dropdown#
- class marimo.ui.dropdown(options: Sequence[str] | dict[str, Any], value: str | None = None, allow_select_none: bool | None = None, *, label: str = '', on_change: Callable[[Any], None] | None = None, full_width: bool = False)#
A dropdown menu.
Example.
dropdown = mo.ui.dropdown( options=['a', 'b', 'c'], value='a', label='choose one' )
dropdown = mo.ui.dropdown( options={'one': 1, 'two': 2, 'three': 3}, value='one', label='pick a number' )
Attributes.
value: the selected value, orNoneif no selectionoptions: a dict mapping option name to option valueselected_key: the selected option’s key, orNoneif no selection
Initialization Args.
options: sequence of text options, or dict mapping option name to option valuevalue: default option nameallow_select_none: whether to include special option ("--") for aNonevalue; whenNone, defaults toTruewhenvalueisNonelabel: text label for the elementon_change: optional callback to run when this element’s value changesfull_width: whether the input should take up the full width of its container
Public methods
Inherited from
UIElementform([label])Create a submittable form out of this
UIElement.Inherited from
Htmlbatch(**elements)Convert an HTML object with templated text into a UI element.
center()Center an item.
right()Right-justify.
left()Left-justify.
callout([kind])Create a callout containing this HTML element.
Public Data Attributes:
selected_keyThe selected option’s key, or
Noneif no selection.Inherited from
UIElementvalueThe element’s current value.
Inherited from
HtmltextA string of HTML representing this element.
- property selected_key: str | None#
The selected option’s key, or
Noneif no selection.