Extend disclaimer for dynamic image imports (vercel#26241)

* docs: extend disclaimer for dynamic image imports * docs: extend guidance on blurDataURL * Update docs/api-reference/next/image.md Co-authored-by: Steven <steven@ceriously.com> Co-authored-by: Tim Neutkens <tim@timneutkens.nl>
blitz-js · Jun 18, 2021 · 4e75cda · 4e75cda
1 parent 81f99a9
commit 4e75cda
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/docs/api-reference/next/image.md b/docs/api-reference/next/image.md
@@ -167,7 +167,9 @@ Should only be used when the image is visible above the fold. Defaults to
 
 A placeholder to use while the image is loading, possible values are `blur` or `empty`. Defaults to `empty`.
 
-When `blur`, the [`blurDataURL`](#blurdataurl) property will be used as the placeholder. If `src` is an object from a static import and the imported image is jpg, png, or webp, then `blurDataURL` will automatically be populated. Otherwise you must provide the [`blurDataURL`](#blurdataurl) property.
+When `blur`, the [`blurDataURL`](#blurdataurl) property will be used as the placeholder. If `src` is an object from a static import and the imported image is jpg, png, or webp, then `blurDataURL` will automatically be populated.
+
+For dynamic images, you must provide the [`blurDataURL`](#blurdataurl) property. Solutions such as [Plaiceholder](https://github.com/joe-bell/plaiceholder) can help with `base64` generation.
 
 When `empty`, there will be no placeholder while the image is loading, only empty space.
 

diff --git a/docs/basic-features/image-optimization.md b/docs/basic-features/image-optimization.md
@@ -79,7 +79,7 @@ function Home() {
 }
 ```
 
-For dynamic images you have to provide `width`, `height` and `blurDataURL` manually.
+For dynamic or remote images, you'll have to provide [`width`](/docs/api-reference/next/image#width), [`height`](/docs/api-reference/next/image#height) and [`blurDataURL`](/docs/api-reference/next/image#blurdataurl) manually.
 
 ## Properties
-Original file line number
+Diff line change
@@ Expand Up / @@ -79,7 +79,7 @@ function Home() { @@
     }
     ```
-    For dynamic images you have to provide `width`, `height` and `blurDataURL` manually.
+    For dynamic or remote images, you'll have to provide [`width`](/docs/api-reference/next/image#width), [`height`](/docs/api-reference/next/image#height) and [`blurDataURL`](/docs/api-reference/next/image#blurdataurl) manually.
     ## Properties
@@ Expand Down @@