Streamlit component that allows you to do manage local storage
Project description
Streamlit local storage
This repo is to help streamlt users manage data in a browser's local storage.
Built on the use-local-storage-state
that allows for real time updates especially important when local storage item is deleted.
for more details:
https://www.npmjs.com/package/use-local-storage-state
pip install streamlit-local-storage
store items to local storage
from streamlit_local_storage import LocalStorage
localS = LocalStorage()
itemKey = "camera"
itemValue = "Tarah"
localS.setItem(itemKey, itemValue)
get item from local storage
itemKey = "Taylor Swift"
local_storage_item = localS.getItem(itemKey)
get all items saved on local storage
saved_individual = localS.getAll()
st.write(saved_individual)
delete all
localS.deleteAll()
when getting local storage items with streamlit widgets
st.subheader("Method 1")
def LocalStorageManager():
return LocalStorage()
localS = LocalStorageManager()
if "get_val" not in st.session_state:
st.session_state["get_val"] = None
with st.form("get_data"):
st.text_input("key", key="get_local_storage_v")
st.form_submit_button("Submit")
if st.session_state["get_local_storage_v"] != "":
val_ = localS.getItem(st.session_state["get_local_storage_v"], key="test_get_item")
st.session_state["get_val"] = val_
st.write(st.session_state["get_val"])
### When using callbacks for get item, can use the below example. But it wont reveal data unless app has rendered twice. But callback can be work without a hitch generally (based on my tests).
st.subheader("Method 2 - using callback. Does not load instantly especially for get storage")
def LocalStorageManager():
return LocalStorage()
localS = LocalStorageManager()
if "get_val_2" not in st.session_state:
st.session_state["get_val_2"] = None
if "st_col_test" not in st.session_state:
st.session_state["st_col_test"] = None
def change_state_2():
with st.session_state["st_col_test"][0]: # call method from below form
localS.getItem(st.session_state["get_local_storage_v_2"], key="test_get_item_2") # initialise/run method and value will be stored in `session_state`
with st.form("get_data_2"):
st.text_input("key", key="get_local_storage_v_2")
st.form_submit_button("Submit", on_click=change_state_2)
st.session_state["st_col_test"] = st.columns(1) #to make sure rendering happens below form (or other streamlit element. Else the re-rendering of component upon re-running of up will be run at the top of the streamlit component (form here) which creates nasty ui experience.)
if "test_get_item_2" in st.session_state and st.session_state["test_get_item_2"] != None:
st.session_state["get_val_2"] = st.session_state["test_get_item_2"] # if local storage method is initialised, get the stored value and use it throughout the app.
st.write(st.session_state["get_val_2"])
Remember to refresh browser if it does not pop up instantly in local storage.
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
File details
Details for the file streamlit_local_storage-0.0.25.tar.gz
.
File metadata
- Download URL: streamlit_local_storage-0.0.25.tar.gz
- Upload date:
- Size: 538.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.19
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b7c3e8ae7c14a68b47c980b167306181292213736dfa71850c8d3204dc2a9cd |
|
MD5 | a3c5ea1992b0bf720ffefa66df7c2b2c |
|
BLAKE2b-256 | d1ad5e92a9355c2f32c162f0e2a2262b90697385edf0fe64bc66a27eb652ac95 |
File details
Details for the file streamlit_local_storage-0.0.25-py3-none-any.whl
.
File metadata
- Download URL: streamlit_local_storage-0.0.25-py3-none-any.whl
- Upload date:
- Size: 543.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.19
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0ef85618ed8c44f347b7acffb2d104da5b6915e6a4e24612f12a4d2cc355b951 |
|
MD5 | 26cf632585834db468e2bbc02415ebaa |
|
BLAKE2b-256 | 7ba6502b00b6db10c3d467ec57d822d6647a35f0328ef03668aa5b6dd160f966 |