Button¶

Looking for a submit/run button?

If you're looking for a button to trigger computation on click, consider using mo.ui.run_button.

Source code for examples/ui/button.py

Tip: paste this code into an empty cell, and the marimo editor will create cells for you

import marimo

__generated_with = "0.10.6"
app = marimo.App()


@app.cell
def _():
    import marimo as mo
    return (mo,)


@app.cell
def _(mo):
    button = mo.ui.button(
        value=0, on_click=lambda value: value + 1, label="increment", kind="warn"
    )
    button
    return (button,)


@app.cell
def _(button):
    button.value
    return


if __name__ == "__main__":
    app.run()

marimo.ui.button ¶

button(on_click: Optional[Callable[[Any], Any]] = None, value: Optional[Any] = None, kind: Literal['neutral', 'success', 'warn', 'danger'] = 'neutral', disabled: bool = False, tooltip: Optional[str] = None, *, label: str = 'click here', on_change: Optional[Callable[[Any], None]] = None, full_width: bool = False, keyboard_shortcut: Optional[str] = None)

Bases: UIElement[Any, Any]

A button with an optional callback and optional value.

Examples:

# a button that when clicked will execute
# any cells referencing that button
button = mo.ui.button()

# a counter implementation
counter_button = mo.ui.button(
    value=0, on_click=lambda value: value + 1, label="increment"
)

# adding intent
delete_button = mo.ui.button(
    label="Do not click",
    kind="danger",
)

ATTRIBUTE	DESCRIPTION
`value`	The value of the button. TYPE: `Any`

PARAMETER	DESCRIPTION
`on_click`	A callable called on click that takes the current value of the button and returns a new value. Defaults to None. TYPE: `Callable[[Any], Any]` DEFAULT: `None`
`value`	An initial value for the button. Defaults to None. TYPE: `Any` DEFAULT: `None`
`kind`	Button style. Defaults to "neutral". TYPE: `Literal['neutral', 'success', 'warn', 'danger']` DEFAULT: `'neutral'`
`disabled`	Whether the button is disabled. Defaults to False. TYPE: `bool` DEFAULT: `False`
`tooltip`	Tooltip text for the button. Defaults to None. TYPE: `str` DEFAULT: `None`
`label`	Markdown label for the element. Defaults to "click here". TYPE: `str` DEFAULT: `'click here'`
`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`
`keyboard_shortcut`	Keyboard shortcut to trigger the button (e.g. 'Ctrl-L'). Defaults to None. TYPE: `str` DEFAULT: `None`

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]

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.

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

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: `{}`

Button¶

marimo.ui.button ¶

text property ¶

value property writable ¶

batch ¶

callout ¶

center ¶

form ¶

from_args classmethod ¶

left ¶

right ¶

send_message ¶

style ¶

text `property` ¶

value `property` `writable` ¶

from_args `classmethod` ¶