Use key as main identity for st.segmented_control widget#12711
Merged
lukasmasuch merged 8 commits intodevelopfrom Oct 8, 2025
Merged
Use key as main identity for st.segmented_control widget#12711lukasmasuch merged 8 commits intodevelopfrom
key as main identity for st.segmented_control widget#12711lukasmasuch merged 8 commits intodevelopfrom
Conversation
Contributor
🎉 Snyk checks have passed. No issues have been found so far.✅ security/snyk check is complete. No issues have been found. (View Details) ✅ license/snyk check is complete. No issues have been found. (View Details) |
Contributor
✅ PR preview is ready!
|
lukasmasuch
added
security-assessment-completed
change:feature
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR modifies the st.segmented_control widget to use a custom key as the main identity when provided, allowing dynamic changes to other parameters between reruns without causing the widget to be recreated in the frontend.
Key changes:
- Updated the button group implementation to use
key_as_main_identityfor segmented controls - Added comprehensive unit tests to verify stable widget IDs with keys
- Added E2E tests to demonstrate dynamic property updates while preserving state
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| lib/streamlit/elements/widgets/button_group.py | Modified segmented control to use key as main identity with whitelisted kwargs |
| lib/tests/streamlit/elements/button_group_test.py | Added unit tests for stable ID behavior and whitelisted kwargs validation |
| e2e_playwright/st_segmented_control.py | Added test app with dynamic segmented control property updates |
| e2e_playwright/st_segmented_control_test.py | Added E2E test to verify dynamic property changes preserve widget state |
sfc-gh-bnisco
approved these changes
Oct 8, 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 thest.segmented_controlwidget 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.