Skip to content

A wrapper around next/image that does not require width and height to be specified.

Notifications You must be signed in to change notification settings

farbenmeer/next-image-autosize

Repository files navigation

next-image-autosize

A wrapper around next/image that automatically sets width and height.

This is useful in testing and development-environments where next-image-loader is not available (e.G. storybook). It will render a next/image without knowing the width and height beforehand by rendering a plain <img> first, then reading out the image dimensions and replacing the <img> with next/image.

Warning

DO NOT USE THIS IN PRODUCTION It will cause layout shift on two subsequent renders.

Usage

Storybook

// .storybook/preview.js
import * as NextImage from 'next/image'
import NextImageAutosize from '@farbenmeer/next-image-autosize'

const OriginalNextImage = NextImage.default

Object.defineProperty(NextImage, 'default', {
  configurable: true,
  value: NextImageAutosize
})