XWIKI-21910: Display pagination of a LiveData only if number of entries exceed 10

[Sereza7]

Jira URL

https://jira.xwiki.org/browse/XWIKI-21910

Changes

Description

• Updated both layouts to not display the pagination tools if there's only one page of entries

Clarifications

• Note that I went with the solution of hiding the pagination if the initial state of the livedata has only one page. IMO this is easier to understand for users than a cutoff at numberOfEntries=10. When merging this, I'll update the Livedata doc to make sure users can find out what's happening if they couldn't fitgure it out on their own.

Screenshots & Video

Here are what a few default flavor livedatas look like after the changes in this PR:
Menu listing

Notification preferences filters

Executed Tests

Successfully built mvn clean install -f xwiki-platform-core/xwiki-platform-livedata/xwiki-platform-livedata-webjar -Pdocker,integration-tests,quality. Made sure to not add warnings to the npm run lint.
I doubt another module integration tests using a livedata would fail since this pagination element is only removed in case it's useless.

Expected merging strategy

• Prefers squash: Yes
• Backport on branches:
  • None, master only.

[manuelleduc]

• Note that I went with the solution of hiding the pagination if the initial state of the livedata has only one page. IMO this is easier to understand for users than a cutoff at numberOfEntries=10. When merging this, I'll update the Livedata doc to make sure users can find out what's happening if they couldn't fitgure it out on their own.

Imo it shouldn't be the default behavior. Or at least it should be configurable, i.e., provide an option to allow the pagination to be hidden when there is only one page.
I'd suggest making a proposal.

[Sereza7]

Started a proposal to discuss this topic at https://forum.xwiki.org/t/deactivate-livedata-pagination-when-theres-only-one-page/14669 .

[Sereza7]

In regards to the results of the proposal, I updated the implementation:

Changes

Description

• Added a showPaginationOnSinglePage parameter to the Livedata macro.

Screenshots & Video

I ran the changes locally and got the following results:

2024-11-05.10-23-25.mp4

We can see on this video that the parameter changes the display of the livedata in the expected way. Note that there's one edge case where this might be confusing for the user. When we don't want to show the pagination on a single page and there's initially multiple pages. If we increase the size of the pages to have only one, the livedata will be reloaded and the pagination will not be available anymore. We can address this possible confusion with a small note in the documentation, IMO this is better to stay consistent here and not introduce extra logic. Moreover, I expect this parameter to be used mostly on livedatas with a known number of elements that fills up only one page or less.

Executed Tests

Successfully built mvn clean install -f xwiki-platform-core/xwiki-platform-livedata/xwiki-platform-livedata-api; mvn clean install -f xwiki-platform-core/xwiki-platform-livedata/xwiki-platform-livedata-webjar. Ran it locally with expected results on multiple livedata configurations (see manual test video above).