UI Pagination Component
The UI pagination component is a plugin for the listing component. Responsible for rendering pagination UI and applying pagination criteria to collection.
You can configure pagination in several ways:
- Globally: using any module鈥檚
view/*/ui_component/etc/definition.xml
file. All settings declared in this file are applied to all component鈥檚 instances. - Locally: using concrete component instance configuration, such as
<your module root dir>/Magento/Cms/view/adminhtml/ui_component/cms_page_listing.xml
To enable pagination for the listing component, the pagination component is declared as a child of the listing component in component instance configuration.
Example:
<your module root dir>/Magento/Cms/view/adminhtml/ui_component/cms_page_listing.xml
<listing xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
<container name="page_listing_top">
<paging name="listing_paging">
<argument name="data" xsi:type="array">
<item name="config" xsi:type="array">
<item name="storageConfig" xsi:type="array">
<item name="provider" xsi:type="string">cms_block_listing.cms_block_listing.listing_top.bookmarks</item>
<item name="namespace" xsi:type="string">current.paging</item>
</item>
<item name="selectProvider" xsi:type="string">cms_block_listing.cms_block_listing.cms_block_columns.ids</item>
</item>
</argument>
</paging>
</container>
</listing>
The configuration of the component can include:
-
storageConfig - storageConfig is a base component property. Here it is configured to take stored page sizes list from bookmarks
- sizesConfig - configuration of sizes component
- component - component which manages available page sizes. By default it is
Magento_Ui/js/grid/paging/sizes
- component - component which manages available page sizes. By default it is
- selectProvider - component with selections data
Find us on