streamlit-clickable-list 0.1.4

A simple clickable list component for streamlit

streamlit-clickable-list

See demo: https://clickable-list.streamlit.app/

How to install

pip install streamlit-clickable-list

How to use

col1, col2 = st.columns([1, 1])
with col1:
  def on_click(name: str) -> None:
    print(f"clicked: {name}")
    st.session_state['clicked'] = name

  st.header("Clickable list:")
  clickable_list(["aaa", "bbb", "ccc"], on_click, key="clickable_list")

with col2:
  st.header("Result:")
  if "clicked" in st.session_state:
    st.write(f"Clicked: {st.session_state['clicked'] or 'none'}")

For the component development

Based on: https://docs.streamlit.io/develop/concepts/custom-components/intro

Set up

• Set up python environment and dependencies
  • Used: v3.9
  • If you use uv, run:

    uv sync
    

• Set up Node.js environment
  • Used v22.13.1
  • If you use nvm, run:

    nvm use
    

• Set up node_modules

  cd frontend
  npm install
  

Run dev

• Use dev mode
  • Edit streamlit_clickable_list/__init__.py

    -_RELEASE = True
    +_RELEASE = False
    

• Run dev server

  cd frontend
  npm start
  

  • Then, a server will be run in port=3001
• Run streamlit app

  streamlit run sample.py
  
  # with WSL + uv
  uv run streamlit run sample.py --server.fileWatcherType=poll --server.address=0.0.0.0
  

  • Then, see localhost:8501 in your browser

Develop demo/demo.py

• Make symbolic link

  ln -s demo/demo.py ./
  

  • demo/demo.py use streamlit-clickable-list from PyPI. The symbolic link allow it to use local component code
• Run streamlit app

  streamlit run demo.py
  
  # with WSL + uv
  uv run streamlit run demo.py --server.fileWatcherType=poll --server.address=0.0.0.0
  

  • Then, see localhost:8501 in your browser
• Edit demo/demo.py

Release to PyPI

• Use release mode
  • Edit streamlit_clickable_list/__init__.py

    -_RELEASE = False
    +_RELEASE = True
    

• Build react app

  cd frontend
  npm build
  

• Run the app to check it in local

  streamlit run sample.py
  
  # with WSL + uv
  uv run streamlit run sample.py --server.fileWatcherType=poll --server.address=0.0.0.0
  

• Update version
  • Edit pyproject.toml to change version

    [project]
    name = "streamlit-clickable-list"
    -version = "X.Y.Z"
    +version = "X.Y.W"
    

• Build python
  • If you use uv, run:

    rm dist/streamlit_clickable_list-*
    uv build
    

• Push to GitHub (if you update README.md)

  git push origin main
  

• Publish to PyPI

  uv publish --token <PyPI token>
  

  • Check $HOME/.pypirc for <PyPI token>

Release to Streamlit Community Cloud

Only the first time:

• Log in Streamlit Community Cloud
• "Create app" > "Deploy a public app from GitHub"
• Input info in "Deploy an app"

To publish:

• First, publish it to PyPI
  • Because the app in Streamlit Community Cloud uses the streamlit-clickable-list in PyPI
• Add new packege in requirement.txt if needed
  • Do NOT use uv pip compile pyproject.toml > requirements.txt
    • The demo app in Streamlit Community Cloud needs streamlit-clickable-list package from pypi, though the package from pypi is not necessary to develop the component
• Push github, then it will be deployed to Streamlit Community Cloud

  git push origin main