Use key as main identity for st.feedback and st.pills widgets#12717
Merged
lukasmasuch merged 22 commits intodevelopfrom Oct 15, 2025
Merged
Use key as main identity for st.feedback and st.pills widgets#12717lukasmasuch merged 22 commits intodevelopfrom
key as main identity for st.feedback and st.pills widgets#12717lukasmasuch merged 22 commits intodevelopfrom
Conversation
Contributor
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Contributor
✅ PR preview is ready!
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the identity mechanism for st.feedback and st.pills widgets to use the key parameter as the main identity, similar to how st.segmented_control already works. This allows these widgets to maintain their state when other non-whitelisted parameters change, while still generating new IDs when whitelisted parameters (like options or click_mode) change.
- Extended key-based identity behavior from segmented_control to feedback and pills widgets
- Added comprehensive test coverage for the new identity behavior
- Added E2E tests to verify dynamic property updates preserve widget state
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| lib/streamlit/elements/widgets/button_group.py | Updated to use key as main identity for all button group widgets (feedback, pills, segmented_control) |
| lib/tests/streamlit/elements/button_group_test.py | Added unit tests for stable ID behavior with key for feedback and pills widgets |
| e2e_playwright/st_feedback.py | Added E2E test app with dynamic feedback widget to test state preservation |
| e2e_playwright/st_feedback_test.py | Added E2E test to verify feedback widget state is preserved during prop updates |
| e2e_playwright/st_pills.py | Added E2E test app with dynamic pills widget to test state preservation |
| e2e_playwright/st_pills_test.py | Added E2E test to verify pills widget state is preserved during prop updates |
lukasmasuch
added
security-assessment-completed
change:feature
Base automatically changed from
stable-key-identity-for-segmented-control
to
develop
October 8, 2025 16:42
mayagbarnes
approved these changes
Oct 15, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Describe your changes
If a custom
keyis passed to ast.pillsorst.feedbackwidget it will be used as the main identity. This allows for dynamically changing other parameters in between reruns without causing the widgets to be recreated in the frontend.GitHub Issue Link (if applicable)
Testing Plan
Contribution License Agreement
By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.