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

# Slider

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

## marimo.ui.slider

```python
slider(
    start: Numeric | None = None,
    stop: Numeric | None = None,
    step: Numeric | None = None,
    value: Numeric | None = None,
    debounce: bool = False,
    disabled: bool = False,
    orientation: Literal[
        "horizontal", "vertical"
    ] = "horizontal",
    show_value: bool = False,
    include_input: bool = False,
    steps: Sequence[Numeric] | None = None,
    *,
    label: str = "",
    on_change: Callable[[Numeric | None], None]
    | None = None,
    full_width: bool = False,
)
```

Bases: `UIElement[Numeric, Numeric]`

A numeric slider over an interval.

> **Example**
>
> ```python
> slider = mo.ui.slider(start=1, stop=10, step=2)
> ```
> Or from a dataframe series:
> ```python
> slider = mo.ui.slider.from_series(df["column_name"])
> ```
> Or using numpy arrays:
> ```python
> import numpy as np
>
> # linear steps
> steps = np.array([1, 2, 3, 4, 5])
> slider = mo.ui.slider(steps=steps)
> # log steps
> log_slider = mo.ui.slider(steps=np.logspace(0, 3, 4))
> # power steps
> power_slider = mo.ui.slider(steps=np.power([1, 2, 3], 2))
> ```

| ATTRIBUTE | DESCRIPTION |
| --- | --- |
| `[value](#marimo.ui.slider.value)` | The current numeric value of the slider. **TYPE:** `Numeric` |
| `[start](#marimo.ui.slider.start)` | The minimum value of the interval. **TYPE:** `Numeric` |
| `[stop](#marimo.ui.slider.stop)` | The maximum value of the interval. **TYPE:** `Numeric` |
| `[step](#marimo.ui.slider.step)` | The slider increment. **TYPE:** `Optional[Numeric]` |
| `[steps](#marimo.ui.slider.steps)` | List of steps. **TYPE:** `Optional[Sequence[Numeric]]` |

| PARAMETER | DESCRIPTION |
| --- | --- |
| `start` | The minimum value of the interval. **TYPE:** `Optional[Numeric]` **DEFAULT:** `None` |
| `stop` | The maximum value of the interval. **TYPE:** `Optional[Numeric]` **DEFAULT:** `None` |
| `step` | The slider increment. **TYPE:** `Optional[Numeric]` **DEFAULT:** `None` |
| `value` | Default value. **TYPE:** `Optional[Numeric]` **DEFAULT:** `None` |
| `debounce` | Whether to debounce the slider to only send the value on mouse-up or drag-end. Defaults to False. **TYPE:** `bool` **DEFAULT:** `False` |
| `disabled` | Whether the slider is disabled. Defaults to False. **TYPE:** `bool` **DEFAULT:** `False` |
| `orientation` | The orientation of the slider, either "horizontal" or "vertical". Defaults to "horizontal". **TYPE:** `Literal['horizontal', 'vertical']` **DEFAULT:** `'horizontal'` |
| `show_value` | Whether to display the current value of the slider. Defaults to False. **TYPE:** `bool` **DEFAULT:** `False` |
| `include_input` | Whether to display an editable input with the current value of the slider. Defaults to False. **TYPE:** `bool` **DEFAULT:** `False` |
| `steps` | List of steps to customize the slider, mutually exclusive with `start`, `stop`, and `step`. **TYPE:** `Optional[Sequence[Numeric]]` **DEFAULT:** `None` |
| `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. **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` |

| RAISES | DESCRIPTION |
| --- | --- |
| `ValueError` | If `steps` is provided along with `start`, `stop`, or `step`. |
| `ValueError` | If neither `steps` nor both `start` and `stop` are provided. |
| `ValueError` | If `stop` is less than `start`. |
| `ValueError` | If `value` is out of bounds. |
| `TypeError` | If `steps` is not a sequence of numbers. |

| METHOD | DESCRIPTION |
| --- | --- |
| `[from_series](#marimo.ui.slider.from_series)` | DataFrameSeries, \*\*kwargs: Any) -> slider: Create a slider from a dataframe series. |

### start `instance-attribute`

```python
start: Numeric
```

### step `instance-attribute`

```python
step: Numeric | None
```

### steps `instance-attribute`

```python
steps: Sequence[Numeric] | None
```

### stop `instance-attribute`

```python
stop: Numeric
```

### text `property`

```python
text: str
```

A string of HTML representing this element.

### 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]
```

### from\_series `staticmethod`

```python
from_series(
    series: DataFrameSeries, **kwargs: Any
) -> slider
```

Create a slider from a dataframe series.

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