Project: streamlit-keyup

Text input that renders on keyup

Project Details

Latest version
0.2.2
Home Page
https://github.com/blackary/streamlit-keyup
PyPI Page
https://pypi.org/project/streamlit-keyup/

Project Popularity

PageRank
0.0029886687252369992
Number of downloads
64965

streamlit-keyup

PyPI version PyPI downloads GitHub Code style: Black

If you're collecting text input from your users in your streamlit app, st.text_input works well -- as long as you're happy with waiting to get the response when they're finished typing.

But, what if you want to get the input out, and do something with it every time they type a new key (AKA "on keyup")?

Open in Streamlit

filtering

Installation

pip install streamlit-keyup

Usage

import streamlit as st
from st_keyup import st_keyup

value = st_keyup("Enter a value", key="0")

# Notice that value updates after every key press
st.write(value)

# If you want to set a default value, you can pass one
with_default = st_keyup("Enter a value", value="Example", key="1")

# If you want to limit how often the value gets updated, pass `debounce` value, which
# will force the value to only update after that many milliseconds have passed
with_debounce = st_keyup("Enter a value", debounce=500, key="2")