Skip to content

Commit 5adc494

Browse files
authored
Merge pull request #9766 from iobuhov/datagrid-3.0-docs
[WC-2966] Update docs for data grid v3
2 parents cefd488 + 381d34c commit 5adc494

File tree

6 files changed

+545
-77
lines changed

6 files changed

+545
-77
lines changed

content/en/docs/marketplace/platform-supported-content/modules/data-widgets/data-grid-2-properties.md

Lines changed: 38 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "This document describes the properties of the Data Grid 2 and thei
55
#If moving or renaming this doc file, implement a temporary redirect and let the respective team know they should update the URL in the product. See Mapping to Products for more details.
66
---
77

8-
## Introduction
8+
## Introduction
99

1010
This guide lists all the properties of the Data Grid 2 widget located inside the [Data Widgets](/appstore/modules/data-widgets/) module. Because data grids also contain columns and rows, properties for those [columns](#columns) and [rows](#rows) are also described below.
1111

@@ -51,6 +51,12 @@ This property is available only when **Selection method** is set to **Checkbox**
5151

5252
When set to **Yes**, the data grid displays a checkbox in the header that, when selected, selects all visible rows. Clearing it will clear the selected rows.
5353

54+
#### Loading Type
55+
56+
This property controls how loading states are displayed during data operations such as pagination, filtering, and refresh.
57+
58+
Available options include spinner (rotating overlay) and skeleton (placeholder content). Loading indicators automatically appear during initial data load, pagination navigation, filter operations, sorting, and export operations. The system includes smart timing to prevent flickering on fast operations, and also provides appropriate timeout handling for slow operations.
59+
5460
### Columns Tab {#columns}
5561

5662
#### Columns
@@ -77,7 +83,13 @@ When the property is set to **Virtual scrolling**, then the navigation buttons a
7783

7884
#### Show Paging Buttons
7985

80-
This property controls the visibility of navigation buttons. If set to "Auto", navigation buttons are only visible when the number of elements in the data source exceeds the page size.
86+
This property controls the visibility of navigation buttons. If set to **Auto**, navigation buttons are only visible when the number of elements in the data source exceeds the page size.
87+
88+
#### Show Number of Rows
89+
90+
This property displays the total number of rows in the pagination area, providing users with context about the dataset size.
91+
92+
When enabled, it shows information such as **1 to 20 of 150**. It works with virtual scrolling, load more pagination, and standard pagination modes. On large datasets, the total count calculation may impact initial load time.
8193

8294
#### Empty List Message
8395

@@ -91,7 +103,7 @@ An expression that returns the CSS class for the row. The data source entity is
91103

92104
#### On Click Trigger
93105

94-
This property determines how the click action is triggered.
106+
This property determines how the click action is triggered.
95107

96108
The default option is **Single click**, which triggers the action on a single click on a row. If set to **Double click**, the action is triggered when the row is double-clicked.
97109

@@ -103,6 +115,12 @@ This property sets the action to be performed when the row is clicked.
103115

104116
This property sets the action to be performed when the row is selected or unselected.
105117

118+
#### Filters {#filters-placeholder}
119+
120+
This placeholder acts as a container for filter widgets that operate on the entire grid. This placeholder provides a designated area for placing filter widgets (text filter, date filter, number filter, drop-down filter) that filter across all grid data rather than being limited to individual columns.
121+
122+
Filter widgets placed here automatically link to the grid's datasource, and changes immediately affect the grid data. Still, widgets should be configured to work properly. Multiple filters work together using **AND** logic by default.
123+
106124
### Column Capabilities Tab
107125

108126
#### Sorting
@@ -123,6 +141,12 @@ This flag controls column hiding for the entire data grid. If set to **No**, the
123141

124142
### Configuration Tab
125143

144+
#### Store Filters in Personalization
145+
146+
This property controls whether filter states are saved as part of user personalization settings or not. When enabled, the system preserves filter input values, selected filter types, applied filter combinations, filter visibility states, and custom filter configurations in the user's personalization profile.
147+
148+
Filter states can be stored in browser localStorage or database attributes depending on personalization configuration. When enabled, users' filter preferences persist across sessions and page refreshes. When disabled, filters reset to default values on every page load — useful for shared screens, dashboards, or public interfaces.
149+
126150
#### Attribute
127151

128152
This property sets the entity attribute that is used to store custom visual settings for the data grid.
@@ -133,12 +157,8 @@ This property sets the action to be performed when the **Attribute** value is ch
133157

134158
### Grid Wide Filtering
135159

136-
#### Filters
137-
138-
A list of filters that can be used in the header of the data grid. Each filter defines an attribute that is used as part of a joined query to select data from the data source.
139-
140-
{{% alert color="info" %}}
141-
This property requires advanced knowledge of data grid widget. Please read [Grid Wide Filtering](/appstore/modules/data-grid-2/#grid-wide-filtering) and view its examples for additional guidance.
160+
{{% alert color="warning" %}}
161+
Grid Wide Filtering has been deprecated and removed. Use the [Filters Placeholder](#filters-placeholder) along with dedicated filter widgets ([Text Filter](/appstore/modules/datagrid-text-filter/), [Date Filter](/appstore/modules/datagrid-date-filter/), [Number Filter](/appstore/modules/datagrid-number-filter/), and [Dropdown Filter](/appstore/modules/datagrid-dropdown-filter/)) for filtering functionality.
142162
{{% /alert %}}
143163

144164
### Aria Labels
@@ -159,6 +179,12 @@ Defines a string value that labels the cancel export button of the export dialog
159179

160180
Defines a string value that labels the checkbox of the row when the selection is enabled. Used by assistive technologies and screen readers.
161181

182+
#### Select All Rows
183+
184+
This property provides an ARIA label for the **Select All** checkbox in the grid header. This ARIA label is announced by screen readers when users navigate to the select all checkbox.
185+
186+
The label integrates with three-state checkbox functionality (unchecked, checked, indeterminate) and supports localization through text templates. Screen readers announce appropriate state changes when the checkbox is toggled, improving accessibility compliance for bulk-selection operations.
187+
162188
## Column Properties {#column-properties}
163189

164190
You can easily see these properties by opening up the property dialog box of Data Grid 2, then clicking **Columns** > **New**.
@@ -183,18 +209,6 @@ Text to be displayed in the column header.
183209

184210
Text to display when hovering over column header.
185211

186-
#### Reference
187-
188-
This property is used to select the reference entity that can be used for association filtering. Useful only in conjunction with the dropdown filter widget.
189-
190-
#### Data Source
191-
192-
A data source that should return a list of entities selected in the reference property. All items in this list will be available in the dropdown filter.
193-
194-
#### Option Caption
195-
196-
An expression used to create a caption for each reference. This text is then visible as an option in the dropdown filter.
197-
198212
#### Visible
199213

200214
A Boolean expression that controls the visibility of columns in the data grid. If the expression returns **false**, then the column is hidden and remains hidden unless the expression value is changed to **true**.
@@ -215,9 +229,9 @@ If set to **Yes**, then the column position in the grid can be changed by the us
215229

216230
#### Can Hide
217231

218-
If set to **Yes**, the column can be hidden in the view settings.
232+
If set to **Yes**, the column can be hidden in the view settings.
219233

220-
If hidden by default, column is hidden on first render and can be shown using view settings.
234+
If hidden by default, column is hidden on first render and can be shown using view settings.
221235

222236
If set to **No**, column cannot be hidden in view settings.
223237

@@ -227,7 +241,7 @@ If set to **No**, column cannot be hidden in view settings.
227241

228242
This property controls how the column width is calculated.
229243

230-
**Auto-fill** fills the available space. **Auto-fit content** uses just enough space to display the column content. **Manual** is used to set the number for the flex-grow CSS property.
244+
**Auto-fill** fills the available space. **Auto-fit content** uses just enough space to display the column content. **Manual** is used to set the number for the flex-grow CSS property.
231245

232246
#### Alignment
233247

0 commit comments

Comments
 (0)