Skip to content

Latest commit

 

History

History
40 lines (25 loc) · 2.17 KB

README.md

File metadata and controls

40 lines (25 loc) · 2.17 KB
Raw

Streamlit-JS-Eval

PyPI version Downloads Streamlit App

SJE is a custom Streamlit component, built to evaluate arbitrary Javascript expressions and return the result. It can become useful in doing certain functionalities which are simple things in JavaScript, but unavailable or difficult to do in Streamlit. Examples include cookie management, writing to clipboard, getting device width (e.g. to check if we are on a mobile device), getting browser language, sharing something through Android's share feature, knowing user agent, etc. See MDN docs for more information about Web APIs.

  • Version 0.1.7 - March 2024: Proposed a workaround for issue #2.

Install

pip3 install streamlit_js_eval

Example

st.write(f"Screen width is {streamlit_js_eval(js_expressions='screen.width', key = 'SCR')}")

key is an arbitrary but unique string, required by Streamlit components API for each call to streamlit_js_eval.

Common JavaScript functionalities

Some more common functionalities are already implemented as Python functions. Examples include:

# Returns user's location after asking for permission when the user clicks the generated link with the given text
location = get_geolocation()
# The URL parts of the page
location_json = get_page_location()

See streamlit_js_eval/__init__.py for more functions. Check a demo in example.py or see it live.

Known Limitations

  • It seems SJE has issues with st.button when getting called from inside a branch in Streamlit (e.g. in a loop, if-else block, ...). In version 0.1.7, you may use the custom bootstrapButton as a workaround in such situations.