History

Steven 66834d5c15 Fix `image-component` example types (#40352 )		2022-09-08 11:09:46 -04:00
..
components	[Docs] Migrate image-component example to typescript (#40204 )	2022-09-05 09:28:23 -07:00
pages	Fix `image-component` example types (#40352 )	2022-09-08 11:09:46 -04:00
public	Add image example with background color using blurDataURL (#30111 )	2021-10-20 19:05:54 +00:00
.gitignore	Update default gitignore templates (#39051 )	2022-07-26 20:08:40 -05:00
app.css	Update Image docs with links to examples (#18770 )	2020-11-04 17:24:14 +00:00
next.config.js	[Docs] Add config types to all examples (#40083 )	2022-08-31 16:41:22 -05:00
package.json	[Docs] Migrate image-component example to typescript (#40204 )	2022-09-05 09:28:23 -07:00
README.md	Update `pnpm create next-app` for latest pnpm 6 and 7 (#37254 )	2022-05-27 21:21:40 +00:00
styles.module.css	Add props `objectFit` and `objectPosition` to Image component (#18849 )	2020-11-05 19:42:55 +00:00
tsconfig.json	[Docs] Migrate image-component example to typescript (#40204 )	2022-09-05 09:28:23 -07:00

README.md

Image Component Example

This example shows how to use the Image Component in Next.js serve optimized, responsive images.

The index page (pages/index.js) has a couple images, one internal image and one external image. In next.config.js, the domains property is used to enable external images. The other pages demonstrate the different layouts. Run or deploy the app to see how it works!

Live demo

https://image-component.nextjs.gallery/

Deploy your own

Deploy the example using Vercel or preview live with StackBlitz

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example image-component image-app
# or
yarn create next-app --example image-component image-app
# or
pnpm create next-app --example image-component image-app

Deploy it to the cloud with Vercel (Documentation).