[AdvancedLayouts] Updates to st.image width/height and adding width/height to st.pyplot. #11952
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
🎉 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!
|
00359f5 to
4a5f1c6
Compare
c553530 to
eaf8ea0
Compare
Contributor
📈 Frontend coverage change detectedThe frontend unit test (vitest) coverage has increased by 0.0300%
🎉 Great job on improving test coverage! |
Contributor
📈 Python coverage change detectedThe Python unit test coverage has increased by 0.0243%
✅ Coverage change is within normal range. Coverage by files
|
45c0a47 to
8886561
Compare
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the image width system for st.image and st.pyplot as part of the AdvancedLayouts project. It introduces a new unified width configuration system that replaces the legacy WidthBehavior enum-based approach while maintaining backward compatibility. The main goal is to deprecate use_container_width in favor of a more flexible width parameter.
Key Changes:
- Introduces new
widthparameter for both st.image and st.pyplot supporting "content", "stretch", and pixel values - Begins deprecation of
use_container_widthwith warning messages and fallback behavior - Updates both backend and frontend to use new LayoutConfig system instead of legacy width behavior
Reviewed Changes
Copilot reviewed 17 out of 40 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| proto/streamlit/proto/Image.proto | Marks legacy width field as deprecated |
| lib/streamlit/elements/image.py | Adds new width parameter and deprecation handling for use_container_width |
| lib/streamlit/elements/pyplot.py | Adds width parameter to st.pyplot with deprecation logic |
| lib/streamlit/elements/lib/image_utils.py | Updates image processing to use LayoutConfig instead of WidthBehavior |
| frontend/lib/src/components/elements/ImageList/ImageList.tsx | Implements new width configuration system with legacy fallback |
| e2e_playwright/st_image.py | Adds test cases for new width parameter |
| e2e_playwright/st_pyplot.py | Adds test cases for new width parameter |
lib/streamlit/elements/pyplot.py
Outdated
| ) | ||
|
|
||
| if width == "stretch": | ||
| width = "stretch" if use_container_width else "content" |
There was a problem hiding this comment.
The condition if width == "stretch": will always be true since width defaults to "stretch" when use_container_width is not None. This means the deprecation logic will override the width parameter regardless of the use_container_width value. The condition should check the use_container_width value instead.
Suggested change
| width = "stretch" if use_container_width else "content" | |
| width = "stretch" if use_container_width else "content" |
Collaborator
Author
There was a problem hiding this comment.
I think this logic is actually wrong. We should override the width with use_container_width.
Although this description from copilot is not correct.
Co-authored-by: Bob Nisco <[email protected]>
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
This PR is part of the [AdvancedLayouts] project and updates
widthonst.imageto use the new width style and addswidthtost.pyplot.This PR also begins the process of deprecating use_container_width. The default is updated to None, and width will be used instead. If the user explicitly passes a value for use_container_width then that will take precedence. use_container_width=True is equivalent to width="stretch" and use_container_width=False is equivalent to width="content". The user will be given a warning and suggestion to use width instead. We will remove use_container_width after 12-31-2025`.
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.