Use key as main identity for st.checkbox & st.toggle #12372
Merged
Conversation
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
Contributor
✅ PR preview is ready!
|
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) |
lukasmasuch added security-assessment-completed Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR modifies the identity computation for st.checkbox and st.toggle widgets to use the custom key parameter as the main identity when provided. This change allows dynamic parameter updates between reruns without widget recreation in the frontend, improving user experience by maintaining widget state when other properties change.
Key changes:
- Sets
key_as_main_identity=Truefor checkbox and toggle widgets when computing element IDs - Adds comprehensive unit tests to verify stable widget IDs with dynamic parameters
- Implements E2E tests demonstrating dynamic property updates while preserving widget state
Reviewed Changes
Copilot reviewed 6 out of 18 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
lib/streamlit/elements/widgets/checkbox.py | Changes identity computation to use key as main identity |
lib/tests/streamlit/elements/checkbox_test.py | Adds unit tests for stable ID behavior with key parameter |
e2e_playwright/st_checkbox.py | Adds dynamic checkbox test scenario with property updates |
e2e_playwright/st_checkbox_test.py | Implements E2E tests for dynamic checkbox behavior |
e2e_playwright/st_toggle.py | Adds dynamic toggle test scenario with property updates |
e2e_playwright/st_toggle_test.py | Implements E2E tests for dynamic toggle behavior |
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
lukasmasuch changed the title key as main identity for checkbox & togglekey as main identity for st.checkbox & st.toggle 
sfc-gh-lmasuch added the change:breaking 
Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>
sfc-gh-bnisco approved these changes Sep 2, 2025
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 any of thest.checkbox/st.togglewidgets 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.