<!-- Source: https://docs.marimo.io/api/inputs/form/ -->

# Form

[Interactive marimo example](https://marimo.app/?embed=true&mode=edit&show-chrome=false#code/JYWwDg9gTgLgBCAhlUEBQixjgXgc1AOgEEsAKAd2ABMYALHAIhAFNrgBXERgSjTQACmMIQDGLADYS01FgDM4AfUVkeALjRwtcUJFj4UICHEQBnBOm1woLGBygA7QcLGTpshctUarc6CFwLQg5gQhgWAA8YRWQWRDIwCURxOggJWSgmQmzeQj8oEFVNbRs7R34hLFcpGXklFXVirSNCADdTGGSAazIAbXyQABogkGoyOUYACTM4VsQJDhY1OABvAbb5xYBfXgBdPitS+ycgA)

## marimo.ui.form

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

Bases: `UIElement[S | None, T | None]`

A submittable form linked to a UIElement.

Use a `form` to prevent sending UI element values to Python until a button
is clicked.

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

Examples:

Create a form with chaining:
```python
# Create a form with chaining
form = mo.ui.slider(1, 100).form()
```

Create a form with multiple elements:
```python
# Create a form with multiple elements
form = (
    mo.md('''
    **Your form.**

    {name}

    {date}
''')
    .batch(
        name=mo.ui.text(label="name"),
        date=mo.ui.date(label="date"),
    )
    .form(show_clear_button=True, bordered=False)
)
```

Instantiate a form directly:
```python
# Instantiate a form directly
form = mo.ui.form(element=mo.ui.slider(1, 100))
```

| ATTRIBUTE | DESCRIPTION |
| --- | --- |
| `[value](#marimo.ui.form.value)` | The value of the wrapped element when the form's submit button was last clicked. **TYPE:** `Any` |
| `[element](#marimo.ui.form.element)` | A copy of the wrapped element. **TYPE:** `UIElement` |

| PARAMETER | DESCRIPTION |
| --- | --- |
| `element` | The element to wrap. **TYPE:** `UIElement[S, T]` |
| `bordered` | Whether the form should have a border. Defaults to True. **TYPE:** `bool` **DEFAULT:** `True` |
| `loading` | Whether the form should be in a loading state. Defaults to False. **TYPE:** `bool` **DEFAULT:** `False` |
| `submit_button_label` | The label of the submit button. Defaults to "Submit". **TYPE:** `str` **DEFAULT:** `'Submit'` |
| `submit_button_tooltip` | The tooltip of the submit button. Defaults to None. **TYPE:** `str` **DEFAULT:** `None` |
| `submit_button_disabled` | Whether the submit button should be disabled. Defaults to False. **TYPE:** `bool` **DEFAULT:** `False` |
| `clear_on_submit` | Whether the form should clear its contents after submitting. Defaults to False. **TYPE:** `bool` **DEFAULT:** `False` |
| `show_clear_button` | Whether the form should show a clear button. Defaults to False. **TYPE:** `bool` **DEFAULT:** `False` |
| `clear_button_label` | The label of the clear button. Defaults to "Clear". **TYPE:** `str` **DEFAULT:** `'Clear'` |
| `clear_button_tooltip` | The tooltip of the clear button. Defaults to None. **TYPE:** `str` **DEFAULT:** `None` |
| `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. Defaults to None. **TYPE:** `Callable[[Optional[JSONType]], Optional[str]]` **DEFAULT:** `None` |
| `label` | Markdown label for the form. Defaults to "". **TYPE:** `str` **DEFAULT:** `''` |
| `on_change` | Optional callback to run when this element's value changes. Defaults to None. **TYPE:** `Callable[[Optional[T]], None]` **DEFAULT:** `None` |

### element `instance-attribute`

```python
element = _clone()
```

### text `property`

```python
text: str
```

A string of HTML representing this element.

### validate `instance-attribute`

```python
validate = validate
```

### value `property` `writable`

```python
value: T
```

The element's current value.

### batch

```python
batch(**elements: UIElement[Any, Any]) -> 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**
>
> ```python3
> 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[Any, Any]` **DEFAULT:** `{}` |

### callout

```python
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:

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

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

### center

```python
center() -> Html
```

Center an item.

> **Example**
>
> ```python3
> mo.md("# Hello, world").center()
> ```

| RETURNS | DESCRIPTION |
| --- | --- |
| `[Html](https://docs.marimo.io/api/html/#marimo.Html)` | An `Html` object. |

### form

```python
form(
    label: str = "",
    *,
    bordered: bool = True,
    loading: bool = False,
    submit_button_label: str = "Submit",
    submit_button_tooltip: str | None = None,
    submit_button_disabled: bool = False,
    clear_on_submit: bool = False,
    show_clear_button: bool = False,
    clear_button_label: str = "Clear",
    clear_button_tooltip: str | None = None,
    validate: Callable[[JSONType | None], str | None]
    | None = None,
    on_change: Callable[[T | None], None] | 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:
```python
prompt = mo.ui.text_area().form()
```

Combine with `HTML.batch` to create a form made out of multiple `UIElements`:
```python
form = (
    mo.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:** `str \| None` **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:** `str \| None` **DEFAULT:** `None` |
| `validate` | A function that takes the form's value and returns an error message if invalid, or `None` if valid. **TYPE:** `Callable[[JSONType \| None], str \| None] \| None` **DEFAULT:** `None` |
| `on_change` | Optional callback to run when this element's value changes. Defaults to None. **TYPE:** `Callable[[T \| None], None] \| None` **DEFAULT:** `None` |

### from\_args `classmethod`

```python
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

```python
left() -> Html
```

Left-justify.

> **Example**
>
> ```python3
> mo.md("# Hello, world").left()
> ```

| RETURNS | DESCRIPTION |
| --- | --- |
| `[Html](https://docs.marimo.io/api/html/#marimo.Html)` | An `Html` object. |

### right

```python
right() -> Html
```

Right-justify.

> **Example**
>
> ```python3
> mo.md("# Hello, world").right()
> ```

| RETURNS | DESCRIPTION |
| --- | --- |
| `[Html](https://docs.marimo.io/api/html/#marimo.Html)` | An `Html` object. |

### style

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

Wrap an object in a styled container.

> **Example**
>
> ```python
> 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:** `dict[str, Any] \| None` **DEFAULT:** `None` |
| `**kwargs` | CSS styles as keyword arguments **TYPE:** `Any` **DEFAULT:** `{}` |