---
title: "paginate"

doc_type: static
doc_category: static
doc_version: v20270301
source_url:
  html: 'https://developer.shopline.com/zh-hans-cn/docs/sline/object/paginate'
  md: 'https://developer.shopline.com/zh-hans-cn/docs/sline/object/paginate.md'
---

# paginate


    一组分页信息，可用于构建分页导航和展示页面数据。

    



## 属性

    <div>
    

        
<ObjectProperty
    name="parts"
    types={[<Mdx>array of [part](https://developer.shopline.com/zh-hans-cn/docs/sline/object/part.md)</Mdx>]}
>
<ObjectSummary>
分页部件，用于构建分页导航。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="list"
    types={[<Mdx>array of any</Mdx>]}
>
<ObjectSummary>
当前页的数据列表。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="current_offset"
    types={[<Mdx>integer</Mdx>]}
>
<ObjectSummary>
当前页之前所有页面已显示的项目总数。

例如，如果每页显示 5 个项目且当前页为第 3 页，则 `paginate.current_offset` 返回 `10`。
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="current_page"
    types={[<Mdx>integer</Mdx>]}
>
<ObjectSummary>
当前页的页码。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="items"
    types={[<Mdx>integer</Mdx>]}
>
<ObjectSummary>
所有页面显示的项目总数。

例如，如果你对一个共包含 120 个商品的集合进行分页，则 `paginate.items` 返回 `120`。
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="page_param"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
表示分页的 URL 参数。

默认值：`page`
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="page_size"
    types={[<Mdx>integer</Mdx>]}
>
<ObjectSummary>
每页显示的项目数。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="pages"
    types={[<Mdx>integer</Mdx>]}
>
<ObjectSummary>
总页数。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="previous"
    types={[<Mdx>[part](https://developer.shopline.com/zh-hans-cn/docs/sline/object/part.md)</Mdx>]}
>
<ObjectSummary>
用于跳转到上一页的分页部件。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="next"
    types={[<Mdx>[part](https://developer.shopline.com/zh-hans-cn/docs/sline/object/part.md)</Mdx>]}
>
<ObjectSummary>
用于跳转到下一页的分页部件。


</ObjectSummary>
</ObjectProperty>
        
    
    </div>



    
## 例子

        
            

            以下示例通过 [get_product_pagination](https://developer.shopline.com/zh-hans-cn/docs/sline/filter/get-product-pagination.md) filter 获取店铺内的一组商品，返回一个 `paginate` object。

            

            
<SlineExample path={'/collections/all'} objects={ 
    [""] 
}>
```sline
{{#var paginate = collection | get_product_pagination(5) /}}
{{#for product in paginate.list}}
  {{#link_to product.url}}
    {{product.title}}
  {{/link_to}}
{{/for}}
```
</SlineExample>
            
        
    
