File¶

marimo.ui.file ¶

file(
    filetypes: Optional[Sequence[str]] = None,
    multiple: bool = False,
    kind: Literal["button", "area"] = "button",
    *,
    label: str = "",
    on_change: Optional[
        Callable[[Sequence[FileUploadResults]], None]
    ] = None
)

Bases: UIElement[List[Tuple[str, str]], Sequence[FileUploadResults]]

A button or drag-and-drop area to upload a file.

Once a file is uploaded, the UI element's value is a list of namedtuples (name, contents), where name is the filename and contents is the contents of the file. Alternatively, use the methods name(index: int = 0) and contents(index: int = 0) to retrieve the name or contents of the file at a specified index.

Use the kind argument to switch between a button and a drag-and-drop area.

The maximum file size is 100MB.

Examples:

Uploading a single file:

f = mo.ui.file()

# access the uploaded file's name
f.value[0].name
# or
f.name()

# access the uploaded file's contents
f.value[0].contents
# or
f.contents()

Uploading multiple files, accepting only .png and .jpg extensions:

f = mo.ui.file(filetypes=[".png", ".jpg"], multiple=True)

# access an uploaded file's name
f.value[index].name
# or
f.name(index)

# access the uploaded file's contents
f.value[index].contents
# or
f.contents(index)

ATTRIBUTE	DESCRIPTION
`value`	A sequence of FileUploadResults, which have string name and bytes contents fields. TYPE: `Sequence[FileUploadResults]`

METHOD	DESCRIPTION
`name`	int = 0) -> Optional[str]: Get the name of the uploaded file at index.
`contents`	int = 0) -> Optional[bytes]: Get the contents of the uploaded file at index.

PARAMETER	DESCRIPTION
`filetypes`	The file types accepted; for example, filetypes=[".png", ".jpg"]. If None, all files are accepted. In addition to extensions, you may provide "audio/", "video/", or "image/" to accept any audio, video, or image file. Defaults to None. TYPE:* `Sequence[str]` DEFAULT: `None`
`multiple`	If True, allow the user to upload multiple files. Defaults to False. TYPE: `bool` DEFAULT: `False`
`kind`	Type of upload interface. Defaults to "button". TYPE: `Literal['button', 'area']` DEFAULT: `'button'`
`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[[Sequence[FileUploadResults]], None]` 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.

contents ¶

contents(index: int = 0) -> Optional[bytes]

Get file contents at index.

PARAMETER	DESCRIPTION
`index`	Index of the file to get the contents from. Defaults to 0. TYPE: `int` DEFAULT: `0`

RETURNS	DESCRIPTION
`Optional[bytes]`	Optional[bytes]: The contents of the file at the specified index, or None if index is out of range.

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`	A callback that takes the form's value and returns an error message if invalid, or `None` if valid. TYPE: `Optional[Callable[[Optional[T]], None]]` DEFAULT: `None`

left ¶

left() -> Html

Left-justify.

Example

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

RETURNS	DESCRIPTION
`Html`	An `Html` object.

name ¶

name(index: int = 0) -> Optional[str]

Get file name at index.

PARAMETER	DESCRIPTION
`index`	Index of the file to get the name from. Defaults to 0. TYPE: `int` DEFAULT: `0`

RETURNS	DESCRIPTION
`Optional[str]`	Optional[str]: The name of the file at the specified index, or None if index is out of range.

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

File¶

marimo.ui.file ¶

text property ¶

value property writable ¶

batch ¶

callout ¶

center ¶

contents ¶

form ¶

left ¶

name ¶

right ¶

send_message ¶

style ¶

text `property` ¶

value `property` `writable` ¶