-
Notifications
You must be signed in to change notification settings - Fork 767
Create docs for Selection Helper and update Gallery #10283
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: development
Are you sure you want to change the base?
Conversation
| Use the Selection Helper widget when you need to provide users with efficient bulk selection capabilities in your data widgets. This is particularly useful for: | ||
|
|
||
| - **Gallery bulk operations**: Enable users to select multiple items in gallery layouts for batch processing like delete, update, or export operations | ||
| - **Data Grid 2 bulk operations**: Provide similar functionality for tabular data presentations | ||
| - **Data management workflows**: Streamline processes where users need to work with multiple records simultaneously | ||
| - **Administrative interfaces**: Provide power users with quick selection tools for managing large datasets |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure about this section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ConnorLand what do you think of this examples?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think these use cases sound too made-up. I would just leave them out completely
content/en/docs/marketplace/platform-supported-content/modules/data-widgets/selection-helper.md
Outdated
Show resolved
Hide resolved
| This property is available only when **Selection** is set to **Single** or **Multi**. | ||
| {{% /alert %}} | ||
|
|
||
| When set to **Yes**, selected items persist across page navigation, data refreshes, filter operations, and sorting changes. By default, this property is set to **No**, which clears the selection whenever the datasource changes. When enabled, selections remain active until manually cleared by the user or through a nanoflow or microflow action. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- I don't think they can be cleared by MF actions, only NF
- We should probably also add that you can't use them with NPEs and View entities because their IDs change on refresh
- lastly (comment by Marco): when set to No, it clears the selection when the items are not in the current set of datasource items.
| - The **Multi** type support selecting several rows at the time | ||
|
|
||
| {{% alert color="info" %}} | ||
| 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 %}} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should change this similarly to how it's mentioned in the Gallery that it keeps it in memory but also supports selection persistence when using keep selection
|
|
||
| ### Keep Selection | ||
|
|
||
| If this setting is enabled, then selected items persist across page navigation, data refreshes, filtering, and sorting operations. By default, Keep selection is disabled and the selection is cleared when the datasource changes. When enabled, selected items remain selected until manually cleared by the user. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should probably be consistent with DG2 disclaimer (same comments, though here it's missing that it can be changed via NF)
|
|
||
| Enabling selection allows users to select gallery items by clicking on them. Selection is disabled by default and can be activated by changing the **Selection** setting from **None** to either **Single** or **Multi**. | ||
|
|
||
| The Gallery widget keeps selected items in memory and supports selection persistence across page navigation when the **Keep selection** option is enabled. This allows users to maintain their selections while browsing through paginated data or navigating between different pages in your application. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe good to link this to the Keep selection section because of the drawbacks with having to clear it yourself
|
|
||
| Use the Selection Helper widget when you need to provide users with efficient bulk selection capabilities in your data widgets. This is particularly useful for: | ||
|
|
||
| - **Gallery bulk operations**: Enable users to select multiple items in gallery layouts for batch processing like delete, update, or export operations |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we export Gallery content? And if so, doesn't export export everything, regardless of the selection? Or do you mean someone creating logic for it? If the latter, I wouldn't mention it
| Use the Selection Helper widget when you need to provide users with efficient bulk selection capabilities in your data widgets. This is particularly useful for: | ||
|
|
||
| - **Gallery bulk operations**: Enable users to select multiple items in gallery layouts for batch processing like delete, update, or export operations | ||
| - **Data Grid 2 bulk operations**: Provide similar functionality for tabular data presentations | ||
| - **Data management workflows**: Streamline processes where users need to work with multiple records simultaneously | ||
| - **Administrative interfaces**: Provide power users with quick selection tools for managing large datasets |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think these use cases sound too made-up. I would just leave them out completely
No description provided.