paginate オブジェクト

{
  "access": {
    "global": false,
    "parents": [],
    "template": []
  },
  "deprecated": false,
  "deprecation_reason": "",
  "description": "> Tip:\n> Use the [`default_pagination` filter](/docs/api/liquid/filters/default_pagination) to output pagination links.",
  "properties": [
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "Limited to 250.",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The number of items displayed per page.",
      "name": "page_size"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "For example, if you show 5 items per page and are on page 3, then the value of `paginate.current_offset` is 10.\n\nLimited to 24,999 see [Pagination Limits](/themes/best-practices/performance/platform#pagination-limits) for more information.",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The total number of items on pages previous to the current page.",
      "name": "current_offset"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "Limited to 25,000 see [Pagination Limits](/themes/best-practices/performance/platform#pagination-limits) for more information.",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The page number of the current page.",
      "name": "current_page"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "For example, if you paginate a collection of 120 products, then the value of `paginate.items` is 120.\n\nLimited to 25,000 see [Pagination Limits](/themes/best-practices/performance/platform#pagination-limits) for more information.",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The total number of items to be paginated.",
      "name": "items"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "Pagination parts are used to build pagination navigation.",
      "examples": [],
      "return_type": [
        {
          "type": "array",
          "name": "",
          "description": "",
          "array_value": "part"
        }
      ],
      "summary": "The pagination parts.",
      "name": "parts"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "part",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The pagination part to go to the next page.",
      "name": "next"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "part",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The pagination part to go to the previous page.",
      "name": "previous"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "Limited to 25,000 see [Pagination Limits](/themes/best-practices/performance/platform#pagination-limits) for more information.",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The total number of pages.",
      "name": "pages"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "The default value is `page`.\n\nIf you paginate over an array defined in a setting or a metafield list type, then a unique key is appended to page to allow the paginated list to\noperate independently from other lists on the page. For example, a paginated list defined in a setting might use the key\n`page_a9e329dc`.",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The URL parameter denoting the pagination.",
      "name": "page_param"
    }
  ],
  "summary": "Information about the pagination inside a set of [`paginate` tags](/docs/api/liquid/tags/paginate).",
  "name": "paginate",
  "examples": [],
  "json_data": {
    "path": "",
    "handle": "",
    "data_from_file": "{\"current_offset\":10,\"current_page\":3,\"items\":17,\"next\":{},\"page_param\":\"page\",\"page_size\":5,\"pages\":4,\"parts\":[],\"previous\":{}}"
  },
  "return_type": []
}