Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/voznik/streamlit-textcomplete
Streamlit Textcomplete - Autocomplete text in any textarea (HTMLTextAreaElement)
https://github.com/voznik/streamlit-textcomplete
autocomplete component streamlit
Last synced: about 13 hours ago
JSON representation
Streamlit Textcomplete - Autocomplete text in any textarea (HTMLTextAreaElement)
- Host: GitHub
- URL: https://github.com/voznik/streamlit-textcomplete
- Owner: voznik
- License: mit
- Created: 2024-07-13T14:35:33.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-16T20:10:59.000Z (27 days ago)
- Last Synced: 2024-10-29T23:44:33.545Z (14 days ago)
- Topics: autocomplete, component, streamlit
- Language: Python
- Homepage: https://textcomplete.streamlit.app
- Size: 1010 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Streamlit Textcomplete - Autocomplete text in any textarea
Streamlit Textcomplete is a custom Streamlit component designed to enhance text input fields with autocomplete functionality. It leverages the powerful `textcomplete` library to provide users with a seamless and intuitive autocomplete experience within Streamlit applications.
## Demo
[demo](https://textcomplete.streamlit.app/)
## Features
- **Autocomplete for Text Areas**: Enhance textarea in Streamlit with autocomplete functionality, making data input faster and more accurate.
- **Customizable Strategies**: Define your own strategies for text autocomplete, including username mentions, emoji suggestions, and more.
- **Easy Integration**: Seamlessly integrates with existing Streamlit applications with minimal setup.
- **Flexible and Extensible**: Easily extend the component to support additional autocomplete strategies as per your application's needs.
## Installation
To install Streamlit Textcomplete, run the following command in your terminal:
```sh
pip install streamlit-textcomplete
```
## Usage
To use Streamlit Textcomplete in your Streamlit application, follow these steps:
1. Import the [`textcomplete`] function from the package.
2. Define your autocomplete (multiple) strategies.
3. Define standard streamlit textarea but give it a defined label
4. Initialize the textcomplete component with this label & your strategies.
Example:
```python
import streamlit as st
from textcomplete import textcomplete, StrategyProps
original_label: str = "Textcomplete Example"
txt: str = st.text_area(
label=original_label,
key="st_text_area_1",
)
# Define your autocomplete strategies
username_strategy = StrategyProps(
id="userFullName",
match="\\B@(\\w*)$",
search=async_search_function, # Define your async search function as JS string
replace="([fullName]) => `${fullName}`",
template="([fullName]) => `🧑🏻 ${fullName}`",
)
# Initialize the textcomplete component
textcomplete(
area_label=original_label,
strategies=[username_strategy],
max_count=5,
# Additional options ...
)
```
## Development
To contribute to the development of Streamlit Textcomplete, you can set up a development environment by cloning the repository and installing the dependencies.
```sh
git clone https://github.com/voznik/streamlit-textcomplete.git
cd streamlit-textcomplete
pip install -r requirements.txt
```
## Testing
Run the tests to ensure everything is working as expected:
```sh
pytest
```
## License
Streamlit Textcomplete is MIT licensed, as found in the [LICENSE](LICENSE) file.
## Acknowledgments
- This project is built using the [Textcomplete](https://yuku.takahashi.coffee/textcomplete/) library.
- Special thanks to the Streamlit community for their support and contributions.