feat(remix-react): show deprecation warning when imagesizes & `imag…

…esizes` properties are returned from `links` function
remix-run · Mar 8, 2023 · 87d54ac · 87d54ac
1 parent b33d098
commit 87d54ac
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/.changeset/thick-actors-juggle.md b/.changeset/thick-actors-juggle.md
@@ -0,0 +1,5 @@
+---
+"@remix-run/react": minor
+---
+
+show deprecation warning when `imagesizes` & `imagesizes` properties are returned from `links` function
diff --git a/packages/remix-react/components.tsx b/packages/remix-react/components.tsx
@@ -380,6 +380,16 @@ export function Links() {
     [matches, routeModules, manifest]
   );
 
+  React.useEffect(() => {
+    warnOnce(
+      links.some((link) => "imagesizes" in link || "imagesrcset" in link),
+      "⚠️ DEPRECATED: The `imagesizes` & `imagesrcset` properties in " +
+        "your links have been deprecated in favor of `imageSizes` & " +
+        "`imageSrcSet` and support will be removed in Remix v2. Please update " +
+        "your code to use the new property names instead."
+    );
+  }, [links]);
+
   return (
     <>
       {links.map((link) => {