https://github.com/adriangalilea/streamlit-shortcuts
Streamlit keyboard shortcuts for your buttons.
https://github.com/adriangalilea/streamlit-shortcuts
streamlit streamlit-component
Last synced: about 1 year ago
JSON representation
Streamlit keyboard shortcuts for your buttons.
- Host: GitHub
- URL: https://github.com/adriangalilea/streamlit-shortcuts
- Owner: adriangalilea
- License: mit
- Created: 2023-11-28T21:52:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-08T20:44:59.000Z (over 1 year ago)
- Last Synced: 2025-03-30T01:07:42.288Z (about 1 year ago)
- Topics: streamlit, streamlit-component
- Language: Python
- Homepage: https://shortcuts.streamlit.app/
- Size: 264 KB
- Stars: 37
- Watchers: 2
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Streamlit Shortcuts
Streamlit Shortcuts allows you to easily add keyboard shortcuts to your Streamlit buttons.
[Live demo](https://shortcuts.streamlit.app/) <- [`example.py`](./example.py)
_triggering function with a keyboard shortcut_.
⭐ New in v0.1.9
- More robust logic.
- Simplified usage.
- Bug fixes.
- New [`example.py`](./example.py).
## Installation
```bash
pip install streamlit-shortcuts
```
## Example
Check out the `example.py` file in the repository for a complete working example. Here's a different snippet:
```python
import streamlit as st
from streamlit_shortcuts import button, add_keyboard_shortcuts
def greet(name):
st.success(f"Hello, {name}!")
button("Greet", "ctrl+shift+g", greet, hint=True, args=("World",))
```
To run the example, clone the repository and execute:
```bash
streamlit run example.py
```
This will launch a Streamlit app demonstrating various ways to use streamlit-shortcuts.
Extra: define shortcut function with a lambda:
```python
if button("Click me!", "ctrl+shift+c", lambda: st.success("Button clicked!"), hint=True):
st.write("Button was clicked")
```
## Keys
- Modifiers: 'Ctrl', 'Shift', 'Alt', 'Meta' ('Cmd' on Mac or 'Win' on Windows, thanks to @toolittlecakes)
- Common Keys: 'Enter', 'Escape', 'Space'
- Arrow Keys: 'ArrowLeft', 'ArrowRight', 'ArrowUp', 'ArrowDown'
Examples of Key Combinations:
- 'Ctrl+Enter'
- 'Shift+ArrowUp'
- 'Alt+Space'
For a complete list of key values, refer to:
https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values
## Versioning
We use semantic versioning. The current version is stored in the `VERSION` file in the root of the repository.
## Contributing
Contributions are welcome! If you have suggestions for improvements or bug fixes, please follow these steps:
1. Fork the repository
2. Create a new branch for your feature or bugfix
3. Make your changes
4. Add or update tests as necessary
5. Update the `VERSION` file if your changes warrant a version bump
6. Submit a pull request
Please make sure to update tests as appropriate and adhere to the existing coding style.
## Releasing New Versions
To release a new version:
1. Update the `VERSION` file with the new version number
2. Commit the change: `git commit -am "Bump version to X.Y.Z"`
3. Create a new tag: `git tag vX.Y.Z`
4. Push the changes and the tag: `git push && git push --tags`
The GitHub Actions workflow will automatically create a new release and publish to PyPI.
## Contributors
- @toolittlecakes
- Added 'Meta' modifier
- @quantum-ernest
- Improved usage ergonomics
- Keyboard hints
- @taylor-ennen
- Fixed usage `flow` of code
## Credits
Solution inspired by:
- https://github.com/streamlit/streamlit/issues/1291
- https://gist.github.com/brunomsantiago/e0ab366fc0dbc092c1a5946b30caa9a0
Special thanks to @brunomsantiago and @TomJohnH for their initial work on this concept.
Wrapped and extended for easier usage by the Streamlit Shortcuts team.