Update docs on static image imports #26211
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
timneutkens
requested review from
divmain,
ijjk,
leerob,
lfades and
shuding
as code owners
ijjk
previously approved these changes
Jun 16, 2021
lachlanjc
reviewed
Jun 16, 2021
Co-authored-by: Lachlan Campbell <lachlanjc@hey.com>
shuding
approved these changes
Jun 16, 2021
styfle
reviewed
Jun 16, 2021
styfle
reviewed
Jun 16, 2021
|
|
||
| You can `import` images that live in your project. (Note that `require` is not supported—only `import`.) | ||
|
|
||
| With direct `import`s, `width`, `height`, and `blurDataURL` will be automatically provided to the image component. Alt text is still needed separately. |
There was a problem hiding this comment.
Let's call it "static imports" instead of "direct imports" (I don't think we use direct anywhere else)
There was a problem hiding this comment.
Good flag!
Suggested change
| With direct `import`s, `width`, `height`, and `blurDataURL` will be automatically provided to the image component. Alt text is still needed separately. | |
| With static `import`s, `width`, `height`, and `blurDataURL` will be automatically provided to the image component. Alt text is still needed separately. |
styfle
reviewed
Jun 16, 2021
| } | ||
| ``` | ||
|
|
||
| For dynamic images you have to provide `width`, `height` and `blurDataURL` manually. |
There was a problem hiding this comment.
This could be more clear if you define "dynamic image" which really means "src is a string"
There was a problem hiding this comment.
Suggested change
| For dynamic images you have to provide `width`, `height` and `blurDataURL` manually. | |
| For images where you’re passing a URL to `src`, you have to provide `width`, `height` and `blurDataURL` manually. |
flybayer
pushed a commit
to blitz-js/next.js
that referenced
this pull request
Jun 24, 2021
Incorporates some of the feedback we've had about this doc. ## Bug - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added ## Feature - [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Documentation added - [ ] Telemetry added. In case of a feature if it's used or not. ## Documentation / Examples - [ ] Make sure the linting passes
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Incorporates some of the feedback we've had about this doc.
Bug
fixes #numberFeature
fixes #numberDocumentation / Examples