Allow configuring keyboard shortcuts on buttons #12975

lukasmasuch · 2025-11-08T02:03:43Z

Describe your changes

Adds support for configuring shortcuts/hotkeys to trigger buttons (st.button, st.download_button, st.link_button, st.form_submit_button)

Screenshot or video (only for visual changes)

GitHub Issue Link (if applicable)

Closes Keyboard shortcuts for buttons #1291

Testing Plan

Added unit and e2e tests.

Contribution License Agreement

By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.

snyk-io · 2025-11-08T02:03:51Z

✅ Snyk checks have passed. No issues have been found so far.

Status	Scanner	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues
✅	Licenses	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

github-actions · 2025-11-08T02:04:01Z

✅ PR preview is ready!

Name	Link
📦 Wheel file	https://core-previews.s3-us-west-2.amazonaws.com/pr-12975/streamlit-1.51.0-py3-none-any.whl
📦 `@streamlit/component-v2-lib`	Download from artifacts
🕹️ Preview app	pr-12975.streamlit.app (☁️ Deploy here if not accessible)

Copilot

Pull Request Overview

This PR adds keyboard shortcut support to button components in Streamlit, allowing users to trigger buttons using keyboard combinations like "Ctrl+K" or "Cmd+N". The implementation spans both the Python backend (shortcut normalization and validation) and the TypeScript frontend (shortcut registration and display).

Adds a shortcut parameter to st.button(), st.download_button(), st.link_button(), and st.form_submit_button()
Implements shortcut normalization in Python to ensure consistent formatting (lowercase, standardized modifier order)
Creates a new React hook (useRegisterShortcut) for keyboard event handling in the frontend
Displays shortcut hints as styled <kbd> elements on button labels

Reviewed Changes

Copilot reviewed 24 out of 24 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
proto/streamlit/proto/Button.proto	Adds `shortcut` field (11) to Button message
proto/streamlit/proto/DownloadButton.proto	Adds `shortcut` field (12) to DownloadButton message
proto/streamlit/proto/LinkButton.proto	Adds `id` field (1) and `shortcut` field (11) to LinkButton message
lib/streamlit/elements/widgets/button.py	Implements shortcut normalization, validation, and serialization for all button types
lib/streamlit/elements/form.py	Adds shortcut parameter to form submit button
lib/tests/streamlit/elements/button_test.py	Adds Python unit tests for shortcut normalization and reserved key validation
frontend/lib/src/hooks/useRegisterShortcut.ts	Implements keyboard shortcut registration hook with input field filtering
frontend/lib/src/hooks/useRegisterShortcut.test.tsx	Unit tests for the shortcut hook
frontend/lib/src/components/widgets/Button/Button.tsx	Integrates shortcut hook and display for regular buttons
frontend/lib/src/components/widgets/DownloadButton/DownloadButton.tsx	Integrates shortcut hook and display for download buttons
frontend/lib/src/components/elements/LinkButton/LinkButton.tsx	Integrates shortcut hook and display for link buttons
frontend/lib/src/components/elements/LinkButton/BaseLinkButton.tsx	Converts to forwardRef to support programmatic clicks via ref
frontend/lib/src/components/widgets/Form/FormSubmitButton.tsx	Integrates shortcut hook and display for form submit buttons
frontend/lib/src/components/shared/BaseButton/DynamicButtonLabel.tsx	Adds shortcut display logic and formatting
frontend/lib/src/components/shared/BaseButton/DynamicButtonLabel.test.tsx	Unit tests for shortcut display formatting
frontend/lib/src/components/shared/BaseButton/styled-components.ts	Adds styled components for shortcut badge display
e2e_playwright/st_button.py	Adds test button with shortcut
e2e_playwright/st_button_test.py	E2E tests for button shortcut display and activation
e2e_playwright/st_download_button.py	Adds test download button with shortcut
e2e_playwright/st_download_button_test.py	E2E tests for download button shortcut display and activation
e2e_playwright/st_link_button.py	Adds test link button with shortcut
e2e_playwright/st_link_button_test.py	E2E tests for link button shortcut display and activation
e2e_playwright/st_form.py	Adds test form submit button with shortcut
e2e_playwright/st_form_test.py	E2E tests for form submit button shortcut display and activation

frontend/lib/src/hooks/useRegisterShortcut.ts

frontend/lib/src/components/elements/LinkButton/LinkButton.tsx

frontend/lib/src/components/widgets/Button/Button.tsx

frontend/lib/src/components/widgets/DownloadButton/DownloadButton.tsx

frontend/lib/src/components/widgets/Form/FormSubmitButton.tsx

frontend/lib/src/hooks/useRegisterShortcut.ts

frontend/lib/src/components/elements/LinkButton/LinkButton.tsx

lib/streamlit/elements/widgets/button.py

proto/streamlit/proto/LinkButton.proto

github-actions · 2025-11-08T02:16:45Z

📉 Frontend coverage change detected

The frontend unit test (vitest) coverage has decreased by 0.0000%

Current PR: 86.1100% (51619 lines, 7167 missed)
Latest develop: 86.1100% (51260 lines, 7118 missed)

✅ Coverage change is within normal range.

📊 View detailed coverage comparison

jrieke · 2025-11-08T10:27:57Z

I removed the "Closes ..." from the GitHub issue since it is about keyboard shortcuts in general, not just for buttons. I think we should keep that issue open a bit longer.

lukasmasuch · 2025-11-08T10:34:32Z

I removed the "Closes ..." from the GitHub issue since it is about keyboard shortcuts in general, not just for buttons. I think we should keep that issue open a bit longer.

I would suggest to create a new issue after merging this PR instead to get a better insight on the actual interest in adding more generic hotkeys. Otherwise, we have the same issue as with #5370 where the interest is mixed between the already released header grouping vs the not yet released row spanning. I guess hotkeys on buttons will resolve the majority of use cases already.

Copilot

Pull request overview

Copilot reviewed 32 out of 50 changed files in this pull request and generated 1 comment.

frontend/lib/src/hooks/useRegisterShortcut.ts

sfc-gh-bnisco · 2025-11-24T17:12:29Z

proto/streamlit/proto/LinkButton.proto

+  // The ID is only needed if a shortcut is provided.
+  string id = 1;


question: Can you confirm that 1 has never been used in this proto message before? If it has, then this is not a safe change.

Yep, it was never used based on the proto history.

…-shortcuts-on-buttons

frontend/lib/src/hooks/useRegisterShortcut.ts

e2e_playwright/st_link_button_test.py

lukasmasuch added 2 commits November 7, 2025 17:50

Implement custom shortcuts for buttons

2eacb08

Fix e2e test

1e630fa

lukasmasuch requested a review from Copilot November 8, 2025 02:05

Copilot AI reviewed Nov 8, 2025

View reviewed changes

lukasmasuch added 5 commits November 7, 2025 18:25

Update tests

255017a

Update

a5c0f89

Update

ce0d3e4

Update

2e9623a

Fix test

2dfbebe

lukasmasuch added the security-assessment-completed Security assessment has been completed for PR label Nov 8, 2025

lukasmasuch changed the title ~~Feature/keyboard shortcuts on buttons~~ Allow configuring keyboard shortcuts on buttons Nov 8, 2025

lukasmasuch added change:feature PR contains new feature or enhancement implementation impact:users PR changes affect end users labels Nov 8, 2025

lukasmasuch added 12 commits November 7, 2025 19:13

Update snapshots

f6c777c

Fix alignment

0e803a5

update tests

d771544

Update snapshots

41a0373

Update snapshots

29f1769

Update snapshots

fe9b6d3

Update e2e tests

f5250d7

Update

1aaa7fb

Improve tests

30a4757

Update

719fae7

Fix link button

685152e

Fix

2dda647

lukasmasuch requested a review from Copilot November 24, 2025 14:15

Copilot started reviewing on behalf of lukasmasuch November 24, 2025 14:15 View session

Copilot finished reviewing on behalf of lukasmasuch November 24, 2025 14:16

Copilot AI reviewed Nov 24, 2025

View reviewed changes

frontend/lib/src/hooks/useRegisterShortcut.ts Show resolved Hide resolved

lukasmasuch and others added 7 commits November 24, 2025 15:27

Stabalize link button e2e test

03a22fa

Update link button test

76ec62b

Update

83d8dd1

Update

155f67e

Update snapshots

13f241a

Merge branch 'develop' into feature/keyboard-shortcuts-on-buttons

82db33e

Add timeout

ff115ad

sfc-gh-bnisco reviewed Nov 24, 2025

View reviewed changes

sfc-gh-bnisco approved these changes Nov 24, 2025

View reviewed changes

lukasmasuch added 3 commits November 24, 2025 19:09

Update docstring

f992770

Update

dbb0cf1

Merge remote-tracking branch 'upstream/develop' into feature/keyboard…

8ff8d3e

…-shortcuts-on-buttons

lukasmasuch enabled auto-merge (squash) November 24, 2025 18:11

lukasmasuch disabled auto-merge November 24, 2025 18:11

lukasmasuch added the flaky-verify If applied to PR will run flaky test verification workflow label Nov 24, 2025

graphite-app bot reviewed Nov 24, 2025

View reviewed changes

frontend/lib/src/hooks/useRegisterShortcut.ts Show resolved Hide resolved

Try to address flakiness

dc88be2

sfc-gh-lmasuch removed the flaky-verify If applied to PR will run flaky test verification workflow label Nov 24, 2025

graphite-app bot reviewed Nov 24, 2025

View reviewed changes

e2e_playwright/st_link_button_test.py Show resolved Hide resolved

Update snapshots

2d182ab

sfc-gh-lmasuch added the flaky-verify If applied to PR will run flaky test verification workflow label Nov 24, 2025

Only run on webkit

aaadf08

sfc-gh-lmasuch removed the flaky-verify If applied to PR will run flaky test verification workflow label Nov 24, 2025

lukasmasuch merged commit 03bbb3b into develop Nov 24, 2025
44 of 45 checks passed

lukasmasuch deleted the feature/keyboard-shortcuts-on-buttons branch November 24, 2025 19:40

lukasmasuch mentioned this pull request Nov 24, 2025

Page- and app-level keyboard shortcuts #13112

Open

2 tasks

		// The ID is only needed if a shortcut is provided.
		string id = 1;

Allow configuring keyboard shortcuts on buttons #12975

Allow configuring keyboard shortcuts on buttons #12975

Uh oh!

Conversation

lukasmasuch commented Nov 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Describe your changes

Screenshot or video (only for visual changes)

GitHub Issue Link (if applicable)

Testing Plan

Uh oh!

snyk-io bot commented Nov 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Snyk checks have passed. No issues have been found so far.

Uh oh!

github-actions bot commented Nov 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ PR preview is ready!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Nov 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📉 Frontend coverage change detected

Uh oh!

jrieke commented Nov 8, 2025

Uh oh!

lukasmasuch commented Nov 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

sfc-gh-bnisco Nov 24, 2025

Choose a reason for hiding this comment

Uh oh!

lukasmasuch Nov 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

lukasmasuch commented Nov 8, 2025 •

edited

Loading

snyk-io bot commented Nov 8, 2025 •

edited

Loading

github-actions bot commented Nov 8, 2025 •

edited

Loading

github-actions bot commented Nov 8, 2025 •

edited

Loading

lukasmasuch commented Nov 8, 2025 •

edited

Loading