RSuite UI components for Streamlit — pickers, trees, carousel, timeline, and more.
Project description
Components
Pickers — rich popups with full interaction
Calendar popups, scrolling time panels, range selection with hover highlighting — everything you'd expect from a production date/time picker.
| Component | Description | Streamlit equivalent |
|---|---|---|
date_picker |
Calendar popup with format control, one-tap, ISO week | st.date_input |
date_range_picker |
Dual-calendar popup for date ranges, hover range | st.date_input (range mode) |
time_picker |
Time picker with scrolling panel, AM/PM | st.time_input |
time_range_picker |
Time range picker with dual panels | -- |
Inputs — simple keyboard-only entry
Lightweight alternatives with no popup. Users navigate date segments with arrow keys and typing.
| Component | Description | Streamlit equivalent |
|---|---|---|
date_input |
Keyboard-only date input (no popup) | st.date_input |
date_range_input |
Keyboard-only date range input (no popup) | st.date_input (range mode) |
Selection
| Component | Description | Streamlit equivalent |
|---|---|---|
radio_tile |
Tile-based radio group with icons and descriptions | st.radio |
Tree — hierarchical data selection
| Component | Description | Streamlit equivalent |
|---|---|---|
check_tree |
Standalone tree with checkboxes, searchable | -- |
check_tree_picker |
Dropdown picker with checkbox tree inside | st.multiselect (flat) |
multi_cascade_tree |
Multi-select cascading column navigation | -- |
Display & Input
| Component | Description | Streamlit equivalent |
|---|---|---|
carousel |
Content/image carousel with autoplay, local files & URLs | -- |
timeline |
Timeline with custom react-icons | -- |
pin_input |
PIN/verification code input with masking | st.text_input |
All components are MIT licensed (RSuite is fully open-source).
Requirements
- Streamlit >= 1.51: these components are built on Streamlit Components v2; 1.51 is the first release with the
st.components.v2API they rely on. st-rsuite works on every release from 1.51 onward (on 1.51 and 1.52 a small compatibility shim appliesisolate_styleson the per-call renderer; from 1.53 it is applied at registration). On older Streamlit the components cannot register and you get amust be declared ... with asset_direrror (see Troubleshooting). - Python >= 3.10
Installation
uv add st-rsuite
or with pip:
pip install st-rsuite
Quick start
import streamlit as st
from datetime import date, time, timedelta
from st_rsuite import (
date_picker, date_range_picker, time_picker,
time_range_picker, date_input, date_range_input,
radio_tile, check_tree, check_tree_picker,
multi_cascade_tree, carousel, timeline, pin_input,
)
# ── Pickers ───────────────────────────────────────────────────────────────────
d = date_picker(label="Pick a date", value=date.today(), one_tap=True, key="my_dp")
start, end = date_range_picker(
label="Trip dates",
value=(date.today(), date.today() + timedelta(days=7)),
hover_range="week",
key="my_drp",
)
t = time_picker(
label="Pick a time", value=time(9, 30),
format="hh:mm aa", show_meridiem=True, key="my_tp",
)
t_start, t_end = time_range_picker(
label="Shift hours",
value=(time(9, 0), time(17, 0)),
key="my_trp",
)
# ── Inputs ────────────────────────────────────────────────────────────────────
d2 = date_input(label="Type a date", value=date.today(), key="my_di")
start, end = date_range_input(
label="Date range",
value=(date.today(), date.today() + timedelta(days=7)),
key="my_dri",
)
# ── Selection ─────────────────────────────────────────────────────────────────
selected = radio_tile(
options=[
{"value": "a", "label": "Option A", "description": "First option", "icon": "☀️"},
{"value": "b", "label": "Option B", "description": "Second option", "icon": "🌙"},
],
value="a",
inline=True,
key="my_tile",
)
# ── Tree components ───────────────────────────────────────────────────────────
tree_data = [
{"value": "frontend", "label": "Frontend", "children": [
{"value": "react", "label": "React"},
{"value": "vue", "label": "Vue"},
]},
{"value": "backend", "label": "Backend", "children": [
{"value": "python", "label": "Python"},
{"value": "go", "label": "Go"},
]},
]
checked = check_tree(data=tree_data, searchable=True, default_expand_all=True, key="my_ct")
picked = check_tree_picker(
data=tree_data, placeholder="Select items", key="my_ctp",
)
cascade_data = [
{"value": "us", "label": "US", "children": [
{"value": "ca", "label": "California", "children": [
{"value": "sf", "label": "San Francisco"},
]},
]},
]
cascade_selected = multi_cascade_tree(data=cascade_data, key="my_mct")
# ── Carousel ──────────────────────────────────────────────────────────────────
active = carousel(
items=[
{"content": "Slide 1", "background": "#7c3aed"},
{"content": "Slide 2", "background": "#6d28d9"},
],
autoplay=True,
key="my_carousel",
)
# ── Timeline ──────────────────────────────────────────────────────────────────
timeline(
items=[
{"content": "Order placed", "time": "10:00", "icon": "FaCreditCard", "color": "#7c3aed"},
{"content": "Shipped", "time": "14:30", "icon": "FaTruck", "color": "#0891b2"},
{"content": "Delivered", "time": "11:30", "icon": "FaCheck", "color": "#059669"},
],
align="left",
key="my_timeline",
)
# ── PinInput ──────────────────────────────────────────────────────────────────
code = pin_input(length=6, mask=False, otp=True, key="my_pin")
API
Pickers
date_picker
date_picker(
label="",
value=None, # date object or YYYY-MM-DD string
format="yyyy-MM-dd",
appearance="default", # 'default' | 'subtle'
size="md",
placeholder="",
placement="bottomStart",
one_tap=False, # single-click select (no OK button)
disabled=False,
cleanable=True,
block=False, # full width
iso_week=False, # Monday-start weeks
show_week_numbers=False,
editable=True, # allow keyboard entry (False = toggle-only)
loading=False, # show a loading indicator
min_date=None, # earliest selectable date (inclusive)
max_date=None, # latest selectable date (inclusive)
disabled_dates=None, # list of individual dates to disable
disabled_weekdays=None, # list of ints, 0=Monday .. 6=Sunday
limit_start_year=None, # lower year bound in the calendar
limit_end_year=None, # upper year bound in the calendar
calendar_default_date=None, # month the calendar opens on
locale=None, # e.g. 'ja_JP', 'zh_CN', 'es_ES'
on_change=None,
key=None,
) -> date | None
date_range_picker
date_range_picker(
label="",
value=None, # tuple of (date, date)
format="yyyy-MM-dd",
character=" ~ ",
appearance="default",
size="md",
placeholder="",
placement="bottomStart",
disabled=False,
cleanable=True,
block=False,
iso_week=False,
show_week_numbers=False,
show_one_calendar=False, # single calendar panel
one_tap=False,
hover_range=None, # 'week' | 'month' | None
editable=True, # allow keyboard entry (False = toggle-only)
loading=False, # show a loading indicator
min_date=None, # earliest selectable date (inclusive)
max_date=None, # latest selectable date (inclusive)
disabled_dates=None, # list of individual dates to disable
disabled_weekdays=None, # list of ints, 0=Monday .. 6=Sunday
limit_start_year=None,
limit_end_year=None,
ranges=None, # shortcut presets; [] removes RSuite defaults
default_calendar_value=None, # (start, end) month the panels open on
locale=None,
on_change=None,
key=None,
) -> tuple[date | None, date | None]
time_picker
time_picker(
label="",
value=None, # time object or HH:MM string
format="HH:mm", # 'HH:mm', 'HH:mm:ss', 'hh:mm aa'
appearance="default",
size="md",
placeholder="",
placement="bottomStart",
disabled=False,
cleanable=True,
block=False,
show_meridiem=False, # AM/PM toggle
editable=True, # allow keyboard entry (False = toggle-only)
loading=False, # show a loading indicator
min_hour=None, # earliest selectable hour, 0-23 (hides earlier)
max_hour=None, # latest selectable hour, 0-23 (hides later)
hidden_hours=None, # list of hours 0-23 to hide
hidden_minutes=None, # list of minutes 0-59 to hide
hidden_seconds=None, # list of seconds 0-59 to hide
locale=None,
on_change=None,
key=None,
) -> time | None
time_range_picker
time_range_picker(
label="",
value=None, # tuple of (time, time)
format="HH:mm",
character=" ~ ",
appearance="default",
size="md",
placeholder="",
placement="bottomStart",
disabled=False,
cleanable=True,
block=False,
show_meridiem=False,
editable=True,
loading=False,
min_hour=None, # earliest selectable hour, 0-23 (hides earlier)
max_hour=None, # latest selectable hour, 0-23 (hides later)
hidden_hours=None,
hidden_minutes=None,
hidden_seconds=None,
locale=None,
on_change=None,
key=None,
) -> tuple[time | None, time | None]
Restricting selectable dates
date_picker and date_range_picker accept declarative constraints (the
keyboard-only date_input / date_range_input do not, as RSuite has no calendar
to disable). Callables can't cross the Python/JS boundary, so pass plain values
and the frontend builds the shouldDisableDate predicate for you:
from datetime import date
from st_rsuite import date_picker
# Only weekdays in a fixed window, with a couple of holidays blocked out.
picked = date_picker(
label="Appointment",
min_date=date(2026, 6, 1),
max_date=date(2026, 6, 30),
disabled_dates=[date(2026, 6, 19)], # individual dates
disabled_weekdays=[5, 6], # 0=Monday .. 6=Sunday, so Sat/Sun
key="appt",
)
min_date / max_date are inclusive. disabled_weekdays uses the same
numbering as Python's date.weekday() (Monday is 0). limit_start_year /
limit_end_year bound the years reachable in the calendar, relative to the
current selection.
Shortcut ranges
date_range_picker shows shortcut presets beside the calendar. It ships RSuite's
defaults (Today, Yesterday, Last 7 days); pass your own with ranges, or
ranges=[] to hide the sidebar entirely.
from datetime import date, timedelta
from st_rsuite import date_range_picker
today = date.today()
start, end = date_range_picker(
label="Report window",
ranges=[
{"label": "Last 7 days", "value": (today - timedelta(days=6), today)},
{"label": "Last 30 days", "value": (today - timedelta(days=29), today)},
{"label": "This month", "value": (today.replace(day=1), today)},
],
key="report",
)
Each preset is {"label": str, "value": (start, end)}, with optional
"close_overlay": True (commit and close on click) and
"placement": "bottom" | "left".
Inputs
Simple keyboard-only components — no popups, designed for compact quick-entry scenarios.
date_input
date_input(
label="",
value=None, # date object or YYYY-MM-DD string
format="yyyy-MM-dd",
size="md",
placeholder=None,
disabled=False,
locale=None,
on_change=None,
key=None,
) -> date | None
date_range_input
date_range_input(
label="",
value=None, # tuple of (date, date) or (str, str)
format="yyyy-MM-dd",
character=" ~ ", # separator between start and end
size="md",
placeholder=None,
disabled=False,
locale=None,
on_change=None,
key=None,
) -> tuple[date | None, date | None]
Selection
radio_tile
radio_tile(
options=[...], # list of dicts: {value, label, description?, icon?}
value=None, # default selected value
inline=False, # horizontal layout
disabled=False,
locale=None,
on_change=None,
key=None,
) -> str | None
Tree / Hierarchical
check_tree
check_tree(
data=[...], # [{value, label, children?: [...]}]
value=None, # list of selected values
cascade=True, # parent/child cascade selection
searchable=True, # show search input
default_expand_all=False,
show_indent_line=False,
height=360, # tree height in px
disabled=False,
uncheckable_values=None,
locale=None,
on_change=None,
key=None,
) -> list[str]
check_tree_picker
check_tree_picker(
data=[...], # [{value, label, children?: [...]}]
value=None, # list of selected values
cascade=True,
searchable=True,
countable=True, # show selected count in toggle
appearance="default",
size="md",
placeholder="Select",
placement="bottomStart",
disabled=False,
cleanable=True,
block=False,
default_expand_all=False,
show_indent_line=False,
height=320,
uncheckable_values=None,
locale=None,
on_change=None,
key=None,
) -> list[str]
multi_cascade_tree
multi_cascade_tree(
data=[...], # [{value, label, children?: [...]}]
value=None, # list of selected values
cascade=True,
searchable=False,
column_width=156, # width of each cascade column
column_height=320, # height of each cascade column
disabled=False,
uncheckable_values=None,
locale=None,
on_change=None,
key=None,
) -> list[str]
Display & Input
carousel
carousel(
items=[...], # [{content?, src?, alt?, background?, color?}] # src: URL or local file path
autoplay=True,
autoplay_interval=4000, # ms between slides
placement="bottom", # indicator: 'top' | 'bottom' | 'left' | 'right'
shape="dot", # indicator: 'dot' | 'bar'
active_index=0,
locale=None,
on_change=None,
key=None,
) -> int # active slide index
A non-URL
srcis read from the local filesystem and inlined as a base64 data URI, so it must be a trusted path chosen by the app, not unsanitized user input.
timeline
timeline(
items=[...], # [{content, time?, icon?, color?}]
align="left", # 'left' | 'right' | 'alternate'
endless=False, # continuous timeline line
locale=None,
key=None,
) -> None # display-only
The icon field accepts react-icons names (e.g. "FaCheck", "FaTruck", "MdEmail") or emoji strings as fallback. 150+ icons from Font Awesome 5 and Material Design are included.
pin_input
pin_input(
length=6,
value="",
mask=False, # password-style masking
type="number", # 'number' | 'alphabetic' | 'alphanumeric'
size="md",
placeholder="",
disabled=False,
read_only=False,
otp=False, # one-time password autocomplete
attached=False, # remove spacing between fields
locale=None,
on_change=None,
key=None,
) -> str # current PIN value
Locale / i18n
All components accept a locale parameter to switch calendar labels, month/day names, and button text to the target language. RSuite ships 29 locales out of the box.
When locale is not set, the component automatically detects the browser's language (navigator.language) and uses the closest matching RSuite locale.
from st_rsuite import date_picker
# Japanese
date_picker(label="日付を選択", locale="ja_JP", one_tap=True, key="jp")
# Chinese (Simplified)
date_picker(label="选择日期", locale="zh_CN", one_tap=True, key="cn")
# Spanish
date_picker(label="Elegir fecha", locale="es_ES", one_tap=True, key="es")
Available locales: ar_EG, ca_ES, cs_CZ, da_DK, de_DE, en_GB, en_US, es_AR, es_ES, fa_IR, fi_FI, fr_FR, gu_IN, hu_HU, it_IT, ja_JP, kk_KZ, ko_KR, ne_NP, nl_NL, pl_PL, pt_BR, ru_RU, sv_SE, th_TH, tr_TR, uk_UA, zh_CN, zh_TW
Running the example
uv add st-rsuite
uv run streamlit run examples/showcase.py
Development
# Clone and install
git clone https://github.com/lperezmo/st-rsuite.git
cd st-rsuite
uv sync --dev
# Build frontend
cd st_rsuite/frontend
npm install
npm run build
cd ../..
# Run showcase
uv run streamlit run examples/showcase.py
Troubleshooting
streamlit.errors.StreamlitAPIException: Component 'st-rsuite.<name>' must be declared in pyproject.toml with asset_dir to use file-backed js
Streamlit could not find st-rsuite's bundled frontend assets when it started. Check two things:
-
Streamlit version. st-rsuite needs Streamlit >= 1.51 (the first release with the
st.components.v2API). Upgrade and fully restart the app:uv add "streamlit>=1.51" # or: pip install -U "streamlit>=1.51"
-
st-rsuite install. Make sure the package is current and installed from its wheel, which ships the built assets:
uv add -U st-rsuite(orpip install -U st-rsuite), then restart the app.
Disclaimer
Full disclaimer: This project was built with the help of Claude Opus 4.6 by Anthropic, using Claude Code and streamlit/agent-skills. It is heavily based on st-mui.
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file st_rsuite-0.7.0.tar.gz.
File metadata
- Download URL: st_rsuite-0.7.0.tar.gz
- Upload date:
- Size: 2.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b30f55ff55a048aa13e8a145ed74cee8292616837aca3e0949300e1333382c42
|
|
| MD5 |
5783690bf921f2ea7fc49b62a5a4e112
|
|
| BLAKE2b-256 |
0c37cb60008a61c17e76046b22c48d985d0a71e7a3fa650d44b3909cd00260cd
|
File details
Details for the file st_rsuite-0.7.0-py3-none-any.whl.
File metadata
- Download URL: st_rsuite-0.7.0-py3-none-any.whl
- Upload date:
- Size: 2.8 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
44f25b425b563d2c86da52409422952fad10fdcc9a1ede4568525f293e541e75
|
|
| MD5 |
a5fc1af07f864cbbedfbd5c4cee39445
|
|
| BLAKE2b-256 |
5f2c6042f25657ae085ecc61600c04c3e73cfd10c587f17932f3b1951a226c59
|