Skip to content

Latest commit

 

History

History
118 lines (85 loc) · 2.71 KB

README.md

File metadata and controls

118 lines (85 loc) · 2.71 KB
Raw

Responsive Image Astro

Experimental package - Please refer to source code if you don't feel comfortable using it.

Installation

npm install responsive-image-astro
pnpm install responsive-image-astro
yarn install responsive-image-astro

NOTE: sharp needs to be installed too

npm install sharp
pnpm install sharp
yarn install sharp

ResponsiveImage Usage

Import the ResponsiveImage component and the image to be displayed

---
import { ResponsiveImage } from "responsive-image-astro";
import world from "../assets/world.jpg";
---

ResponsiveImage Component has 2 required parameters:

  • src (An import of the image to be used of type <ImageMetadata>)
  • breakpoints (Numbers array of the 'breakpoints' to generate the srcset for)
  • Optionally you can pass other parameters like alt, format, class and so on. This are present on the type <LocalImageProps>
<ResponsiveImage src={world} breakpoints={[200, 400, 600, 800]} />
<ResponsiveImage src={world} breakpoints={[200, 400, 600, 800]} alt="The World" format="avif" />

What it does?

It will create srcset for images automatically for each of the given breakpoints.

Example:

<img
	alt="The World"
	src="/assets/world.73e46027_WMMQ4.avif"
	srcset="
		/assets/world.73e46027_1QVP2p.avif  200w,
		/assets/world.73e46027_Z7OSi1.avif  400w,
		/assets/world.73e46027_Z27BBCr.avif 600w,
		/assets/world.73e46027_WMMQ4.avif   800w
	" />

ResponsiveRemoteImage Usage

Import the ResponsiveRemoteImage component

---
import { ResponsiveRemoteImage } from "responsive-image-astro";
---

ResponsiveRemoteImage Component has 4 required parameters:

  • src (Image source URL type <string>)
  • breakpoints (Numbers array of the 'breakpoints' to generate the srcset for)
  • width (Image width type <number>)
  • height (Image height type <number>)
  • Optionally you can pass other parameters like alt, format, class and so on. This are present on the type <RemoteImageProps>
<ResponsiveRemoteImage
	src="https://images.pexels.com/photos/41949/earth-earth-at-night-night-lights-41949.jpeg"
	breakpoints={[400, 800, 1600, 2400]}
	width={2400}
	height={1200}
/>

External images

For images from external sources to be processed and downloaded at build time, add the domains to your Astro configs. Read more here

export default defineConfig({
	image: {
		domains: ["images.pexels.com"]
	}
});

Work In Progress

There is still a lot to do and test and add...