---
title: "ConvexPaginatedQuery"
description: "Reference for the Nuxt renderless component that wraps useConvexPaginatedQuery."
canonical_url: "https://nuxt-convex.onmax.me/api-reference/convex-paginated-query"
---
# ConvexPaginatedQuery

> Reference for the Nuxt renderless component that wraps useConvexPaginatedQuery.

`ConvexPaginatedQuery` is the Nuxt renderless component for paginated query feeds. Like any Nuxt component, it's auto-imported where you use it.

## Example

```vue [app/pages/tasks.vue]
<script setup lang="ts">
import { api } from '#convex/api'
</script>

<template>
  <ConvexPaginatedQuery
    :query="api.tasks.paginated"
    :args="{ status: 'open' }"
    :options="{ numItems: 20 }"
  >
    <template #loading>
      Loading...
    </template>

    <template #error="{ error, reset }">
      <button @click="reset">
        Retry
      </button>
      {{ error.message }}
    </template>

    <template #default="{ data, loadMore, isDone, isLoadingMore }">
      <ul>
        <li v-for="task in data" :key="task._id">
          {{ task.title }}
        </li>
      </ul>

      <button :disabled="isDone || isLoadingMore" @click="loadMore()">
        Load more
      </button>
    </template>
  </ConvexPaginatedQuery>
</template>
```

## Props

<table>
<thead>
  <tr>
    <th>
      Prop
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Meaning
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        query
      </code>
    </td>
    
    <td>
      <code>
        FunctionReference<'query'>
      </code>
    </td>
    
    <td>
      Paginated query reference
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        args
      </code>
    </td>
    
    <td>
      <code>
        Omit<FunctionArgs<Query>, 'paginationOpts'> | 'skip'
      </code>
    </td>
    
    <td>
      Query args, reactive
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        options
      </code>
    </td>
    
    <td>
      <code>
        UseConvexPaginatedQueryOptions
      </code>
    </td>
    
    <td>
      Pagination options, default <code>
        { numItems: 10 }
      </code>
      
      , read once
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        suspense
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      Waits for the first page before rendering on the client too
    </td>
  </tr>
</tbody>
</table>

## Slots

- `loading`
- `error`
- `empty`
- `default`

## Behavior

- Uses `useConvexPaginatedQuery` internally
- On the server, fetches the first page (unless `options.server` is `false`) and hydrates it
- The `default` slot receives `data`, `isDone`, `isLoadingMore`, `loadMore` and `reset`
- Treats an empty data array as the empty state

## Related pages

- [useConvexPaginatedQuery](https://nuxt-convex.onmax.me/api-reference/use-convex-paginated-query)


## Sitemap

See the full [sitemap](https://nuxt-convex.onmax.me/sitemap.md) for all pages.
