Use key as main identity for st.text_area & st.text_input#12397
Merged
lukasmasuch merged 10 commits intodevelopfrom Sep 8, 2025
Merged
Use key as main identity for st.text_area & st.text_input#12397lukasmasuch merged 10 commits intodevelopfrom
key as main identity for st.text_area & st.text_input#12397lukasmasuch merged 10 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!
|
sfc-gh-lmasuch
added
security-assessment-completed
change:feature
sfc-gh-lmasuch
changed the title
key as main identity for st.text_area & st.text_inputkey as main identity for st.text_area & st.text_input
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR modifies st.text_input and st.text_area widgets to use custom keys as their main identity when provided, allowing dynamic parameter changes without widget recreation in the frontend. This addresses user requests for better widget state persistence when other properties change between reruns.
Key changes:
- Updated widget identity logic to use key-based identification with
max_charsas a special parameter - Added comprehensive unit tests to verify stable widget IDs across parameter changes
- Implemented E2E tests demonstrating dynamic property updates while preserving widget state
Reviewed Changes
Copilot reviewed 7 out of 19 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
lib/streamlit/elements/widgets/text_widgets.py |
Changed key_as_main_identity from False to {"max_chars"} for both text widgets |
lib/tests/streamlit/elements/text_input_test.py |
Added unit test verifying stable widget ID when key is provided |
lib/tests/streamlit/elements/text_area_test.py |
Added unit test verifying stable widget ID when key is provided |
e2e_playwright/st_text_input.py |
Added dynamic text input example with property switching |
e2e_playwright/st_text_input_test.py |
Added E2E test for dynamic property updates with state persistence |
e2e_playwright/st_text_area.py |
Added dynamic text area example with property switching |
e2e_playwright/st_text_area_test.py |
Added E2E test for dynamic property updates with state persistence |
sfc-gh-lmasuch
added
the
change:breaking
sfc-gh-bnisco
approved these changes
Sep 5, 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 any of thest.text_inputorst.text_areawidgets 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.