adriangalilea / streamlit-shortcuts

Streamlit keyboard shortcuts for your buttons.

Streamlit Shortcuts

Streamlit Shortcuts allows you to easily add keyboard shortcuts to your Streamlit buttons.

Installation

pip install streamlit-shortcuts

Example

⭐ NEW! thanks to @quantum-ernest

import streamlit as st
import streamlit_shortcuts

def delete_callback():
    st.write("DELETED!")

streamlit_shortcuts.button("delete", on_click=delete_callback, shortcut="Ctrl+Shift+X")

🥱 Old

import streamlit as st
from streamlit_shortcuts import add_keyboard_shortcuts

def delete_callback():
    st.write("DELETED!")

st.button("delete", on_click=delete_callback)

add_keyboard_shortcuts({
    'Ctrl+Shift+X': 'delete',
})

The 'Ctrl+Shift+X' combination will trigger "Another Button".

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

Contributing

Contributions are welcome! If you have suggestions for improvements or bug fixes, please feel free to make a pull request or open an issue.

Contributors

@toolittlecakes - Added 'Meta' modifier

@quantum-ernest - Improved usage ergonomics

@taylor-ennen - Fixed usage flow of code

Credits

Solution seen on: streamlit/streamlit#1291

https://gist.github.com/brunomsantiago/e0ab366fc0dbc092c1a5946b30caa9a0

@brunomsantiago

@TomJohnH

And wrapped for comfier usage.

streamlit-shortcuts's Issues

Readme example does not match code functionality

In the section of readme containing the new example usage, 'shortcut' is passed a string however the code calls for a dictionary, I would provide the fix myself but I'm not sure the direction your headed, keeping the dictionary or implement strings for the single button example that's been added.

bump to v0.1.2 for 'Meta modifier' and 'Usage ergonomics'

streamlit-shortcuts/src/streamlit_shortcuts/streamlit_shortcuts.py

Line 7 in 43d3e28

# TODO bump to v0.1.2 for 'Meta modifier' and 'Usage ergonomics'

import streamlit as st


# TODO bump to v0.1.2 for 'Meta modifier' and 'Usage ergonomics'
# TODO add keyboard tooltip to button (streamlit-extras)
# https://arnaudmiribel.github.io/streamlit-extras/extras/keyboard_text/

def add_keyboard_shortcuts(key_combinations: dict[str, str]):
    """

bump to v0.1.2 for 'Meta modifier'

streamlit-shortcuts/src/streamlit_shortcuts/streamlit_shortcuts.py

Line 3 in bfca991

# TODO bump to v0.1.2 for 'Meta modifier'

import streamlit.components.v1 as components

# TODO bump to v0.1.2 for 'Meta modifier'
# TODO add keyboard tooltip to button (streamlit-extras)
# TODO improve usage ergonomics

def add_keyboard_shortcuts(key_combinations: dict[str, str]):
    """

improve usage ergonomics

streamlit-shortcuts/src/streamlit_shortcuts/streamlit_shortcuts.py

Line 5 in bfca991

# TODO improve usage ergonomics

import streamlit.components.v1 as components

# TODO bump to v0.1.2 for 'Meta modifier'
# TODO add keyboard tooltip to button (streamlit-extras)
# TODO improve usage ergonomics

def add_keyboard_shortcuts(key_combinations: dict[str, str]):
    """

add keyboard tooltip to button (streamlit-extras)

streamlit-shortcuts/src/streamlit_shortcuts/streamlit_shortcuts.py

Line 4 in bfca991

# TODO add keyboard tooltip to button (streamlit-extras)

import streamlit.components.v1 as components

# TODO bump to v0.1.2 for 'Meta modifier'
# TODO add keyboard tooltip to button (streamlit-extras)
# TODO improve usage ergonomics

def add_keyboard_shortcuts(key_combinations: dict[str, str]):
    """

add keyboard hint to button (streamlit-extras)

https://arnaudmiribel\.github\.io/streamlit\-extras/extras/keyboard\_text/

streamlit-shortcuts/src/streamlit_shortcuts/streamlit_shortcuts.py

Line 7 in eb0ca95

# TODO add keyboard hint to button (streamlit-extras)

import streamlit as st


# TODO add keyboard hint to button (streamlit-extras)
# https://arnaudmiribel.github.io/streamlit-extras/extras/keyboard_text/

def add_keyboard_shortcuts(key_combinations: dict[str, str]):