docs(gatsby-plugin-image): Update API in readme #28134
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
gatsbot
bot
added
the
status: triage needed
laurieontech
added
status: needs docs review
| @@ -226,11 +226,12 @@ export const query = graphql` | |||
|
|
|||
| ### Upgrading from the gatsby-image@2 | |||
|
|
|||
| You can use the compat layer to make the transformation easier. | |||
| We will be releasing a codemod to automatically update your queries and imports. In the meantime you can use the compat layer to make the transformation easier. This will be removed when we leave beta, but for now it allows you to try the component with your existing queries. | |||
There was a problem hiding this comment.
Suggested change
| We will be releasing a codemod to automatically update your queries and imports. In the meantime you can use the compat layer to make the transformation easier. This will be removed when we leave beta, but for now it allows you to try the component with your existing queries. | |
| We will be releasing a codemod to automatically update your queries and imports. In the meantime, you can use the compat layer to make the transformation easier. This will be removed when we leave beta, but for now, it allows you to try the component with your existing queries. |
| - **outputPixelDensities**: | ||
| A list of image pixel densities to generate. It will never generate images larger than the source, and will always include a 1x image. | ||
| Default is [ 1, 2 ] for fixed images, meaning 1x, 2x, 3x, and [0.25, 0.5, 1, 2] for fluid. In this case, an image with a fluid layout and width = 400 would generate images at 100, 200, 400 and 800px wide`, | ||
| - **sizes**: |
There was a problem hiding this comment.
Sizes is listed twice.
| - **blurredOptions**: Options for the low-resolution placeholder image. Set placeholder to "BLURRED" to use this | ||
| - width | ||
| - toFormat | ||
| - **tracedSVGOptions**: Options for traced placeholder SVGs. You also should set placeholder to "SVG". |
There was a problem hiding this comment.
Worth noting that these options used to be called X in some migration section below?
ascorbic
force-pushed
the
docs/images-readme
branch
from
49551b8 to
0061105
Compare
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.
Updates the APIs in the gatsby-plugin-image readme