Refresh

marimo.ui.refresh

refresh(
    options: Optional[list[Union[int, float, str]]] = None,
    default_interval: Optional[
        Union[int, float, str]
    ] = None,
    *,
    label: str = "",
    on_change: Optional[Callable[[int], None]] = None
)

Bases: UIElement[int, int]

A refresh button that will auto-refresh its descendants for a given interval.

Each option value can either be a number (int or float) in seconds or a human-readable string (e.g. "1s", "10s", "1m"). You can also combine multiple time units (e.g. "1m 30s").

Note

The refresh interval may not be exact, as it depends on the time it takes to render the content and the time it takes to send the content to the client. Also, due to the buffering of UI element changes, if the downstream cells take a long time to render, the refresh interval may be longer than expected.

Examples:

refresh_button = mo.ui.refresh(
    options=["1m", "5m 30s", "10m"],
    default_interval="10m",
)
refresh_button

ATTRIBUTE	DESCRIPTION
value	The time in seconds since the refresh has been activated. TYPE: int

PARAMETER	DESCRIPTION
options	The options for the refresh interval, as a list of human-readable strings or numbers (int or float) in seconds. If no options are provided and default_interval is provided, the options will be generated automatically. If no options are provided and default_interval is not provided, the refresh button will not be displayed with a dropdown for auto-refresh. TYPE: Optional[list[Union[int, float, str]]] DEFAULT: None
default_interval	The default value of the refresh interval. TYPE: Optional[Union[int, float, str]] DEFAULT: None
label	Markdown label for the element. Defaults to "". TYPE: str DEFAULT: ''
on_change	Optional callback to run when this element's value changes. TYPE: Optional[Callable[[int], None]] DEFAULT: None

name class-attribute instance-attribute

name: Final[str] = 'marimo-refresh'

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).

Args.

• elements: the UI elements to interpolate into the HTML template.

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.

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.

Use this method to create a form that gates the submission of a UIElements value until a submit button is clicked.

The value of the form is the value of the underlying element the last time the form was submitted.

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()
)

Args.

• label: A text label for the form.
• bordered: whether the form should have a border
• loading: whether the form should be in a loading state
• submit_button_label: the label of the submit button
• submit_button_tooltip: the tooltip of the submit button
• submit_button_disabled: whether the submit button should be disabled
• clear_on_submit: whether the form should clear its contents after submitting
• show_clear_button: whether the form should show a clear button
• clear_button_label: the label of the clear button
• clear_button_tooltip: the tooltip of the clear button
• validate: a function that takes the form's value and returns an error message if the value is invalid, or None if the value is valid

left

left() -> Html

Left-justify.

Example.

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

Returns.

An Html object.

right

right() -> Html

Right-justify.

Example.

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

Returns.

An Html object.

send_message

send_message(
    message: Dict[str, object],
    buffers: Optional[Sequence[bytes]],
) -> None

Send a message to the element rendered on the frontend from the backend.

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")

Args.

• style: an optional dict of CSS styles, keyed by property name
• **kwargs: CSS styles as keyword arguments