Add and enforce image size attributes for rendered images#7248
Merged
Conversation
changelog: Bug Fixes, Images, Improve image rendering to avoid page layout shifts
See: #7248 (comment) Co-Authored-By: Zach Margolis <zbmargolis@gmail.com>
aduth
force-pushed
the
aduth-add-enforce-image-size
branch
from
4f902e3 to
dfc7391
Compare
aduth
commented
Oct 28, 2022
Comment on lines
+64
to
+70
| Exclude: | ||
| - app/components/barcode_component.html.erb | ||
| - app/views/partials/multi_factor_authentication/_mfa_selection.html.erb | ||
| - app/views/shared/_nav_branded.html.erb | ||
| - app/views/sign_up/completions/show.html.erb | ||
| - app/views/users/two_factor_authentication_setup/index.html.erb | ||
| - app/views/users/webauthn_setup/new.html.erb |
Contributor
Author
There was a problem hiding this comment.
Noting that I'd hoped to have disabled these rules inline at the specific point in the file where the image_tag is called, but it doesn't currently appear to be possible to do with ERBLint.
Upstream issue: Shopify/erb_lint#243
Merged
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
2 participants
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.
🛠 Summary of changes
Adds a linter to enforce that any
image_tagincludes eitherwidthandheightor asizeattribute, so as to adhere to best practices to avoid layout shifts.Related resources:
Visually, there should be no effective difference with these changes. This was made somewhat challenging by how some images are scaled, since adding
widthorheightwhere it was previously not set could create issues where the image was scaled down due to constraints of its parent container. I've done a manual review to try to ensure no regressions in the display of images.📜 Testing Plan
make lint