diff --git a/docs/source/pagination/core-api.mdx b/docs/source/pagination/core-api.mdx index d7e81ce3843..3005e044c23 100644 --- a/docs/source/pagination/core-api.mdx +++ b/docs/source/pagination/core-api.mdx @@ -3,6 +3,8 @@ title: Core pagination API description: Fetching and caching paginated results --- +> **Note:** The pagination helper functions provided by Apollo Client (such as `offsetLimitPagination` and `relayStylePagination`) are mostly examples of how to implement a type policy for paginated fields. In most cases, you will need to copy these helpers into your own codebase and adjust them to your requirements. + Regardless of which pagination strategy your GraphQL server uses for a particular list field, your Apollo Client app needs to do the following to query that field effectively: * Call the [`fetchMore` function](#the-fetchmore-function) to fetch the next page of results when needed diff --git a/docs/source/pagination/cursor-based.mdx b/docs/source/pagination/cursor-based.mdx index 3755f9965c4..f33f4c02c24 100644 --- a/docs/source/pagination/cursor-based.mdx +++ b/docs/source/pagination/cursor-based.mdx @@ -2,6 +2,8 @@ title: Cursor-based pagination --- +> **Note:** The pagination helper functions provided by Apollo Client, such as `relayStylePagination`, are primarily examples of how to implement a type policy for paginated fields. In most cases, you will need to copy these helpers into your own codebase and adjust them to fit your specific requirements and API schema. + > We recommend reading [Core pagination API](./core-api) before learning about considerations specific to cursor-based pagination. ## Using list element IDs as cursors diff --git a/docs/source/pagination/offset-based.mdx b/docs/source/pagination/offset-based.mdx index 6f3c4b27f3e..f1a9ea28356 100644 --- a/docs/source/pagination/offset-based.mdx +++ b/docs/source/pagination/offset-based.mdx @@ -2,6 +2,8 @@ title: Offset-based pagination --- +> **Note:** The pagination helper functions provided by Apollo Client, such as `offsetLimitPagination`, are primarily examples of how to implement a type policy for paginated fields. In most cases, you will need to copy these helpers into your own codebase and adjust them to fit your specific requirements and API schema. + > We recommend reading [Core pagination API](./core-api) before learning about considerations specific to offset-based pagination. With offset-based pagination, a list field accepts an `offset` argument that indicates _where in the list_ the server should start when returning items for a particular query. The field usually also accepts a `limit` argument that indicates the _maximum_ number of items to return: