Dropdown¶

marimo.ui.dropdown ¶

dropdown(
    options: Sequence[Any] | dict[str, Any],
    value: Optional[Any] = None,
    allow_select_none: Optional[bool] = None,
    searchable: bool = False,
    *,
    label: str = "",
    on_change: Optional[Callable[[Any], None]] = None,
    full_width: bool = False
)

Bases: UIElement[list[str], Any]

A dropdown selector.

Examples:

dropdown = mo.ui.dropdown(
    options=["a", "b", "c"], value="a", label="choose one"
)

# With search functionality
dropdown = mo.ui.dropdown(
    options=["a", "b", "c"],
    value="a",
    label="choose one",
    searchable=True,
)

dropdown = mo.ui.dropdown(
    options={"one": 1, "two": 2, "three": 3},
    value="one",
    label="pick a number",
)

Or from a dataframe series:

dropdown = mo.ui.dropdown.from_series(df["column_name"])

ATTRIBUTE	DESCRIPTION
`value`	The selected value, or None if no selection. TYPE: `Any`
`options`	A dict mapping option name to option value. TYPE: `dict`
`selected_key`	The selected option's key, or None if no selection. TYPE: `str`

PARAMETER	DESCRIPTION
`options`	Sequence of options, or dict mapping option name to option value. If the options are not strings, they will be converted to strings when displayed in the dropdown. TYPE: `Sequence[Any] \| dict[str, Any]`
`value`	Default option name. Defaults to None. TYPE: `str` DEFAULT: `None`
`allow_select_none`	Whether to include special option ("--") for a None value; when None, defaults to True when value is None. Defaults to None. TYPE: `bool` DEFAULT: `None`
`searchable`	Whether to enable search functionality. Defaults to False. If the number of options is greater than 1000, this will be set to True, automatically. TYPE: `bool` DEFAULT: `False`
`label`	Markdown label for the element. Defaults to "". TYPE: `str` DEFAULT: `''`
`on_change`	Optional callback to run when this element's value changes. Defaults to None. TYPE: `Callable[[Any], None]` DEFAULT: `None`
`full_width`	Whether the input should take up the full width of its container. Defaults to False. TYPE: `bool` DEFAULT: `False`

options `instance-attribute` ¶

options = options

selected_key `property` ¶

selected_key: Optional[str]

The selected option's key, or None if no selection.

text `property` ¶

text: str

A string of HTML representing this element.

value `property` `writable` ¶

value: T

The element's current value.

batch ¶

batch(**elements: UIElement[JSONType, object]) -> batch

Convert an HTML object with templated text into a UI element.

This method lets you create custom UI elements that are represented by arbitrary HTML.

Example

user_info = mo.md(
    '''
    - What's your name?: {name}
    - When were you born?: {birthday}
    '''
).batch(name=mo.ui.text(), birthday=mo.ui.date())

In this example, user_info is a UI Element whose output is markdown and whose value is a dict with keys 'name' and 'birthday' (and values equal to the values of their corresponding elements).

PARAMETER	DESCRIPTION
`elements`	the UI elements to interpolate into the HTML template. TYPE: `UIElement[JSONType, object]` DEFAULT: `{}`

callout ¶

callout(
    kind: Literal[
        "neutral", "danger", "warn", "success", "info"
    ] = "neutral"
) -> Html

Create a callout containing this HTML element.

A callout wraps your HTML element in a raised box, emphasizing its importance. You can style the callout for different situations with the kind argument.

Examples:

mo.md("Hooray, you did it!").callout(kind="success")

mo.md("It's dangerous to go alone!").callout(kind="warn")

center ¶

center() -> Html

Center an item.

Example

mo.md("# Hello, world").center()

RETURNS	DESCRIPTION
`Html`	An `Html` object.

form ¶

form(
    label: str = "",
    *,
    bordered: bool = True,
    loading: bool = False,
    submit_button_label: str = "Submit",
    submit_button_tooltip: Optional[str] = None,
    submit_button_disabled: bool = False,
    clear_on_submit: bool = False,
    show_clear_button: bool = False,
    clear_button_label: str = "Clear",
    clear_button_tooltip: Optional[str] = None,
    validate: Optional[
        Callable[[Optional[JSONType]], Optional[str]]
    ] = None,
    on_change: Optional[
        Callable[[Optional[T]], None]
    ] = None
) -> form[S, T]

Create a submittable form out of this UIElement.

Creates a form that gates submission of a UIElement's value until a submit button is clicked. The form's value is the value of the underlying element from the last submission.

Examples:

Convert any UIElement into a form:

prompt = mo.ui.text_area().form()

Combine with HTML.batch to create a form made out of multiple UIElements:

form = (
    mo.ui.md(
        '''
    **Enter your prompt.**

    {prompt}

    **Choose a random seed.**

    {seed}
    '''
    )
    .batch(
        prompt=mo.ui.text_area(),
        seed=mo.ui.number(),
    )
    .form()
)

PARAMETER	DESCRIPTION
`label`	A text label for the form. TYPE: `str` DEFAULT: `''`
`bordered`	Whether the form should have a border. TYPE: `bool` DEFAULT: `True`
`loading`	Whether the form should be in a loading state. TYPE: `bool` DEFAULT: `False`
`submit_button_label`	The label of the submit button. TYPE: `str` DEFAULT: `'Submit'`
`submit_button_tooltip`	The tooltip of the submit button. TYPE: `Optional[str]` DEFAULT: `None`
`submit_button_disabled`	Whether the submit button should be disabled. TYPE: `bool` DEFAULT: `False`
`clear_on_submit`	Whether the form should clear its contents after submitting. TYPE: `bool` DEFAULT: `False`
`show_clear_button`	Whether the form should show a clear button. TYPE: `bool` DEFAULT: `False`
`clear_button_label`	The label of the clear button. TYPE: `str` DEFAULT: `'Clear'`
`clear_button_tooltip`	The tooltip of the clear button. TYPE: `Optional[str]` DEFAULT: `None`
`validate`	A function that takes the form's value and returns an error message if invalid, or `None` if valid. TYPE: `Optional[Callable[[Optional[JSONType]], Optional[str]]]` DEFAULT: `None`
`on_change`	Optional callback to run when this element's value changes. Defaults to None. TYPE: `Optional[Callable[[Optional[T]], None]]` DEFAULT: `None`

from_args `classmethod` ¶

from_args(
    data: dict[str, int],
    args: InitializationArgs[S, T],
    memo: dict[int, Any] | None = None,
    basis: UIElement[S, T] | None = None,
) -> UIElement[S, T]

from_series `staticmethod` ¶

from_series(
    series: DataFrameSeries, **kwargs: Any
) -> dropdown

Create a dropdown from a dataframe series.

left ¶

left() -> Html

Left-justify.

Example

mo.md("# Hello, world").left()

RETURNS	DESCRIPTION
`Html`	An `Html` object.

right ¶

right() -> Html

Right-justify.

Example

mo.md("# Hello, world").right()

RETURNS	DESCRIPTION
`Html`	An `Html` object.

style ¶

style(
    style: Optional[dict[str, Any]] = None, **kwargs: Any
) -> Html

Wrap an object in a styled container.

Example

mo.md("...").style({"max-height": "300px", "overflow": "auto"})
mo.md("...").style(max_height="300px", overflow="auto")

PARAMETER	DESCRIPTION
`style`	an optional dict of CSS styles, keyed by property name TYPE: `Optional[dict[str, Any]]` DEFAULT: `None`
`**kwargs`	CSS styles as keyword arguments TYPE: `Any` DEFAULT: `{}`

Dropdown¶

marimo.ui.dropdown ¶

options instance-attribute ¶

selected_key property ¶

text property ¶

value property writable ¶

batch ¶

callout ¶

center ¶

form ¶

from_args classmethod ¶

from_series staticmethod ¶

left ¶

right ¶

style ¶

options `instance-attribute` ¶

selected_key `property` ¶

text `property` ¶

value `property` `writable` ¶

from_args `classmethod` ¶

from_series `staticmethod` ¶