Skip to content

Commit d467372

Browse files
LekoArtsLekoArts
authored
chore(gatsby-plugin-sharp): Remove sizeByPixelDensity option (#33468)
1 parent 87bd10a commit d467372

File tree

8 files changed

+11
-45
lines changed

8 files changed

+11
-45
lines changed

‎packages/gatsby-plugin-sharp/README.md

-2
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,6 @@ for more details.
132132
- `webpQuality` (int)
133133
- `srcSetBreakpoints` (array of int, default: [])
134134
- `background` (string, default: 'rgba(0,0,0,1)')
135-
- [deprecated] `sizeByPixelDensity` (bool, default: false)
136-
- Pixel density is only used in vector images, which Gatsby’s implementation of Sharp doesn’t support. This option is currently a no-op and will be removed in the next major version of Gatsby.
137135

138136
#### Returns
139137

‎packages/gatsby-plugin-sharp/src/index.js

-17
Original file line numberDiff line numberDiff line change
@@ -432,24 +432,7 @@ async function stats({ file, reporter }) {
432432

433433
async function fluid({ file, args = {}, reporter, cache }) {
434434
const options = healOptions(getPluginOptions(), args, file.extension)
435-
if (options.sizeByPixelDensity) {
436-
/*
437-
* We learned that `sizeByPixelDensity` is only valid for vector images,
438-
* and Gatsby’s implementation of Sharp doesn’t support vector images.
439-
* This means we should remove this option in the next major version of
440-
* Gatsby, but for now we can no-op and warn.
441-
*
442-
* See https://github.com/gatsbyjs/gatsby/issues/12743
443-
*
444-
* TODO: remove the sizeByPixelDensity option in the next breaking release
445-
*/
446-
reporter.warn(
447-
`the option sizeByPixelDensity is deprecated and should not be used. It will be removed in the next major release of Gatsby.`
448-
)
449-
}
450435

451-
// Account for images with a high pixel density. We assume that these types of
452-
// images are intended to be displayed at their native resolution.
453436
let metadata
454437
try {
455438
const pipeline = sharp()

‎packages/gatsby-plugin-sharp/src/plugin-options.js

-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ const generalArgs = {
2626
pathPrefix: ``,
2727
toFormat: ``,
2828
toFormatBase64: ``,
29-
sizeByPixelDensity: false,
3029
rotate: 0,
3130
}
3231

‎packages/gatsby-remark-images-contentful/README.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -44,16 +44,15 @@ plugins: [
4444

4545
## Options
4646

47-
| Name | Default | Description |
48-
| ---------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
49-
| `maxWidth` | `650` | The `maxWidth` in pixels of the `div` where the markdown will be displayed. This value is used when deciding what the width of the various responsive thumbnails should be. |
50-
| `linkImagesToOriginal` | `true` | Add a link to each image to the original image. Sometimes people want to see a full-sized version of an image e.g. to see extra detail on a part of the image and this is a convenient and common pattern for enabling this. Set this option to false to disable this behavior. |
51-
| `showCaptions` | `false` | Add a caption to each image with the contents of the title attribute, when this is not empty. Set this option to true to enable this behavior. |
52-
| `sizeByPixelDensity` | `false` | Analyze images' pixel density to make decisions about target image size. This is what GitHub is doing when embedding images in tickets. This is a useful setting for documentation pages with a lot of screenshots. It can have unintended side effects on high-pixel density artworks.<br /><br />Example: A screenshot made on a retina screen with a resolution of 144 (e.g. Macbook) and a width of 100px, will be rendered at 50px. |
53-
| `wrapperStyle` | | Add custom styles to the div wrapping the responsive images. Use regular CSS syntax, e.g. `margin-bottom:10px; background: red;` |
54-
| `backgroundColor` | `white` | Set the background color of the image to match the background of your design |
55-
| `withWebp` | `false` | Additionally generate WebP versions alongside your chosen file format. They are added as a srcset with the appropriate mimetype and will be loaded in browsers that support the format. |
56-
| `loading` | `lazy` | Set the browser's native lazy loading attribute. One of `lazy`, `eager` or `auto`. |
47+
| Name | Default | Description |
48+
| ---------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
49+
| `maxWidth` | `650` | The `maxWidth` in pixels of the `div` where the markdown will be displayed. This value is used when deciding what the width of the various responsive thumbnails should be. |
50+
| `linkImagesToOriginal` | `true` | Add a link to each image to the original image. Sometimes people want to see a full-sized version of an image e.g. to see extra detail on a part of the image and this is a convenient and common pattern for enabling this. Set this option to false to disable this behavior. |
51+
| `showCaptions` | `false` | Add a caption to each image with the contents of the title attribute, when this is not empty. Set this option to true to enable this behavior. |
52+
| `wrapperStyle` | | Add custom styles to the div wrapping the responsive images. Use regular CSS syntax, e.g. `margin-bottom:10px; background: red;` |
53+
| `backgroundColor` | `white` | Set the background color of the image to match the background of your design |
54+
| `withWebp` | `false` | Additionally generate WebP versions alongside your chosen file format. They are added as a srcset with the appropriate mimetype and will be loaded in browsers that support the format. |
55+
| `loading` | `lazy` | Set the browser's native lazy loading attribute. One of `lazy`, `eager` or `auto`. |
5756

5857
## Troubleshooting
5958

‎packages/gatsby-remark-images-contentful/src/utils/index.js

+2-6
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,10 @@ const buildResponsiveSizes = async (
3030
)
3131

3232
const { width, height, density } = metadata
33-
const { sizeByPixelDensity, maxWidth, sizes } = options
33+
const { maxWidth, sizes } = options
3434
const aspectRatio = width / height
35-
const pixelRatio =
36-
sizeByPixelDensity && typeof density === `number` && density > 0
37-
? density / 72
38-
: 1
3935

40-
const presentationWidth = Math.min(maxWidth, Math.round(width / pixelRatio))
36+
const presentationWidth = Math.min(maxWidth, width)
4137
const presentationHeight = Math.round(presentationWidth * (height / width))
4238
const sizesQuery =
4339
sizes || `(max-width: ${presentationWidth}px) 100vw, ${presentationWidth}px`

‎packages/gatsby-remark-images/README.md

-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,6 @@ a reserved keyword `GATSBY_EMPTY_ALT` can be used.
6565
| `linkImagesToOriginal` | `true` | Add a link to each image to the original image. Sometimes people want to see a full-sized version of an image e.g. to see extra detail on a part of the image and this is a convenient and common pattern for enabling this. Set this option to `false` to disable this behavior. |
6666
| `showCaptions` | `false` | Add a caption to each image with the contents of the title attribute, when this is not empty. If the title attribute is empty but the alt attribute is not, it will be used instead. Set this option to true to enable this behavior. You can also pass an array instead to specify which value should be used for the caption — for example, passing `['alt', 'title']` would use the alt attribute first, and then the title. When this is set to `true` it is the same as passing `['title', 'alt']`. If you just want to use the title (and omit captions for images that have alt attributes but no title), pass `['title']`. |
6767
| `markdownCaptions` | `false` | Parse the caption as markdown instead of raw text. Ignored if `showCaptions` is `false`. |
68-
| `sizeByPixelDensity` | `false` | [deprecated] Pixel density is only used in vector images, which Gatsby’s implementation of Sharp doesn’t support. This option is currently a no-op and will be removed in the next major version of Gatsby. |
6968
| `wrapperStyle` | | Add custom styles to the div wrapping the responsive images. Use the syntax for the style attribute e.g. `margin-bottom:10px; background: red;` or a function returning a style string which receives the information about the image you can use to dynamically set styles based on the `aspectRatio` for example. |
7069
| `backgroundColor` | `white` | Set the background color of the image to match the background image of your design.<br /><br />**Note:**<br />- set this option to `transparent` for a transparent image background.<br /> - set this option to `none` to completely remove the image background. |
7170
| `quality` | `50` | The quality level of the generated files. |

‎packages/gatsby-remark-images/src/__tests__/gatsby-node.js

-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ describe(`pluginOptionsSchema`, () => {
99
`"linkImagesToOriginal" must be a boolean`,
1010
`"showCaptions" must be one of [boolean, array]`,
1111
`"markdownCaptions" must be a boolean`,
12-
`"sizeByPixelDensity" must be a boolean`,
1312
`"wrapperStyle" must be one of [object, string]`,
1413
`"backgroundColor" must be a string`,
1514
`"quality" must be a number`,
@@ -27,7 +26,6 @@ describe(`pluginOptionsSchema`, () => {
2726
linkImagesToOriginal: `This should be a boolean`,
2827
showCaptions: `This should be a boolean`,
2928
markdownCaptions: `This should be a boolean`,
30-
sizeByPixelDensity: `This should be a boolean`,
3129
wrapperStyle: true,
3230
backgroundColor: 123,
3331
quality: `This should be a number`,
@@ -49,7 +47,6 @@ describe(`pluginOptionsSchema`, () => {
4947
linkImagesToOriginal: false,
5048
showCaptions: true,
5149
markdownCaptions: true,
52-
sizeByPixelDensity: true,
5350
wrapperStyle: { marginTop: `1rem`, padding: `1.5rem`, color: `blue` },
5451
backgroundColor: `red`,
5552
quality: 77,

‎packages/gatsby-remark-images/src/gatsby-node.js

-5
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,6 @@ exports.pluginOptionsSchema = function ({ Joi }) {
2929
.description(
3030
`Parse the caption as markdown instead of raw text. Ignored if showCaptions is false.`
3131
),
32-
sizeByPixelDensity: Joi.boolean()
33-
.default(false)
34-
.description(
35-
`[deprecated] Pixel density is only used in vector images, which Gatsby’s implementation of Sharp doesn’t support. This option is currently a no-op and will be removed in the next major version of Gatsby.`
36-
),
3732
wrapperStyle: Joi.alternatives().try(
3833
Joi.object({}).unknown(true),
3934
Joi.function().maxArity(1),

0 commit comments

Comments
 (0)