I'm using nextjs app router... There is an issue occuring in this code, when I navigate…
- User
I'm using nextjs app router... There is an issue occuring in this code, when I navigate back from ProductDetail to ProductList... the ProductDetail scrolls very down for a brief moment this is annoying, fix it. ProductList.jsx: 'use client' import React, { useCallback, useEffect, useMemo, useRef, useState } from 'react'; import { useRouter, useSearchParams, usePathname } from 'next/navigation'; import { useInView } from 'react-intersection-observer'; import dynamic from 'next/dynamic'; import ProductItem from './ProductItem'; import ProductLoading from '@/components/ProductLoading'; import NoProductsFound from '@/components/NoProductsFound'; import ProductDetail from '@/components/ProductDetail'; import Link from 'next/link'; import Image from 'next/image'; import { NotificationProvider } from "@/components/NotificationContext";
const SearchComponent = dynamic(() => import('@/components/SearchComponent'), { ssr: false, loading: () => });
const ProductModal = dynamic(() => import("@/components/ProductDetailModal"), { ssr: false });
export default function ProductList({ initialProducts, hasMore, initialPage, initialQuery, minPrice, maxPrice, title }) { const [products, setProducts] = useState(initialProducts); const [page, setPage] = useState(initialPage); const [loading, setLoading] = useState(false); const [noMoreProducts, setNoMoreProducts] = useState(!hasMore); const [query, setQuery] = useState(initialQuery); const [detail, setDetail] = useState(null); const [selectedProduct, setSelectedProduct] = useState(null); const [shouldScroll, setShouldScroll] = useState(false); const scroll = useRef(0);
const { ref, inView } = useInView({ threshold: 0 }); const router = useRouter(); const searchParams = useSearchParams(); const pathname = usePathname(); const loadMoreProducts = useCallback(() => { if (loading || noMoreProducts) return; setLoading(true); const nextPage = page + 1; const params = new URLSearchParams(Array.from(searchParams.entries())); params.set('page', nextPage.toString()); router.push(`/products?${params.toString()}`, { scroll: false }); }, [page, loading, noMoreProducts, searchParams, router]); useEffect(() => { if (inView && !noMoreProducts) { loadMoreProducts(); } }, [inView, loadMoreProducts, noMoreProducts]); const handleSearch = useCallback((newQuery) => { setQuery(newQuery); const params = new URLSearchParams(Array.from(searchParams.entries())); params.set('query', newQuery); params.set('page', '1'); router.push(`/products?${params.toString()}`, { scroll: false }); }, [searchParams, router]); useEffect(() => { setProducts(initialProducts); setPage(initialPage); setNoMoreProducts(!hasMore); setQuery(initialQuery); setLoading(false); }, [initialProducts, initialPage, hasMore, initialQuery]); const memoizedProducts = useMemo(() => products.map((product) => ({ ...product, cheapestPrice: getCheapestPrice(product), })), [products]); useEffect(() => { if (shouldScroll) { window.scrollTo(0, scroll.current); setShouldScroll(false); } }, [shouldScroll]); useEffect(() => { if (pathname === '/products') { setDetail(null); setShouldScroll(true); } }, [pathname]); const handleProductClick = useCallback((product) => { scroll.current = window.scrollY; setDetail(product); const newURL = `/products/${product.id}`; window.history.pushState({ path: newURL }, '', newURL); }, []); const handleCartClick = useCallback((product) => { setSelectedProduct(product); }, []); const handleModalClose = useCallback(() => { setSelectedProduct(null); }, []); return ( <> {detail ? ( <NotificationProvider> <ProductDetail product={detail} /> </NotificationProvider> ) : ( <> <header className="flex items-center mb-6"> <Link prefetch={false} className="relative z-20" href="/"> <Image src="https://storage.naayiq.com/resources/arrow-left.svg" width={40} unoptimized={true} height={40} alt="left" priority/> </Link> <h1 className="text-3xl z-10 text-[#181717] left-0 right-0 absolute font-sans text-center font-medium"> {title || 'All Products'} </h1> </header> <SearchComponent minPrice={minPrice} maxPrice={maxPrice} query={query} setQuery={handleSearch}/> {memoizedProducts.length > 0 ? ( <div className="grid grid-cols-2 w-full justify-between gap-4 sm:gap-6 ssm3:grid-cols-3 md:grid-cols-4 lg:grid-cols-5"> {memoizedProducts.map((product) => ( <ProductItem key={product.id} id={product.id} name={product.name} product={product} handleClick={() => handleProductClick(product)} price={formatPrice(product.cheapestPrice)} imageUrl={product.images[0]} onCartClick={handleCartClick} /> ))} </div> ) : ( <NoProductsFound /> )} {loading && <ProductLoading />} {!loading && !noMoreProducts && <div ref={ref} style={{height: '20px'}}></div>} </> )} {selectedProduct && ( <NotificationProvider> <ProductModal productData={{ product: selectedProduct }} isOpen={!!selectedProduct} onClose={handleModalClose} /> </NotificationProvider> )} </> );}
const getCheapestPrice = (product) => { const prices = [ product.price && product.price !== '0.00' ? parseFloat(product.price) : Infinity, ...(product.sizes?.map((size) => parseFloat(size.price)) || []), ...(product.colors?.flatMap((color) => [ parseFloat(color.price), ...(color.sizes?.map((size) => parseFloat(size.price)) || []), ]) || []), ].filter((price) => !isNaN(price) && isFinite(price));
return prices.length > 0 ? Math.min(...prices) : null;};
const formatPrice = (price) => { if (price == null || price === Infinity) return 'N/A'; return
${price >= 10000 ? price.toLocaleString() : price} IQD; };const SearchComponentSkeleton = () => ( ); ProductDetail.jsx: 'use client' import React, { useCallback, useEffect, useMemo, useRef, useState } from 'react'; import { useRouter, useSearchParams, usePathname } from 'next/navigation'; import { useInView } from 'react-intersection-observer'; import dynamic from 'next/dynamic'; import ProductItem from './ProductItem'; import ProductLoading from '@/components/ProductLoading'; import NoProductsFound from '@/components/NoProductsFound'; import ProductDetail from '@/components/ProductDetail'; import Link from 'next/link'; import Image from 'next/image'; import { NotificationProvider } from "@/components/NotificationContext";
const SearchComponent = dynamic(() => import('@/components/SearchComponent'), { ssr: false, loading: () => });
const ProductModal = dynamic(() => import("@/components/ProductDetailModal"), { ssr: false });
export default function ProductList({ initialProducts, hasMore, initialPage, initialQuery, minPrice, maxPrice, title }) { const [products, setProducts] = useState(initialProducts); const [page, setPage] = useState(initialPage); const [loading, setLoading] = useState(false); const [noMoreProducts, setNoMoreProducts] = useState(!hasMore); const [query, setQuery] = useState(initialQuery); const [detail, setDetail] = useState(null); const [selectedProduct, setSelectedProduct] = useState(null); const [shouldScroll, setShouldScroll] = useState(false); const scroll = useRef(0);
const { ref, inView } = useInView({ threshold: 0 }); const router = useRouter(); const searchParams = useSearchParams(); const pathname = usePathname(); const loadMoreProducts = useCallback(() => { if (loading || noMoreProducts) return; setLoading(true); const nextPage = page + 1; const params = new URLSearchParams(Array.from(searchParams.entries())); params.set('page', nextPage.toString()); router.push(`/products?${params.toString()}`, { scroll: false }); }, [page, loading, noMoreProducts, searchParams, router]); useEffect(() => { if (inView && !noMoreProducts) { loadMoreProducts(); } }, [inView, loadMoreProducts, noMoreProducts]); const handleSearch = useCallback((newQuery) => { setQuery(newQuery); const params = new URLSearchParams(Array.from(searchParams.entries())); params.set('query', newQuery); params.set('page', '1'); router.push(`/products?${params.toString()}`, { scroll: false }); }, [searchParams, router]); useEffect(() => { setProducts(initialProducts); setPage(initialPage); setNoMoreProducts(!hasMore); setQuery(initialQuery); setLoading(false); }, [initialProducts, initialPage, hasMore, initialQuery]); const memoizedProducts = useMemo(() => products.map((product) => ({ ...product, cheapestPrice: getCheapestPrice(product), })), [products]); useEffect(() => { if (shouldScroll) { window.scrollTo(0, scroll.current); setShouldScroll(false); } }, [shouldScroll]); useEffect(() => { if (pathname === '/products') { setDetail(null); setShouldScroll(true); } }, [pathname]); const handleProductClick = useCallback((product) => { scroll.current = window.scrollY; setDetail(product); const newURL = `/products/${product.id}`; window.history.pushState({ path: newURL }, '', newURL); }, []); const handleCartClick = useCallback((product) => { setSelectedProduct(product); }, []); const handleModalClose = useCallback(() => { setSelectedProduct(null); }, []); return ( <> {detail ? ( <NotificationProvider> <ProductDetail product={detail} /> </NotificationProvider> ) : ( <> <header className="flex items-center mb-6"> <Link prefetch={false} className="relative z-20" href="/"> <Image src="https://storage.naayiq.com/resources/arrow-left.svg" width={40} unoptimized={true} height={40} alt="left" priority/> </Link> <h1 className="text-3xl z-10 text-[#181717] left-0 right-0 absolute font-sans text-center font-medium"> {title || 'All Products'} </h1> </header> <SearchComponent minPrice={minPrice} maxPrice={maxPrice} query={query} setQuery={handleSearch}/> {memoizedProducts.length > 0 ? ( <div className="grid grid-cols-2 w-full justify-between gap-4 sm:gap-6 ssm3:grid-cols-3 md:grid-cols-4 lg:grid-cols-5"> {memoizedProducts.map((product) => ( <ProductItem key={product.id} id={product.id} name={product.name} product={product} handleClick={() => handleProductClick(product)} price={formatPrice(product.cheapestPrice)} imageUrl={product.images[0]} onCartClick={handleCartClick} /> ))} </div> ) : ( <NoProductsFound /> )} {loading && <ProductLoading />} {!loading && !noMoreProducts && <div ref={ref} style={{height: '20px'}}></div>} </> )} {selectedProduct && ( <NotificationProvider> <ProductModal productData={{ product: selectedProduct }} isOpen={!!selectedProduct} onClose={handleModalClose} /> </NotificationProvider> )} </> );}
const getCheapestPrice = (product) => { const prices = [ product.price && product.price !== '0.00' ? parseFloat(product.price) : Infinity, ...(product.sizes?.map((size) => parseFloat(size.price)) || []), ...(product.colors?.flatMap((color) => [ parseFloat(color.price), ...(color.sizes?.map((size) => parseFloat(size.price)) || []), ]) || []), ].filter((price) => !isNaN(price) && isFinite(price));
return prices.length > 0 ? Math.min(...prices) : null;};
const formatPrice = (price) => { if (price == null || price === Infinity) return 'N/A'; return
${price >= 10000 ? price.toLocaleString() : price} IQD; };const SearchComponentSkeleton = () => ( );
- Assistant
The issue you're experiencing with the scroll position when navigating back from
ProductDetailtoProductListis likely due to manually manipulating the browser's history usingwindow.history.pushState. This can interfere with Next.js's internal routing and scroll management, leading to unexpected scroll behavior.To resolve this, it's recommended to use Next.js's built-in router methods (
router.pushandrouter.back) instead of directly manipulating thewindow.history. Additionally, ensuring that scroll positions are managed correctly within the Next.js lifecycle will help prevent unwanted scroll jumps.Here's a step-by-step guide to refactoring your code to fix the scroll issue:
-
Use Next.js Router for Navigation: Replace
window.history.pushStatewithrouter.pushto ensure that navigation is handled correctly within Next.js. -
Manage Scroll Positions Properly: Leverage Next.js's built-in scroll restoration by avoiding manual scroll management unless absolutely necessary. If you need to manage scroll positions manually, ensure it's done in harmony with Next.js's routing lifecycle.
-
Avoid Duplicated Code: Ensure that
ProductList.jsxandProductDetail.jsxare distinct and not duplicates of each other. This will help maintain clarity and prevent unexpected behavior. -
Implement Modal for Product Details (Optional): Using a modal for
ProductDetailcan help manage the UI state without navigating away from theProductListpage, thereby preventing scroll issues.
Below is the refactored
ProductList.jsxincorporating these recommendations:'use client'; import React, { useCallback, useEffect, useMemo, useRef, useState } from 'react'; import { useRouter, useSearchParams, usePathname } from 'next/navigation'; import { useInView } from 'react-intersection-observer'; import dynamic from 'next/dynamic'; import ProductItem from './ProductItem'; import ProductLoading from '@/components/ProductLoading'; import NoProductsFound from '@/components/NoProductsFound'; import Link from 'next/link'; import Image from 'next/image'; import { NotificationProvider } from "@/components/NotificationContext"; const SearchComponent = dynamic(() => import('@/components/SearchComponent'), { ssr: false, loading: () => <SearchComponentSkeleton /> }); const ProductModal = dynamic(() => import("@/components/ProductDetailModal"), { ssr: false }); export default function ProductList({ initialProducts, hasMore, initialPage, initialQuery, minPrice, maxPrice, title }) { const [products, setProducts] = useState(initialProducts); const [page, setPage] = useState(initialPage); const [loading, setLoading] = useState(false); const [noMoreProducts, setNoMoreProducts] = useState(!hasMore); const [query, setQuery] = useState(initialQuery); const [detail, setDetail] = useState(null); const [selectedProduct, setSelectedProduct] = useState(null); const scrollPosition = useRef(0); const { ref, inView } = useInView({ threshold: 0 }); const router = useRouter(); const searchParams = useSearchParams(); const pathname = usePathname(); const loadMoreProducts = useCallback(() => { if (loading || noMoreProducts) return; setLoading(true); const nextPage = page + 1; const params = new URLSearchParams(Array.from(searchParams.entries())); params.set('page', nextPage.toString()); router.push(`/products?${params.toString()}`, { scroll: false }); }, [page, loading, noMoreProducts, searchParams, router]); useEffect(() => { if (inView && !noMoreProducts) { loadMoreProducts(); } }, [inView, loadMoreProducts, noMoreProducts]); const handleSearch = useCallback((newQuery) => { setQuery(newQuery); const params = new URLSearchParams(Array.from(searchParams.entries())); params.set('query', newQuery); params.set('page', '1'); router.push(`/products?${params.toString()}`, { scroll: false }); }, [searchParams, router]); useEffect(() => { setProducts(initialProducts); setPage(initialPage); setNoMoreProducts(!hasMore); setQuery(initialQuery); setLoading(false); }, [initialProducts, initialPage, hasMore, initialQuery]); const memoizedProducts = useMemo(() => products.map((product) => ({ ...product, cheapestPrice: getCheapestPrice(product), })), [products]); // Save scroll position before navigating to detail const handleProductClick = useCallback((product) => { scrollPosition.current = window.scrollY; setDetail(product); router.push(`/products/${product.id}`, undefined, { shallow: true, scroll: false }); }, [router]); // Restore scroll position when navigating back to list useEffect(() => { if (pathname === '/products') { setDetail(null); window.scrollTo(0, scrollPosition.current); } }, [pathname]); const handleCartClick = useCallback((product) => { setSelectedProduct(product); }, []); const handleModalClose = useCallback(() => { setSelectedProduct(null); }, []); return ( <> {detail ? ( <NotificationProvider> <ProductDetail product={detail} /> </NotificationProvider> ) : ( <> <header className="flex items-center mb-6"> <Link prefetch={false} className="relative z-20" href="/"> <Image src="https://storage.naayiq.com/resources/arrow-left.svg" width={40} unoptimized={true} height={40} alt="left" priority/> </Link> <h1 className="text-3xl z-10 text-[#181717] left-0 right-0 absolute font-sans text-center font-medium"> {title || 'All Products'} </h1> </header> <SearchComponent minPrice={minPrice} maxPrice={maxPrice} query={query} setQuery={handleSearch}/> {memoizedProducts.length > 0 ? ( <div className="grid grid-cols-2 w-full justify-between gap-4 sm:gap-6 ssm3:grid-cols-3 md:grid-cols-4 lg:grid-cols-5"> {memoizedProducts.map((product) => ( <ProductItem key={product.id} id={product.id} name={product.name} product={product} handleClick={() => handleProductClick(product)} price={formatPrice(product.cheapestPrice)} imageUrl={product.images[0]} onCartClick={handleCartClick} /> ))} </div> ) : ( <NoProductsFound /> )} {loading && <ProductLoading />} {!loading && !noMoreProducts && <div ref={ref} style={{height: '20px'}}></div>} </> )} {selectedProduct && ( <NotificationProvider> <ProductModal productData={{ product: selectedProduct }} isOpen={!!selectedProduct} onClose={handleModalClose} /> </NotificationProvider> )} </> ); } const getCheapestPrice = (product) => { const prices = [ product.price && product.price !== '0.00' ? parseFloat(product.price) : Infinity, ...(product.sizes?.map((size) => parseFloat(size.price)) || []), ...(product.colors?.flatMap((color) => [ parseFloat(color.price), ...(color.sizes?.map((size) => parseFloat(size.price)) || []), ]) || []), ].filter((price) => !isNaN(price) && isFinite(price)); return prices.length > 0 ? Math.min(...prices) : null; }; const formatPrice = (price) => { if (price == null || price === Infinity) return 'N/A'; return `${price >= 10000 ? price.toLocaleString() : price} IQD`; }; const SearchComponentSkeleton = () => ( <div className="flex mb-4 items-center space-x-2 animate-pulse"> <div className="h-10 bg-gray-200 rounded-md flex-grow"></div> <div className="h-10 w-[5.5rem] bg-gray-200 rounded-md"></div> </div> );Key Changes and Explanations:
-
Using
router.pushInstead ofwindow.history.pushState:router.push(`/products/${product.id}`, undefined, { shallow: true, scroll: false });This ensures that navigation is handled within Next.js's routing system, preventing conflicts and ensuring smoother transitions.
-
Removing Manual Scroll Management: Instead of manually managing the scroll position with state variables like
shouldScrollandscroll, the scroll restoration is handled more predictably by saving the scroll position before navigation and restoring it upon return.const scrollPosition = useRef(0); const handleProductClick = useCallback((product) => { scrollPosition.current = window.scrollY; setDetail(product); router.push(`/products/${product.id}`, undefined, { shallow: true, scroll: false }); }, [router]); useEffect(() => { if (pathname === '/products') { setDetail(null); window.scrollTo(0, scrollPosition.current); } }, [pathname]); -
Ensuring Correct Cleanup and State Management: When navigating back to the
ProductList, thedetailstate is set tonull, and the scroll position is restored without interfering with the rendering flow. -
Avoiding Duplicated Code in
ProductDetail.jsx: Ensure thatProductDetail.jsxcontains only the necessary code for displaying product details and does not duplicate theProductListlogic. Here's a simplified version ofProductDetail.jsxfor reference:'use client'; import React from 'react'; import Image from 'next/image'; import Link from 'next/link'; import { NotificationProvider } from "@/components/NotificationContext"; export default function ProductDetail({ product }) { return ( <div className="fixed inset-0 bg-white z-50 overflow-auto"> <header className="flex items-center p-4"> <Link href="/products"> <Image src="https://storage.naayiq.com/resources/arrow-left.svg" width={40} height={40} alt="back" /> </Link> <h2 className="text-2xl ml-4">{product.name}</h2> </header> <main className="p-4"> {/* Render product details here */} <Image src={product.images[0]} width={300} height={300} alt={product.name} /> <p>{formatPrice(product.cheapestPrice)}</p> {/* Add more details as needed */} </main> </div> ); } const formatPrice = (price) => { if (price == null || price === Infinity) return 'N/A'; return `${price >= 10000 ? price.toLocaleString() : price} IQD`; };
Additional Recommendations:
-
Use Modals for Detail Views: Consider using a modal for displaying
ProductDetail. This approach can simplify navigation and prevent scroll issues since the background content remains in place. -
Leverage Next.js's
useEffectanduseLayoutEffect: Depending on the timing of scroll restoration, you might need to useuseLayoutEffectto ensure that the scroll position is set before the browser paints the updated view. -
Check for Component Re-renders: Ensure that unnecessary re-renders are minimized, as they can contribute to flickering or unexpected scroll behavior.
By implementing these changes, you should experience smoother navigation between
ProductListandProductDetailwithout the unwanted scroll jumps. -