Skip to content

Commit 74385a1

Browse files
authored
Merge pull request #10283 from yordan-st/development
Create docs for Selection Helper and update Gallery
2 parents 1db02e3 + 69608cd commit 74385a1

7 files changed

Lines changed: 349 additions & 127 deletions

File tree

content/en/docs/marketplace/platform-supported-content/modules/data-widgets/_index.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,18 @@ description: "Describes the configuration and usage of the Data Widgets module,
1111

1212
This module contains the following widgets:
1313

14-
* [Data Grid 2](/appstore/modules/data-grid-2/)
15-
* [Data Grid 2 Properties](/appstore/modules/data-grid-2-properties/)
16-
* [Drop-Down Sort](/appstore/modules/gallery/#dropdown)
17-
* [Filters](/appstore/modules/data-grid-2/#filters)
18-
* [Gallery](/appstore/modules/gallery/)
19-
* [Tree node](/appstore/modules/tree-node/)
14+
- [Data Grid 2](/appstore/modules/data-grid-2/)
15+
- [Data Grid 2 Properties](/appstore/modules/data-grid-2-properties/)
16+
- [Drop-Down Sort](/appstore/modules/gallery/#dropdown)
17+
- [Filters](/appstore/modules/data-grid-2/#filters)
18+
- [Gallery](/appstore/modules/gallery/)
19+
- [Selection helper](/appstore/modules/selection-helper/)
20+
- [Tree node](/appstore/modules/tree-node/)
2021

2122
## Migration
2223

2324
If you were previously using the Data Grid 2 module, you must follow these steps before updating it to the new [Data Widgets](https://marketplace.mendix.com/link/component/116540) module:
2425

25-
1. Rename the current **DataGrid** module (under **Marketplace** modules) to *DataWidgets* in Studio Pro.
26+
1. Rename the current **DataGrid** module (under **Marketplace** modules) to _DataWidgets_ in Studio Pro.
2627
1. Open the Marketplace and search for **Data Widgets**.
2728
1. Download and replace the current (renamed) DataWidgets module.

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

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,12 @@ The time (in seconds) the grid waits between refreshing the data. Auto-refreshin
2727

2828
This property controls row selection capabilities. Selection is turned off by default, but can be enabled by choosing ether **Single** or **Multi**:
2929

30-
* The **Single** selection is selection type where only one row can be selected at the time
31-
* The **Multi** type support selecting several rows at the time
30+
- The **Single** selection is selection type where only one row can be selected at the time
31+
- The **Multi** type support selecting several rows at the time
3232

3333
{{% alert color="info" %}}
34-
Data grid currently supports only in-memory selection. This implies some limitation which allows selecting only visible rows. If you change a data grid page or reload the browser window, then selection will be cleared.{{% /alert %}}
34+
Data grid currently supports in-memory selection. When the **Keep Selection** property is disabled, selection is limited to visible rows and will be cleared when you change a data grid page or reload the browser window. When **Keep Selection** is enabled, selections persist across page navigation, data refreshes, filter operations, and sorting changes.
35+
{{% /alert %}}
3536

3637
#### Selection Method
3738

@@ -53,10 +54,30 @@ When set to **Yes**, the data grid displays a checkbox in the header that, when
5354

5455
#### Loading Type
5556

56-
This property controls how loading states are displayed during data operations such as pagination, filtering, and refresh.
57+
This property controls how loading states are displayed during data operations such as pagination, filtering, and refresh.
5758

5859
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.
5960

61+
### Behavior Tab
62+
63+
#### Selection
64+
65+
This section contains properties related to selection behavior when **Selection** is set to **Single** or **Multi**.
66+
67+
#### Keep Selection
68+
69+
{{% alert color="info" %}}
70+
This property is only available when **Selection** is set to **Single** or **Multi**.
71+
{{% /alert %}}
72+
73+
By default, this property is set to **No**, which clears the selection when the items are not in the current set of datasource items.
74+
75+
When set to **Yes**, selected items persist across page navigation, data refreshes, filter operations, and sorting changes. When enabled, selections remain active until manually cleared by the user or through a nanoflow action.
76+
77+
{{% alert color="warning" %}}
78+
**Keep Selection** cannot be used with non-persistent entities (NPEs) or view entities, as their IDs change on refresh.
79+
{{% /alert %}}
80+
6081
### Columns Tab {#columns}
6182

6283
#### Columns
@@ -87,7 +108,7 @@ This property controls the visibility of navigation buttons. If set to **Auto**,
87108

88109
#### Show Number of Rows
89110

90-
This property displays the total number of rows in the pagination area, providing users with context about the dataset size.
111+
This property displays the total number of rows in the pagination area, providing users with context about the dataset size.
91112

92113
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.
93114

@@ -115,9 +136,9 @@ This property sets the action to be performed when the row is clicked.
115136

116137
This property sets the action to be performed when the row is selected or unselected.
117138

118-
#### Filters {#filters-placeholder}
139+
#### Filters {#filters-placeholder}
119140

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.
141+
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.
121142

122143
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.
123144

@@ -143,7 +164,7 @@ This flag controls column hiding for the entire data grid. If set to **No**, the
143164

144165
#### Store Filters in Personalization
145166

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.
167+
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.
147168

148169
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.
149170

@@ -181,7 +202,7 @@ Defines a string value that labels the checkbox of the row when the selection is
181202

182203
#### Select All Rows
183204

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.
205+
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.
185206

186207
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.
187208

0 commit comments

Comments
 (0)