refactor: createThumbnailFromPath takes size not maxSize
#37362
Merged
Conversation
This file contains 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
codebytere
added
semver/patch
codebytere
changed the title
createThumbnailFromPath maximum size enforcementcreateThumbnailFromPath should allow size smaller than maxSize
codebytere
changed the title
createThumbnailFromPath should allow size smaller than maxSizecreateThumbnailFromPath maxSize enforcement
codebytere
force-pushed
the
fix-thumbnail-max-size
branch
from
07c6d7b
to
8fc3ded
Compare
zcbenz
reviewed
Feb 23, 2023
ckerr
reviewed
Feb 23, 2023
There was a problem hiding this comment.
This maxSize option doesn't make sense. We should replace it with size in a breaking change.
The native APIs for both Windows and macOS take a size param -- not maxSize.
More importantly, neither has API to tell us the preferred of a thumbnail so that we can clamp it. And it makes sense for that API to be missing, because what would the preferred size of a text file thumbnail even mean?
Life will be easier for both us and our users if our API exposes fields that map directly to native API.
History: maxSize was included in the feature rollout @ #24802
codebytere
changed the title
createThumbnailFromPath maxSize enforcement
codebytere
force-pushed
the
fix-thumbnail-max-size
branch
from
8fc3ded
to
27098e1
Compare
codebytere
force-pushed
the
fix-thumbnail-max-size
branch
from
27098e1
to
aa135a1
Compare
codebytere
added
semver/major
|
@ckerr updated to make this a breaking change! |
codebytere
changed the title
createThumbnailFromPath takes size not maxSize
codebytere
force-pushed
the
fix-thumbnail-max-size
branch
from
aa135a1
to
8869aa9
Compare
codebytere
force-pushed
the
fix-thumbnail-max-size
branch
from
8869aa9
to
8427281
Compare
codebytere
force-pushed
the
fix-thumbnail-max-size
branch
from
8427281
to
2cb262e
Compare
electron-cation
bot
added
api-review/approved ✅
and removed
api-review/requested 🗳
labels
jkleinsc
approved these changes
Mar 9, 2023
|
Release Notes Persisted
|
|
I was unable to backport this PR to "24-x-y" cleanly; |
trop
bot
added
needs-manual-bp/24-x-y
and removed
target/24-x-y
VerteDinde
added a commit
that referenced
this pull request
Apr 2, 2023
|
@VerteDinde has manually backported this PR to "24-x-y", please check out #37796 |
trop
bot
added
in-flight/24-x-y
merged/24-x-y
codebytere
pushed a commit
that referenced
this pull request
Apr 3, 2023
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.
Description of Change
Closes #37340.
The
maxSizeparameter has been changed tosizeto reflect that the size passed in will be the size the thumbnail created. Previously, Windows would not scale the image up if it were smaller thanmaxSize, andmacOS would always set the size to
maxSize. Behavior is now the same across platforms.Checklist
npm testpassesRelease Notes
Notes:
nativeImage.createThumbnailFromPath()now takessizeinstead ofmaxSize.