streamlit-number-controller 0.1.0

A compact plus/minus number controller for Streamlit apps.

streamlit-number-controller

A compact plus/minus number controller for Streamlit apps.

import streamlit as st
from streamlit_number_controller import number_controller

value = number_controller(
    title="Quantity",
    min_value=0,
    max_value=10,
    default_value=1,
    key="quantity",
    minus_color="#ef4444",
    plus_color="#2563eb",
    minus_button_color="#fee2e2",
    plus_button_color="#dbeafe",
)

st.write("Current value:", value)

Installation

pip install streamlit-number-controller

API

number_controller(
    title: str,
    min_value: int,
    max_value: int,
    default_value: int,
    *,
    key: str | None = None,
    step: int = 1,
    minus_icon: str = ":material/remove:",
    plus_icon: str = ":material/add:",
    minus_color: str | None = None,
    plus_color: str | None = None,
    minus_button_color: str | None = None,
    plus_button_color: str | None = None,
) -> int

The controller stores its value in st.session_state, keeps the displayed value and returned value in sync, and clamps changes to min_value / max_value.

Development

Run the example app:

streamlit run examples/app.py

Build the package:

python -m build

Upload to TestPyPI:

python -m twine upload --repository testpypi dist/*

Upload to PyPI:

python -m twine upload dist/*