The Storefront API limits how many items can be queried at once. This encourages better app performance by only querying what's immediately necessary to render the page.
However, sometimes you might have long lists of products, collections, or orders. Rather than rendering every item in the list, for better performance you should only render one page at a time. The [Storefront API uses cursors](https://shopify.dev/docs/api/usage/pagination-graphql) to paginate through lists of data and the [`Pagination` component](/docs/api/hydrogen/latest/components/pagination) enables you to render those pages.
It's important to maintain the pagination state in the URL for the following reasons:
- Users can navigate to a product and return back to the same scrolled position in a list.
- The list state is shareable by URL.
- Search engine crawlers are also able to index the pages when the pagination state is stored in the URL,
To set up pagination inside your app, do the following tasks:
## Setup the paginated query
First, set up a GraphQL query to the [Storefront API](/docs/api/storefront) to return paginated content. A query needs to have the arguments `first`, `last`, `startCursor`, and `endCursor`.
The query response needs to include `pageInfo` with `hasPreviousPage`, `hasNextPage`, `startCursor`, and `endCursor` passed to it.
```js
const PRODUCT_CARD_FRAGMENT = `#graphql
fragment ProductCard on Product {
id
title
publishedAt
handle
vendor
variants(first: 1) {
nodes {
id
image {
url
altText
width
height
}
price {
amount
currencyCode
}
compareAtPrice {
amount
currencyCode
}
selectedOptions {
name
value
}
product {
handle
title
}
}
}
}
`;
const ALL_PRODUCTS_QUERY = `#graphql
query AllProducts(
$first: Int
$last: Int
$startCursor: String
$endCursor: String
) {
products(first: $first, last: $last, before: $startCursor, after: $endCursor) {
nodes {
...ProductCard
}
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
}
}
${PRODUCT_CARD_FRAGMENT}
`;
```
Hydrogen provides the utility [`getPaginationVariables`](/docs/api/hydrogen/latest/utilities/getpaginationvariables) to help calculate these variables from URL parameters. We recommend using the utility to pass the variables to the query within your loader:
```js
import {getPaginationVariables} from '@shopify/hydrogen';
import {json} from '@shopify/remix-oxygen';
export async function loader({context, request}) {
const variables = getPaginationVariables(request, {
pageBy: 4,
});
const {products} = await context.storefront.query(ALL_PRODUCTS_QUERY, {
variables,
});
return json({
products,
});
}
```
## Render the `Pagination` component
Pass the entire query connection to the `Pagination` component. The component provides a `render` prop with all the nodes in the list. Map the nodes by product ID and render them.
```jsx
import { Pagination } from "@shopify/hydrogen";
import { useLoaderData, Link } from "@remix-run/react";
export default function () {
const { products } = useLoaderData();
return (
{({ nodes }) => {
return nodes.map((product) => (
{product.title}
));
}}
);
}
```
The `Pagination` component's render prop provides convenience links to either load more or previous product pages from nodes:
```jsx
import { Pagination } from "@shopify/hydrogen";
import { useLoaderData, Link } from "@remix-run/react";
export default function () {
const { products } = useLoaderData();
return (
{({ nodes, NextLink, PreviousLink, isLoading }) => (
<>
{isLoading ? "Loading..." : "Load previous products"}
{nodes.map((product) => (
{product.title}
))}
{isLoading ? "Loading..." : "Load next products"}
>
)}
);
}
```
## Complete pagination example
The following is a complete example of data fetching using pagination:
```jsx
import {getPaginationVariables, Pagination} from '@shopify/hydrogen';
import {useLoaderData, Link} from '@remix-run/react';
import {json} from '@shopify/remix-oxygen';
export async function loader({context, request}) {
const variables = getPaginationVariables(request, {
pageBy: 4,
});
const {products} = await context.storefront.query(ALL_PRODUCTS_QUERY, {
variables,
});
return json({
products,
});
}
export default function () {
const {products} = useLoaderData();
return (
{({nodes, NextLink, PreviousLink, isLoading}) => (
<>
{isLoading ? 'Loading...' : 'Load previous products'}
{nodes.map((product) => (
{product.title}
))}
{isLoading ? 'Loading...' : 'Load next products'}
>
)}
);
}
const PRODUCT_CARD_FRAGMENT = `#graphql
fragment ProductCard on Product {
id
title
publishedAt
handle
vendor
variants(first: 1) {
nodes {
id
image {
url
altText
width
height
}
price {
amount
currencyCode
}
compareAtPrice {
amount
currencyCode
}
selectedOptions {
name
value
}
product {
handle
title
}
}
}
}
`;
const ALL_PRODUCTS_QUERY = `#graphql
query AllProducts(
$first: Int
$last: Int
$startCursor: String
$endCursor: String
) {
products(first: $first, last: $last, before: $startCursor, after: $endCursor) {
nodes {
...ProductCard
}
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
}
}
${PRODUCT_CARD_FRAGMENT}
`;
```
## Automatically load pages on scroll
We can change the implementation to support loading subsequent pages on scroll. Add the dependency `react-intersection-observer` and use the following example:
```jsx
import { Pagination } from "@shopify/hydrogen";
import { useEffect } from "react";
import { useLoaderData, useNavigate } from "@remix-run/react";
import { useInView } from "react-intersection-observer";
export default function () {
const { products } = useLoaderData();
const { ref, inView, entry } = useInView();
return (
{({ nodes, NextLink, hasNextPage, nextPageUrl, state }) => (
<>
Load more
>
)}
);
}
function ProductsLoadedOnScroll({ nodes, inView, hasNextPage, nextPageUrl, state }) {
const navigate = useNavigate();
useEffect(() => {
if (inView && hasNextPage) {
navigate(nextPageUrl, {
replace: true,
preventScrollReset: true,
state,
});
}
}, [inView, navigate, state, nextPageUrl, hasNextPage]);
return nodes.map((product) => (
{product.title}
));
}
```