Skip to content

A small library to add extra functionality on top of streamlit's st.query_params API

License

Notifications You must be signed in to change notification settings

Asaurus1/streamlit-qs

Repository files navigation

QueryParams Widgets for Streamlit

GitHub Actions Workflow Status GitHub last commit PyPI - Version PyPI - Python Version PyPI - Wheel PyPI - Implementation PyPI - Downloads Licence Streamlit Version pdm-managed

The functions in this library allow you to easily create "permalink-like" functionality in your application, This can let users to share links with others that will populate streamlit with the same set of input values that they were using. Or you can use the query string to pass data into your streamlit application from another website or program.

Installation

First install Streamlit (of course!) then install this library:

pip install streamlit-qs

Or, to install the latest source:

pip install git+https://github.com/Asaurus1/streamlit-qs.git@main

Example

import streamlit as st
import streamlit_qs as stqs

st.markdown("[Click this URL](?input_some_text=Hello+World)") 
stqs.text_input_qs("Enter Some Text", key="input_some_text")

For more examples, including ✨customization options✨, see the demo app.

Version Compatibility

For Streamlit v1.29.0 or below use release v0.2.0 of this app For Streamlit v1.30.0 or above, use the latest released version of this app above v0.2.0

About

A small library to add extra functionality on top of streamlit's st.query_params API

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages