Style(web-react): Introduce ESlint rule to avoid using useLayoutEffect

refs #DS-1004
lmc-eu · Nov 5, 2023 · 84df51b · 84df51b
1 parent 7715998
commit 84df51b
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/packages/web-react/.eslintrc.js b/packages/web-react/.eslintrc.js
@@ -65,5 +65,16 @@ module.exports = {
     'import/no-extraneous-dependencies': ['error', { packageDir: ['./', '../../'] }],
     // disable double quotes
     quotes: ['warn', 'single'],
+    // use useIsomorphicLayoutEffect instead of useLayoutEffect
+    // @see: https://medium.com/@alexandereardon/uselayouteffect-and-ssr-192986cdcf7a
+    'no-restricted-imports': [
+      'error',
+      // Disabling using of useLayoutEffect from react
+      {
+        name: 'react',
+        importNames: ['useLayoutEffect'],
+        message: '`useLayoutEffect` causes a warning in SSR. Use `useIsomorphicLayoutEffect`',
+      },
+    ],
   },
 };