Sizes component
Overview
The Sizes component defines the maximum number of displayed records in a table (grid).
Constructor: app/code/Magento/Ui/view/base/web/js/grid/paging/sizes.js
Сonfiguration options
Extends all UiElement
configuration.
Sizes-specific configuration:
Option | Description | Type | Default Value |
---|---|---|---|
maxSize |
Maximum allowed number of rows. | Number | 20 |
minSize |
Minimun number of rows. | Number | 1 |
options |
The initial list of available table sizes (number of rows). | { [name: number]: SizeOption } |
[20, 30, 50, 100, 200] |
template |
Path to the component’s .html template. |
String | ui/grid/paging/sizes |
value |
Initial number of rows per page. | Number | 20 |
SizeOption interface
Option | Description | Type | Required |
---|---|---|---|
label |
Label displayed in the rendered options list. This label is usually equal to the corresponding value property. |
String | Number | Required |
value |
Options identifier which represents the table size. | Number | Required |