IntRangeSlider#

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.IntRangeSlider, documented in the Panel reference, and supersedes the classic pn.widgets.IntRangeSlider. On Panel 1.10 and later, prefer the panel.ui namespace.

import panel as pn
import panel_material_ui as pmui

pn.extension()

The IntRangeSlider widget allows selecting an integer range using a slider with two handles.


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
    • 

  • start (int): The range’s lower bound
    • 

  • end (int): The range’s upper bound
    • 

  • step (int): The interval between values
    • 

  • value (tuple): Tuple of upper and lower bounds of the selected range
    • 

  • value_throttled (tuple): Tuple of upper and lower bounds of the selected range 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 (string): The datetime’s format
    • 

  • label (str): The title of the widget.
    • 

  • marks (boolean | list[dict]):  Marks indicate predetermined values to which the user can move the slider. If True the options are shown as marks. If a list, it should contain dicts with ‘value’ and an optional ‘label’ keys.
    • 

  • orientation (Literal["horizonta", "vertical"]): Whether the slider should be displayed in a ‘horizontal’ or ‘vertical’ orientation.
    • 

  • show_value (boolean): Whether to show the widget value as a label or not.
    • 

  • tooltips (boolean | Literal["auto"]): Whether to display tooltips on the slider handle.
    • 

  • track (Literal["normal", "inverted"]): Whether to display ‘normal’ or ‘inverted’.
    • 







Styling#


    

  • sx (dict): Component level styling API.
    • 

  • theme_config (dict): Theming API.
    • 







Aliases#


For compatibility with Panel certain parameters are allowed as aliases:


    

  • name: Alias for label
    • 











Basic Usage#


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


int_range_slider = pmui.IntRangeSlider(
    label='Integer Range Slider',
    start=0, end=10, value=(2, 8), step=2
)

int_range_slider







            
            
IntRangeSlider.value returns a tuple of integer values that can be read out but cannot be set like other widgets:


int_range_slider.value





(2, 8)






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.IntRangeSlider(label='Distance', format='0a', start=100000, end=1000000)

tick_format = pmui.IntRangeSlider(label='Distance', format=PrintfTickFormatter(format='%d m'))

pmui.Column(str_format, tick_format)







            
            




Label#


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


pmui.IntRangeSlider()







            
            




Show Value#


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


pmui.IntRangeSlider(show_value=False)







            
            




Disabled#


The widget can be disabled with disabled=True.


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







            
            




Color#


You can specify a color.


pmui.FlexBox(*(
    pmui.IntRangeSlider(label=f'Int Range Slider ({color})', color=color)
    for color in pmui.IntRangeSlider.param.color.objects
))







            
            




Sizes#


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


pmui.Row(
    pmui.IntRangeSlider(label='Age Slider', size="small"),
    pmui.IntRangeSlider(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.IntRangeSlider(marks=marks)







            
            




Tooltip always visible#


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


pmui.IntRangeSlider(label='Age Slider', tooltips=True, value=(53, 94))







            
            




Tracks#


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


pmui.Row(
    pmui.IntRangeSlider(label='Age Slider', value=(53, 94), track=False),
    pmui.IntRangeSlider(label='Age Slider', value=(53, 94), track="inverted")
)







            
            




Vertical Sliders#


The orientation of a slider may be “vertical”:


pmui.IntRangeSlider(label='Age Slider', value=(53, 94), orientation="vertical")







            
            




Icon Labels#


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


pmui.IntRangeSlider(label="Zoom :material/zoom_out_map:", start=0, end=10, value=(2, 8))







            
            




API Reference#


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


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







            
            




References#


Panel Documentation:



Material UI Slider:





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