Nextjs: Unable to load images from static folder

Question

How can I load images in a component in Next.js? Do I have to build the project first? If yes, is there a way to load the images without building first? I cannot get this to work, no matter what I try.

Answer 1

The static directory has been deprecated. Place files in public/static directory

Answer 2

Another way I find out Next Images

installation: npm install --save next-images

or yarn add next-images

Usage:

Create a next.config.js in your project

// next.config.js
const withImages = require('next-images')
module.exports = withImages()

Optionally you can add your custom Next.js configuration as parameter

// next.config.js
const withImages = require('next-images')
module.exports = withImages({
  webpack(config, options) {
    return config
  }
})

And in your components or pages simply import your images:

export default () => <div>
  <img src={require('./my-image.jpg')} />
</div>

or

import myImg from './my-image.jpg'

export default () => <div>
  <img src={myImg} />
</div>

Answer 3

From Next.js v11 onwards, one can now directly import images without any additional config or dependencies. Official example (comment mine):

import Image from 'next/image'
import profilePic from '../public/me.png'

function Home() {
  return (
    <>
      <h1>My Homepage</h1>
      <Image src={profilePic} alt="Picture of the author" />
      {/* <img src={profilePic.src} alt="Picture of the author" /> */}
      <p>Welcome to my homepage!</p>
    </>
  )
}

export default Home

Docs: next/image

Answer 4

With Next 10+ To serve an optimized image:

import Image from 'next/image'
<Image src={'banner.jpg'} alt='Home Page' width={100} height={100} />

Place the image in the public folder. All the referenced images must be present in the public folder at the build time. Image hot deployment will not work for images that reside in the public folder. You also can refer to cross-domain images with <Image> tag.

<Image src={'https://www.example.com/banner.jpg'} alt='Home Page' width={100} height={100} />

To allow cross-domain images, ensure to add the below entry to your next.config.js

module.exports = {
images: {
    domains: ['www.example.com'],
},

}

Answer 5

what i like to do for directing to images is using environment variables. in next.js they are easily set in next.config.js file like below:

// next.config.js

module.exports = {
    env: {
      PUBLIC_URL: '/',
    }
};

then you can direct to your publics path wherever it is by using process.env.PUBLIC_URL like below:

<img src={`${process.env.PUBLIC_URL}/my-image.jpg`} />

the advantages of using PUBLIC_URL environment variable over hard coding the path is that you can use another path for when file arrangements change (like in server). for then you could set conditionally which PUBLIC_URL value to use in production and development.

Answer 6

I will add here one obvious case, that is usually easily forgotten. It keeps appearing when one re-structure a site page and our IDE "silently fails" to update the paths of a related file/component or simply when one is more tired or distracted.

If you are using a page inside a folder ex: mysiteDomain/pagefolder/page You should be careful when using relative path. Something like <img src="logo.png" /> should be changed it to <img src="../logo.png" /> since the compiled page will also be inside a folder pagefolder. The path in the src attribute will be relative to the compiled page.

As an alternative, you could simply use an absolute path like for ex <img src="/logo.png" />. The path in the src attribute will be relative to the compiled root of the site.