Listing (grid) component
Listing is a basic component that implements grids, lists, and tiles with filtering, pagination, sorting, and other features.
Examples
Create an instance
Example configuration of Listing component instance:
<your module root dir>/Magento/Cms/view/adminhtml/ui_component/cms_page_listing.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<listing xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
<argument name="context" xsi:type="configurableObject">
<argument name="class" xsi:type="string">Magento\Framework\View\Element\UiComponent\Context</argument>
<argument name="namespace" xsi:type="string">cms_page_listing</argument>
</argument>
<argument name="data" xsi:type="array">
<item name="js_config" xsi:type="array">
<item name="config" xsi:type="array">
<item name="provider" xsi:type="string">cms_page_listing.cms_page_listing_data_source</item>
</item>
<item name="deps" xsi:type="string">cms_page_listing.cms_page_listing_data_source</item>
</item>
<item name="spinner" xsi:type="string">cms_page_columns</item>
<item name="buttons" xsi:type="array">
<item name="add" xsi:type="array">
<item name="name" xsi:type="string">add</item>
<item name="label" xsi:type="string" translate="true">Add New Page</item>
<item name="class" xsi:type="string">primary</item>
<item name="url" xsi:type="string">*/*/new</item>
</item>
</item>
</argument>
</listing>
Configure DataSource
DataSource is another UI component that provides data in specific format which is shared among all UI components.
The listing component requires the data source to be properly configured and associated with it:
<your module root dir>/Magento/Cms/view/adminhtml/ui_component/cms_page_listing.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<listing xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
<dataSource name="cms_page_listing_data_source">
<argument name="dataProvider" xsi:type="configurableObject">
<argument name="class" xsi:type="string">Magento\Cms\Ui\Component\DataProvider</argument>
<argument name="name" xsi:type="string">cms_page_listing_data_source</argument>
<argument name="primaryFieldName" xsi:type="string">page_id</argument>
<argument name="requestFieldName" xsi:type="string">id</argument>
<argument name="data" xsi:type="array">
<item name="config" xsi:type="array">
<item name="component" xsi:type="string">Magento_Ui/js/grid/provider</item>
<item name="update_url" xsi:type="url" path="mui/index/render"/>
<item name="storageConfig" xsi:type="array">
<item name="indexField" xsi:type="string">page_id</item>
</item>
</item>
</argument>
</argument>
</dataSource>
</listing>
Source files
