next
Version:
The React Framework
311 lines (309 loc) • 14.1 kB
JavaScript
'use client';
;
Object.defineProperty(exports, "__esModule", {
value: true
});
Object.defineProperty(exports, "Image", {
enumerable: true,
get: function() {
return Image;
}
});
const _interop_require_default = require("@swc/helpers/_/_interop_require_default");
const _interop_require_wildcard = require("@swc/helpers/_/_interop_require_wildcard");
const _jsxruntime = require("react/jsx-runtime");
const _react = /*#__PURE__*/ _interop_require_wildcard._(require("react"));
const _reactdom = /*#__PURE__*/ _interop_require_default._(require("react-dom"));
const _head = /*#__PURE__*/ _interop_require_default._(require("../shared/lib/head"));
const _getimgprops = require("../shared/lib/get-img-props");
const _imageconfig = require("../shared/lib/image-config");
const _imageconfigcontextsharedruntime = require("../shared/lib/image-config-context.shared-runtime");
const _warnonce = require("../shared/lib/utils/warn-once");
const _routercontextsharedruntime = require("../shared/lib/router-context.shared-runtime");
const _imageloader = /*#__PURE__*/ _interop_require_default._(require("next/dist/shared/lib/image-loader"));
const _usemergedref = require("./use-merged-ref");
// This is replaced by webpack define plugin
const configEnv = process.env.__NEXT_IMAGE_OPTS;
if (typeof window === 'undefined') {
;
globalThis.__NEXT_IMAGE_IMPORTED = true;
}
// See https://stackoverflow.com/q/39777833/266535 for why we use this ref
// handler instead of the img's onLoad attribute.
function handleLoading(img, placeholder, onLoadRef, onLoadingCompleteRef, setBlurComplete, unoptimized, sizesInput) {
const src = img == null ? void 0 : 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 == null ? void 0 : 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 == null ? void 0 : 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') {
(0, _warnonce.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 {
(0, _warnonce.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)) {
(0, _warnonce.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) {
(0, _warnonce.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) {
(0, _warnonce.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) {
if (Boolean(_react.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 = /*#__PURE__*/ (0, _react.forwardRef)((param, forwardedRef)=>{
let { src, srcSet, sizes, height, width, decoding, className, style, fetchPriority, placeholder, loading, unoptimized, fill, onLoadRef, onLoadingCompleteRef, setBlurComplete, setShowAltText, sizesInput, onLoad, onError, ...rest } = param;
const ownRef = (0, _react.useCallback)((img)=>{
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 = (0, _usemergedref.useMergedRef)(forwardedRef, ownRef);
return /*#__PURE__*/ (0, _jsxruntime.jsx)("img", {
...rest,
...getDynamicProps(fetchPriority),
// It's intended to keep `loading` before `src` because React updates
// props in order which causes Safari/Firefox to not lazy load properly.
// See https://github.com/facebook/react/issues/25883
loading: loading,
width: width,
height: height,
decoding: decoding,
"data-nimg": fill ? 'fill' : '1',
className: className,
style: style,
// It's intended to keep `src` the last attribute because React updates
// attributes in order. If we keep `src` the first one, Safari will
// immediately start to fetch `src`, before `sizes` and `srcSet` are even
// updated by React. That causes multiple unnecessary requests if `srcSet`
// and `sizes` are defined.
// This bug cannot be reproduced in Chrome or Firefox.
sizes: sizes,
srcSet: srcSet,
src: src,
ref: ref,
onLoad: (event)=>{
const img = event.currentTarget;
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(param) {
let { isAppRouter, imgAttributes } = param;
const opts = {
as: 'image',
imageSrcSet: imgAttributes.srcSet,
imageSizes: imgAttributes.sizes,
crossOrigin: imgAttributes.crossOrigin,
referrerPolicy: imgAttributes.referrerPolicy,
...getDynamicProps(imgAttributes.fetchPriority)
};
if (isAppRouter && _reactdom.default.preload) {
// See https://github.com/facebook/react/pull/26940
_reactdom.default.preload(imgAttributes.src, // @ts-expect-error TODO: upgrade to `@types/react-dom@18.3.x`
opts);
return null;
}
return /*#__PURE__*/ (0, _jsxruntime.jsx)(_head.default, {
children: /*#__PURE__*/ (0, _jsxruntime.jsx)("link", {
rel: "preload",
// Note how we omit the `href` attribute, as it would only be relevant
// for browsers that do not support `imagesrcset`, and in those cases
// it would cause the incorrect image to be preloaded.
//
// https://html.spec.whatwg.org/multipage/semantics.html#attr-link-imagesrcset
href: imgAttributes.srcSet ? undefined : imgAttributes.src,
...opts
}, '__nimg-' + imgAttributes.src + imgAttributes.srcSet + imgAttributes.sizes)
});
}
const Image = /*#__PURE__*/ (0, _react.forwardRef)((props, forwardedRef)=>{
const pagesRouter = (0, _react.useContext)(_routercontextsharedruntime.RouterContext);
// We're in the app directory if there is no pages router.
const isAppRouter = !pagesRouter;
const configContext = (0, _react.useContext)(_imageconfigcontextsharedruntime.ImageConfigContext);
const config = (0, _react.useMemo)(()=>{
var _c_qualities;
const c = configEnv || configContext || _imageconfig.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 = c.qualities) == null ? void 0 : _c_qualities.sort((a, b)=>a - b);
return {
...c,
allSizes,
deviceSizes,
qualities
};
}, [
configContext
]);
const { onLoad, onLoadingComplete } = props;
const onLoadRef = (0, _react.useRef)(onLoad);
(0, _react.useEffect)(()=>{
onLoadRef.current = onLoad;
}, [
onLoad
]);
const onLoadingCompleteRef = (0, _react.useRef)(onLoadingComplete);
(0, _react.useEffect)(()=>{
onLoadingCompleteRef.current = onLoadingComplete;
}, [
onLoadingComplete
]);
const [blurComplete, setBlurComplete] = (0, _react.useState)(false);
const [showAltText, setShowAltText] = (0, _react.useState)(false);
const { props: imgAttributes, meta: imgMeta } = (0, _getimgprops.getImgProps)(props, {
defaultLoader: _imageloader.default,
imgConf: config,
blurComplete,
showAltText
});
return /*#__PURE__*/ (0, _jsxruntime.jsxs)(_jsxruntime.Fragment, {
children: [
/*#__PURE__*/ (0, _jsxruntime.jsx)(ImageElement, {
...imgAttributes,
unoptimized: imgMeta.unoptimized,
placeholder: imgMeta.placeholder,
fill: imgMeta.fill,
onLoadRef: onLoadRef,
onLoadingCompleteRef: onLoadingCompleteRef,
setBlurComplete: setBlurComplete,
setShowAltText: setShowAltText,
sizesInput: props.sizes,
ref: forwardedRef
}),
imgMeta.priority ? /*#__PURE__*/ (0, _jsxruntime.jsx)(ImagePreload, {
isAppRouter: isAppRouter,
imgAttributes: imgAttributes
}) : null
]
});
});
if ((typeof exports.default === 'function' || (typeof exports.default === 'object' && exports.default !== null)) && typeof exports.default.__esModule === 'undefined') {
Object.defineProperty(exports.default, '__esModule', { value: true });
Object.assign(exports.default, exports);
module.exports = exports.default;
}
//# sourceMappingURL=image-component.js.map