feat: stabilize unstable_getImgProps() => getImageProps()
#60739
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ijjk
added
area: documentation
created-by: Next.js team
Stats from current PRDefault BuildGeneral
Client Bundles (main, webpack)
Legacy Client Bundles (polyfills)
Client Pages
Client Build Manifests
Rendered Page Sizes
Edge SSR bundle Size
Middleware size
Next Runtimes
Diff detailsDiff for page.jsDiff too large to display Diff for middleware.jsDiff too large to display Diff for edge-ssr.jsDiff too large to display Diff for image-HASH.js@@ -1,7 +1,7 @@
(self["webpackChunk_N_E"] = self["webpackChunk_N_E"] || []).push([
[358],
{
- /***/ 1552: /***/ function (
+ /***/ 4070: /***/ function (
__unused_webpack_module,
__unused_webpack_exports,
__webpack_require__
@@ -9,7 +9,7 @@
(window.__NEXT_P = window.__NEXT_P || []).push([
"/image",
function () {
- return __webpack_require__(8769);
+ return __webpack_require__(3697);
},
]);
if (false) {
@@ -18,7 +18,7 @@
/***/
},
- /***/ 359: /***/ function (module, exports, __webpack_require__) {
+ /***/ 2353: /***/ function (module, exports, __webpack_require__) {
"use strict";
/* __next_internal_client_entry_do_not_use__ cjs */
Object.defineProperty(exports, "__esModule", {
@@ -40,15 +40,15 @@
__webpack_require__(422)
);
const _head = /*#__PURE__*/ _interop_require_default._(
- __webpack_require__(4489)
+ __webpack_require__(2272)
);
- const _getimgprops = __webpack_require__(9997);
- const _imageconfig = __webpack_require__(9747);
- const _imageconfigcontextsharedruntime = __webpack_require__(9429);
- const _warnonce = __webpack_require__(5761);
- const _routercontextsharedruntime = __webpack_require__(2991);
+ const _getimgprops = __webpack_require__(2530);
+ const _imageconfig = __webpack_require__(4899);
+ const _imageconfigcontextsharedruntime = __webpack_require__(9292);
+ const _warnonce = __webpack_require__(4213);
+ const _routercontextsharedruntime = __webpack_require__(7084);
const _imageloader = /*#__PURE__*/ _interop_require_default._(
- __webpack_require__(5076)
+ __webpack_require__(7443)
);
// This is replaced by webpack define plugin
const configEnv = {
@@ -373,7 +373,7 @@
/***/
},
- /***/ 9997: /***/ function (
+ /***/ 2530: /***/ function (
__unused_webpack_module,
exports,
__webpack_require__
@@ -389,9 +389,9 @@
return getImgProps;
},
});
- const _warnonce = __webpack_require__(5761);
- const _imageblursvg = __webpack_require__(8543);
- const _imageconfig = __webpack_require__(9747);
+ const _warnonce = __webpack_require__(4213);
+ const _imageblursvg = __webpack_require__(3139);
+ const _imageconfig = __webpack_require__(4899);
const VALID_LOADING_VALUES =
/* unused pure expression or super */ null && [
"lazy",
@@ -760,7 +760,7 @@
/***/
},
- /***/ 8543: /***/ function (__unused_webpack_module, exports) {
+ /***/ 3139: /***/ function (__unused_webpack_module, exports) {
"use strict";
/**
* A shared function, used on both client and server, to generate a SVG blur placeholder.
@@ -815,7 +815,7 @@
/***/
},
- /***/ 3103: /***/ function (
+ /***/ 3067: /***/ function (
__unused_webpack_module,
exports,
__webpack_require__
@@ -834,24 +834,20 @@
});
}
_export(exports, {
- unstable_getImgProps: function () {
- return unstable_getImgProps;
+ getImageProps: function () {
+ return getImageProps;
},
default: function () {
return _default;
},
});
const _interop_require_default = __webpack_require__(1351);
- const _getimgprops = __webpack_require__(9997);
- const _warnonce = __webpack_require__(5761);
- const _imagecomponent = __webpack_require__(359);
+ const _getimgprops = __webpack_require__(2530);
+ const _imagecomponent = __webpack_require__(2353);
const _imageloader = /*#__PURE__*/ _interop_require_default._(
- __webpack_require__(5076)
+ __webpack_require__(7443)
);
- const unstable_getImgProps = (imgProps) => {
- (0, _warnonce.warnOnce)(
- "Warning: unstable_getImgProps() is experimental and may change or be removed at any time. Use at your own risk."
- );
+ const getImageProps = (imgProps) => {
const { props } = (0, _getimgprops.getImgProps)(imgProps, {
defaultLoader: _imageloader.default,
// This is replaced by webpack define plugin
@@ -864,6 +860,9 @@
unoptimized: false,
},
});
+ // Normally we don't care about undefined props because we pass to JSX,
+ // but this exported function could be used by the end user for anything
+ // so we delete undefined props to clean it up a little.
for (const [key, value] of Object.entries(props)) {
if (value === undefined) {
delete props[key];
@@ -878,7 +877,7 @@
/***/
},
- /***/ 5076: /***/ function (__unused_webpack_module, exports) {
+ /***/ 7443: /***/ function (__unused_webpack_module, exports) {
"use strict";
Object.defineProperty(exports, "__esModule", {
@@ -913,7 +912,7 @@
/***/
},
- /***/ 8769: /***/ function (
+ /***/ 3697: /***/ function (
__unused_webpack_module,
__webpack_exports__,
__webpack_require__
@@ -934,8 +933,8 @@
// EXTERNAL MODULE: ./node_modules/.pnpm/[email protected]/node_modules/react/jsx-runtime.js
var jsx_runtime = __webpack_require__(1527);
- // EXTERNAL MODULE: ./node_modules/.pnpm/[email protected][email protected]/node_modules/next/image.js
- var next_image = __webpack_require__(1577);
+ // EXTERNAL MODULE: ./node_modules/.pnpm/[email protected][email protected]/node_modules/next/image.js
+ var next_image = __webpack_require__(73);
var image_default = /*#__PURE__*/ __webpack_require__.n(next_image); // CONCATENATED MODULE: ./pages/nextjs.png
/* harmony default export */ var nextjs = {
src: "/_next/static/media/nextjs.cae0b805.png",
@@ -965,12 +964,12 @@
/***/
},
- /***/ 1577: /***/ function (
+ /***/ 73: /***/ function (
module,
__unused_webpack_exports,
__webpack_require__
) {
- module.exports = __webpack_require__(3103);
+ module.exports = __webpack_require__(3067);
/***/
},
@@ -981,7 +980,7 @@
return __webpack_require__((__webpack_require__.s = moduleId));
};
/******/ __webpack_require__.O(0, [888, 774, 179], function () {
- return __webpack_exec__(1552);
+ return __webpack_exec__(4070);
});
/******/ var __webpack_exports__ = __webpack_require__.O();
/******/ _N_E = __webpack_exports__;Diff for 433-HASH.jsDiff too large to display Diff for main-HASH.jsDiff too large to display Diff for app-page-exp..ntime.dev.jsDiff too large to display Diff for app-page-exp..time.prod.jsDiff too large to display Diff for app-page-tur..time.prod.jsDiff too large to display Diff for app-page-tur..time.prod.jsDiff too large to display Diff for app-page.runtime.dev.jsfailed to diffDiff for app-page.runtime.prod.jsDiff too large to display Diff for app-route-ex..ntime.dev.jsDiff too large to display Diff for app-route-ex..time.prod.jsDiff too large to display Diff for app-route-tu..time.prod.jsDiff too large to display Diff for app-route-tu..time.prod.jsDiff too large to display Diff for app-route.runtime.dev.jsDiff too large to display Diff for app-route.ru..time.prod.jsDiff too large to display Diff for pages-api-tu..time.prod.jsDiff too large to display Diff for pages-api.runtime.dev.jsDiff too large to display Diff for pages-api.ru..time.prod.jsDiff too large to display Diff for pages-turbo...time.prod.jsDiff too large to display Diff for pages.runtime.dev.jsDiff too large to display Diff for pages.runtime.prod.jsDiff too large to display Diff for server.runtime.prod.jsDiff too large to display |
Tests Passed |
1 task
styfle
requested review from
timneutkens,
ijjk,
shuding,
huozhi,
ztanner,
a team,
feedthejim and
wyattjoh
as code owners
styfle
requested review from
timeyoutakeit and
leerob
and removed request for
a team
huozhi
approved these changes
Jan 17, 2024
styfle
changed the title
getImageProps()unstable_getImgProps() => getImageProps()
styfle
added a commit
that referenced
this pull request
Jan 18, 2024
This PR fixes a few typos in the docs from #60739
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR renames
unstable_getImgPropstogetImageProps()(originally introduced in PR #51205).Most feedback after announcing looks positive so it seems like we can safely stabilize this API now. Its unlikely to change.
I also added documentation with example usage.
Closes NEXT-2120
Fixes #56009