chore: Update image API to remove maxWidth/maxHeight (#28985)

* in progress

* update tests

* remove maxHeight and maxWidth references

* add warning

* not sure how that was ever throwing tbh

* typo

* Update wording

* Fix types

* propTypes check

Co-authored-by: Matt Kane <matt@gatsbyjs.com>

Author: LB

e2e-tests/gatsby-static-image/src/pages/constrained.js

@@ -11,14 +11,14 @@ const ConstrainedPage = () => (
     <div data-testid="image-constrained-limit">
       <StaticImage
         src="../images/citrus-fruits.jpg"
-        maxWidth={500}
+        width={500}
         alt="Citrus fruits"
       />
     </div>
     <div data-testid="image-constrained-override">
       <StaticImage
         src="../images/citrus-fruits.jpg"
-        maxWidth={500}
+        width={500}
         sizes="100vw"
         alt="Citrus fruits"
       />

e2e-tests/gatsby-static-image/src/pages/fluid.js

@@ -9,7 +9,7 @@ const FluidPage = () => (
       <StaticImage
         src="../images/citrus-fruits.jpg"
         layout="fluid"
-        maxWidth={700}
+        width={700}
         alt="Citrus fruits"
       />
     </div>

e2e-tests/visual-regression/src/pages/images/avif.js

@@ -9,7 +9,7 @@ const Page = () => {
     query {
       file(relativePath: { eq: "cornwall.jpg" }) {
         childImageSharp {
-          gatsbyImageData(maxWidth: 1024, layout: CONSTRAINED, formats: [AVIF])
+          gatsbyImageData(width: 1024, layout: CONSTRAINED, formats: [AVIF])
         }
       }
     }

e2e-tests/visual-regression/src/pages/images/constrained.js

@@ -9,7 +9,7 @@ const Page = () => {
     query {
       file(relativePath: { eq: "cornwall.jpg" }) {
         childImageSharp {
-          gatsbyImageData(maxWidth: 1024, layout: CONSTRAINED)
+          gatsbyImageData(width: 1024, layout: CONSTRAINED)
         }
       }
     }

e2e-tests/visual-regression/src/pages/images/fluid.js

@@ -9,7 +9,7 @@ const Page = () => {
     query {
       file(relativePath: { eq: "cornwall.jpg" }) {
         childImageSharp {
-          gatsbyImageData(maxWidth: 1024, layout: FLUID)
+          gatsbyImageData(width: 1024, layout: FLUID)
         }
       }
     }

e2e-tests/visual-regression/src/pages/static-images/avif.js

@@ -12,7 +12,7 @@ const Page = () => {
           src="../../images/cornwall.jpg"
           alt="cornwall"
           formats={["avif"]}
-          maxWidth={1024}
+          width={1024}
         />
       </TestWrapper>
     </Layout>

e2e-tests/visual-regression/src/pages/static-images/constrained.js

@@ -11,7 +11,7 @@ const Page = () => {
         <StaticImage
           src="../../images/cornwall.jpg"
           alt="cornwall"
-          maxWidth={1024}
+          width={1024}
         />
       </TestWrapper>
     </Layout>

e2e-tests/visual-regression/src/pages/static-images/fluid.js

@@ -6,13 +6,13 @@ import Layout from "../../components/layout"
 const Page = () => {
   return (
     <Layout>
-      <h1>Fluid, maxWidth</h1>
+      <h1>Fluid, width</h1>
       <TestWrapper style={{ display: `block` }}>
         <StaticImage
           src="../../images/cornwall.jpg"
           loading="eager"
           layout="fluid"
-          maxWidth={1024}
+          width={1024}
           alt="cornwall"
         />
       </TestWrapper>

packages/gatsby-plugin-image/README.md

@@ -57,8 +57,8 @@ export const Dino = () => (
   <StaticImage
     src="trex.png"
     placeholder="none"
-    layout="fluid"
-    maxWidth={200}
+    layout="constrained"
+    width={200}
     alt="T-Rex"
     transformOptions={{ grayscale: true }}
   />
@@ -294,7 +294,7 @@ JSON type, meaning you don't specify the individual fields, but are instead give
 ```graphql
 coverImage: file(relativePath: { eq: "plant.jpg" }) {
   childImageSharp {
-    gatsbyImageData(maxWidth: 720, layout: FLUID, placeholder: TRACED_SVG)
+    gatsbyImageData(width: 720, layout: CONSTRAINED, placeholder: TRACED_SVG)
   }
 }
 ```
@@ -316,13 +316,8 @@ The optional helper function `getImage` takes a file node and returns `file?.chi
 
 These arguments can be passed to the `gatsbyImageData()` resolver:
 
-- **width**: The display width of the generated image. The actual largest image resolution will be this value multiplied by the largest value in outputPixelDensities. Ignored if layout = FLUID or CONSTRAINED, where you should use "maxWidth" instead.
+- **width**: The display width of the generated image for layout = FIXED, if layout = CONSTRAINED it's the display width of the largest generated image. The actual largest image resolution will be this value multiplied by the largest value in outputPixelDensities.
 - **height**: If set, the height of the generated image. If omitted, it is calculated from the supplied width, matching the aspect ratio of the source image.
-- **maxWidth**:
-  Maximum display width of generated files.
-  The actual largest image resolution will be this value multiplied by the largest value in outputPixelDensities
-  This only applies when layout = FLUID or CONSTRAINED. For other layout types, use "width"
-- **maxHeight**: If set, the generated image is a maximum of this height, cropping if necessary. If the image layout is "constrained" then the image will be limited to this height. If the aspect ratio of the image is different than the source, then the image will be cropped.`,
 - **placeholder**: Format of generated placeholder image.
   - `BLURRED`: (default) a blurred, low resolution image, encoded as a base64 data URI
   - `TRACED_SVG`: a low-resolution traced SVG of the image.
@@ -333,7 +328,7 @@ These arguments can be passed to the `gatsbyImageData()` resolver:
   - `FIXED`: A static image size, that does not resize according to the screen width
   - `FLUID`: The image resizes to fit its container. Pass a "sizes" option if it isn't going to be the full width of the screen.
 - **outputPixelDensities**: A list of image pixel densities to generate, for high-resolution (retina) screens. It will never generate images larger than the source, and will always include a 1x image.
-  Default is `[ 0.25, 0.5, 1, 2 ]`, for fluid/constrained images, and `[ 1, 2 ]` for fixed. In this case, an image with a fluid layout and maxWidth = 400 would generate images at 100, 200, 400 and 800px wide
+  Default is `[ 0.25, 0.5, 1, 2 ]`, for fluid/constrained images, and `[ 1, 2 ]` for fixed.
 - **sizes**: The "[sizes](https://developer.mozilla.org/en-US/docs/Learn/HTML/Multimedia_and_embedding/Responsive_images)" attribute, passed to the `<img>` tag. This describes the display size of the image. This does not affect the generated images, but is used by the browser to decide which images to download. You can leave this blank for fixed images, or if the responsive image container will be the full width of the screen. In these cases we will generate an appropriate value. If, however, you are generating responsive images that are not the full width of the screen, you should provide a sizes property for best performance. You can alternatively pass this value to the component.
 - **formats**: an array of file formats to generate. The default is `[AUTO, WEBP]`, which means it will generate images in the same format as the source image, as well as in the next-generation [WebP](https://developers.google.com/speed/webp) format. We strongly recommend you do not change this option, as doing so will affect performance scores.
 - **quality**: The default quality. This is overridden by any format-specific options

packages/gatsby-plugin-image/src/__tests__/image-utils.ts

@@ -37,13 +37,11 @@ const args: IGatsbyImageHelperArgs = {
 
 const fluidArgs: IGatsbyImageHelperArgs = {
   ...args,
-  width: undefined,
-  maxWidth: 400,
   layout: `fluid`,
 }
 
 const constrainedArgs: IGatsbyImageHelperArgs = {
-  ...fluidArgs,
+  ...args,
   layout: `constrained`,
 }