EditableIntSlider#

Download this notebook from GitHub (right-click to download).


This component replaces a classic Panel component

This component is being integrated into Panel. Starting with Panel 1.10 it is available as pn.ui.EditableIntSlider, documented in the Panel reference, and supersedes the classic pn.widgets.EditableIntSlider. On Panel 1.10 and later, prefer the panel.ui namespace.

import panel as pn
import panel_material_ui as pmui

pn.extension()

The EditableIntSlider widget allows selecting selecting an integer value within a set bounds using a slider and for more precise control offers an editable number input box.

Discover more on using widgets to add interactivity to your applications in the how-to guides on interactivity. Alternatively, learn how to set up callbacks and (JS-)links between parameters or how to use them as part of declarative UIs with Param.

Parameters:#

For details on other options for customizing the component see the customization guides.

Core#

  • disabled (boolean): Whether the widget is editable

  • end (int): The upper bound for the slider, can be overridden by a higher value.

  • fixed_start (int | None): A fixed lower bound for the slider and input, value cannot exceed this.

  • fixed_end (int | None): A fixed upper bound for the slider and input, value cannot exceed this.

  • start (int): The lower bound for the slider, can be overridden by a lower value.

  • step (int): The interval between values

  • value (int): The selected value as an int type

  • value_throttled (int): The selected value as a int type throttled until mouseup

Display#

  • bar_color (color): Color of the slider bar as a hexadecimal RGB value

  • direction (str): Whether the slider should go from left to right (‘ltr’) or right to left (‘rtl’)

  • format (str, bokeh.models.TickFormatter): Formatter to apply to the slider value

  • inline_layout (boolean): Whether the editable input field should be laid out inline with the slider.

  • label (str): The title of the widget

  • orientation (str): Whether the slider should be displayed in a ‘horizontal’ or ‘vertical’ orientation.

  • tooltips (boolean): Whether to display tooltips on the slider handle

Styling#

  • sx (dict): Component level styling API.

  • theme_config (dict): Theming API.

Aliases#

For compatibility with Panel certain parameters are allowed as aliases:

  • button_style: Alias for variant

  • button_type: Alias for color

  • name: Alias for label


Basic Usage#

The EditableIntSlider widget allows selecting a integer value in a range defined by the start and end values:

int_slider = pmui.EditableIntSlider(label='Integer Slider', start=0, end=8, step=2, value=4)

int_slider

The value of the widget returns a integer and can be accessed and set like any other widget:

int_slider.value
4

Fixed Range#

The slider is bounded by the start and end values but the text input fields can exceed end and go below start. If value should be fixed to a certain range it can be set with fixed_start and fixed_end:

pmui.EditableIntSlider(
    label='Fixed Range', start=0, end=8, step=2, value=4, fixed_start=-10, fixed_end=20
)

Format#

A custom format string or bokeh TickFormatter may be used to format the slider values:

from bokeh.models.formatters import PrintfTickFormatter

str_format = pmui.EditableIntSlider(label='Rank', format='0o', start=0, end=100)

tick_format = pmui.EditableIntSlider(label='Count', format=PrintfTickFormatter(format='%d ducks'), start=0, end=100)

pmui.Column(str_format, tick_format)

Label#

You may remove the label/ name by not setting it.

pmui.EditableIntSlider()

Show Value#

You may remove the value label by setting show_value=False.

pmui.EditableIntSlider(show_value=False)

Disabled#

The widget can be disabled with disabled=True.

pmui.EditableIntSlider(label='Int Slider (disabled)', disabled=True)

Inline#

The editable text entry field can be added rendered inline with inline_layout=True:

pmui.EditableIntSlider(label='Int Range Slider (inline)', inline_layout=True)

Color#

You can specify a color.

pmui.FlexBox(*(
    pmui.EditableIntSlider(label=f'Float Slider ({color})', color=color)
    for color in pmui.EditableIntSlider.param.color.objects
))

Sizes#

For smaller slider, use the parameter size="small".

pmui.Row(
    pmui.EditableIntSlider(label='Age Slider', size="small"),
    pmui.EditableIntSlider(label='Age Slider', size="medium"),
)

Custom Marks#

You can have custom marks by providing a rich list to the marks parameter. Note that unlike continuous sliders the value of the marks should be the integer index of the option.

marks = [
  {
    "value": 0,
    "label": '0°C',
  },
  {
    "value": 30,
    "label": '30°C',
  },
  {
    "value": 60,
    "label": '60°C',
  },
  {
    "value": 100,
    "label": '100°C',
  },
]

pmui.EditableIntSlider(marks=marks)

Tooltip always visible#

You can force the thumb label to be always visible with tooltips=True.

pmui.EditableIntSlider(label='Age', tooltips=True, value=42)

Tracks#

The track can be inverted or removed with track="inverted" and track=False respectively:

pmui.Row(
    pmui.EditableIntSlider(label='Age Slider', value=42, track="inverted"),
    pmui.EditableIntSlider(label='Age Slider', value=42, track=False)
)

Vertical Sliders#

The orientation of a slider may be “vertical”:

pmui.EditableIntSlider(label='Age Slider', value=42, orientation="vertical")

Icon Labels#

Material icon tokens like :material/zoom_out_map: render as icons in labels and option labels.

pmui.EditableIntSlider(
    label=":material/zoom_out_map: Zoom level",
    start=0,
    end=10,
    step=1,
    value=4,
)

API Reference#

The EditableIntSlider widget exposes a number of options which can be changed from both Python and Javascript. Try out the effect of these parameters interactively:

pmui.EditableIntSlider().api(jslink=True)

References#

Panel Documentation:

Material UI Slider:


Download this notebook from GitHub (right-click to download).