Number

marimo.ui.number

number(start: Optional[float] = None, stop: Optional[float] = None, step: Optional[float] = None, value: Optional[float] = None, debounce: bool = False, *, label: str = '', on_change: Optional[Callable[[Optional[Numeric]], None]] = None, full_width: bool = False, disabled: bool = False)

Bases: UIElement[Optional[Numeric], Optional[Numeric]]

A number picker over an interval.

Example

number = mo.ui.number(start=1, stop=10, step=2)

Or for integer-only values:

number = mo.ui.number(step=1)

Or from a dataframe series:

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

ATTRIBUTE	DESCRIPTION
value	The value of the number, possibly None. TYPE: Optional[Numeric]
start	The minimum value of the interval. TYPE: Optional[float]
stop	The maximum value of the interval. TYPE: Optional[float]
step	The number increment. TYPE: Optional[float]

PARAMETER	DESCRIPTION
start	The minimum value of the interval. Defaults to None. TYPE: Optional[float] DEFAULT: None
stop	The maximum value of the interval. Defaults to None. TYPE: Optional[float] DEFAULT: None
step	The number increment. Defaults to None. TYPE: Optional[float] DEFAULT: None
value	The default value. Defaults to None. TYPE: Optional[float] DEFAULT: None
debounce	Whether to debounce (rate-limit) value updates from the frontend. Defaults to False. TYPE: bool DEFAULT: False
label	Markdown label for the element. Defaults to an empty string. TYPE: str DEFAULT: ''
on_change	Optional callback to run when this element's value changes. Defaults to None. TYPE: Optional[Callable[[Optional[Numeric]], None]] DEFAULT: None
full_width	Whether the input should take up the full width of its container. Defaults to False. TYPE: bool DEFAULT: False
disabled	Whether the input is disabled. Defaults to False. TYPE: bool DEFAULT: False

METHOD	DESCRIPTION
from_series	DataFrameSeries, **kwargs: Any) -> number: Create a number picker from a dataframe series.

start instance-attribute

start = start

step instance-attribute

step = step

stop instance-attribute

stop = stop

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_series staticmethod

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

Create a number picker 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.

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