'use client' import React, { useRef, useEffect, useCallback, useContext, useMemo, useState, forwardRef, use, } from 'react' import ReactDOM from 'react-dom' import Head from '../shared/lib/head' import { getImgProps } from '../shared/lib/get-img-props' import type { ImageProps, ImgProps, OnLoad, OnLoadingComplete, PlaceholderValue, } from '../shared/lib/get-img-props' import type { ImageConfigComplete, ImageLoaderProps, } from '../shared/lib/image-config' import { imageConfigDefault } from '../shared/lib/image-config' import { ImageConfigContext } from '../shared/lib/image-config-context.shared-runtime' import { warnOnce } from '../shared/lib/utils/warn-once' import { RouterContext } from '../shared/lib/router-context.shared-runtime' // This is replaced by webpack alias import defaultLoader from 'next/dist/shared/lib/image-loader' import { useMergedRef } from './use-merged-ref' // This is replaced by webpack define plugin const configEnv = process.env.__NEXT_IMAGE_OPTS as any as ImageConfigComplete if (typeof window === 'undefined') { ;(globalThis as any).__NEXT_IMAGE_IMPORTED = true } export type { ImageLoaderProps } export type ImageLoader = (p: ImageLoaderProps) => string type ImgElementWithDataProp = HTMLImageElement & { 'data-loaded-src': string | undefined } type ImageElementProps = ImgProps & { unoptimized: boolean placeholder: PlaceholderValue onLoadRef: React.MutableRefObject onLoadingCompleteRef: React.MutableRefObject setBlurComplete: (b: boolean) => void setShowAltText: (b: boolean) => void sizesInput: string | undefined } // See https://stackoverflow.com/q/39777833/266535 for why we use this ref // handler instead of the img's onLoad attribute. function handleLoading( img: ImgElementWithDataProp, placeholder: PlaceholderValue, onLoadRef: React.MutableRefObject, onLoadingCompleteRef: React.MutableRefObject, setBlurComplete: (b: boolean) => void, unoptimized: boolean, sizesInput: string | undefined ) { const src = img?.src if (!img || img['data-loaded-src'] === src) { return } img['data-loaded-src'] = src const p = 'decode' in img ? img.decode() : Promise.resolve() p.catch(() => {}).then(() => { if (!img.parentElement || !img.isConnected) { // Exit early in case of race condition: // - onload() is called // - decode() is called but incomplete // - unmount is called // - decode() completes return } if (placeholder !== 'empty') { setBlurComplete(true) } if (onLoadRef?.current) { // Since we don't have the SyntheticEvent here, // we must create one with the same shape. // See https://reactjs.org/docs/events.html const event = new Event('load') Object.defineProperty(event, 'target', { writable: false, value: img }) let prevented = false let stopped = false onLoadRef.current({ ...event, nativeEvent: event, currentTarget: img, target: img, isDefaultPrevented: () => prevented, isPropagationStopped: () => stopped, persist: () => {}, preventDefault: () => { prevented = true event.preventDefault() }, stopPropagation: () => { stopped = true event.stopPropagation() }, }) } if (onLoadingCompleteRef?.current) { onLoadingCompleteRef.current(img) } if (process.env.NODE_ENV !== 'production') { const origSrc = new URL(src, 'http://n').searchParams.get('url') || src if (img.getAttribute('data-nimg') === 'fill') { if (!unoptimized && (!sizesInput || sizesInput === '100vw')) { let widthViewportRatio = img.getBoundingClientRect().width / window.innerWidth if (widthViewportRatio < 0.6) { if (sizesInput === '100vw') { warnOnce( `Image with src "${origSrc}" has "fill" prop and "sizes" prop of "100vw", but image is not rendered at full viewport width. Please adjust "sizes" to improve page performance. Read more: https://nextjs.org/docs/api-reference/next/image#sizes` ) } else { warnOnce( `Image with src "${origSrc}" has "fill" but is missing "sizes" prop. Please add it to improve page performance. Read more: https://nextjs.org/docs/api-reference/next/image#sizes` ) } } } if (img.parentElement) { const { position } = window.getComputedStyle(img.parentElement) const valid = ['absolute', 'fixed', 'relative'] if (!valid.includes(position)) { warnOnce( `Image with src "${origSrc}" has "fill" and parent element with invalid "position". Provided "${position}" should be one of ${valid .map(String) .join(',')}.` ) } } if (img.height === 0) { warnOnce( `Image with src "${origSrc}" has "fill" and a height value of 0. This is likely because the parent element of the image has not been styled to have a set height.` ) } } const heightModified = img.height.toString() !== img.getAttribute('height') const widthModified = img.width.toString() !== img.getAttribute('width') if ( (heightModified && !widthModified) || (!heightModified && widthModified) ) { warnOnce( `Image with src "${origSrc}" has either width or height modified, but not the other. If you use CSS to change the size of your image, also include the styles 'width: "auto"' or 'height: "auto"' to maintain the aspect ratio.` ) } } }) } function getDynamicProps( fetchPriority?: string ): Record { if (Boolean(use)) { // In React 19.0.0 or newer, we must use camelCase // prop to avoid "Warning: Invalid DOM property". // See https://github.com/facebook/react/pull/25927 return { fetchPriority } } // In React 18.2.0 or older, we must use lowercase prop // to avoid "Warning: Invalid DOM property". return { fetchpriority: fetchPriority } } const ImageElement = forwardRef( ( { src, srcSet, sizes, height, width, decoding, className, style, fetchPriority, placeholder, loading, unoptimized, fill, onLoadRef, onLoadingCompleteRef, setBlurComplete, setShowAltText, sizesInput, onLoad, onError, ...rest }, forwardedRef ) => { const ownRef = useCallback( (img: ImgElementWithDataProp | null) => { if (!img) { return } if (onError) { // If the image has an error before react hydrates, then the error is lost. // The workaround is to wait until the image is mounted which is after hydration, // then we set the src again to trigger the error handler (if there was an error). // eslint-disable-next-line no-self-assign img.src = img.src } if (process.env.NODE_ENV !== 'production') { if (!src) { console.error(`Image is missing required "src" property:`, img) } if (img.getAttribute('alt') === null) { console.error( `Image is missing required "alt" property. Please add Alternative Text to describe the image for screen readers and search engines.` ) } } if (img.complete) { handleLoading( img, placeholder, onLoadRef, onLoadingCompleteRef, setBlurComplete, unoptimized, sizesInput ) } }, [ src, placeholder, onLoadRef, onLoadingCompleteRef, setBlurComplete, onError, unoptimized, sizesInput, ] ) const ref = useMergedRef(forwardedRef, ownRef) return ( { const img = event.currentTarget as ImgElementWithDataProp handleLoading( img, placeholder, onLoadRef, onLoadingCompleteRef, setBlurComplete, unoptimized, sizesInput ) }} onError={(event) => { // if the real image fails to load, this will ensure "alt" is visible setShowAltText(true) if (placeholder !== 'empty') { // If the real image fails to load, this will still remove the placeholder. setBlurComplete(true) } if (onError) { onError(event) } }} /> ) } ) function ImagePreload({ isAppRouter, imgAttributes, }: { isAppRouter: boolean imgAttributes: ImgProps }) { const opts: ReactDOM.PreloadOptions = { as: 'image', imageSrcSet: imgAttributes.srcSet, imageSizes: imgAttributes.sizes, crossOrigin: imgAttributes.crossOrigin, referrerPolicy: imgAttributes.referrerPolicy, ...getDynamicProps(imgAttributes.fetchPriority), } if (isAppRouter && ReactDOM.preload) { ReactDOM.preload(imgAttributes.src, opts) return null } return ( ) } /** * The `Image` component is used to optimize images. * * Read more: [Next.js docs: `Image`](https://nextjs.org/docs/app/api-reference/components/image) */ export const Image = forwardRef( (props, forwardedRef) => { const pagesRouter = useContext(RouterContext) // We're in the app directory if there is no pages router. const isAppRouter = !pagesRouter const configContext = useContext(ImageConfigContext) const config = useMemo(() => { const c = configEnv || configContext || imageConfigDefault const allSizes = [...c.deviceSizes, ...c.imageSizes].sort((a, b) => a - b) const deviceSizes = c.deviceSizes.sort((a, b) => a - b) const qualities = c.qualities?.sort((a, b) => a - b) return { ...c, allSizes, deviceSizes, qualities } }, [configContext]) const { onLoad, onLoadingComplete } = props const onLoadRef = useRef(onLoad) useEffect(() => { onLoadRef.current = onLoad }, [onLoad]) const onLoadingCompleteRef = useRef(onLoadingComplete) useEffect(() => { onLoadingCompleteRef.current = onLoadingComplete }, [onLoadingComplete]) const [blurComplete, setBlurComplete] = useState(false) const [showAltText, setShowAltText] = useState(false) const { props: imgAttributes, meta: imgMeta } = getImgProps(props, { defaultLoader, imgConf: config, blurComplete, showAltText, }) return ( <> { } {imgMeta.priority ? ( ) : null} ) } )