Add current page parameter to the route in the listing and search block pagination #4159

bipoza · 2022-12-21T10:48:14Z

Added the current page parameter to the route in the listing and search block pagination.

Fixes: #3868

Demo with listing block

volto_listing_blcok_pagination.mov

Demo with search block

volto_pagination_with_searchblock.mov

Demo combining multiple lists

volto-multiple-blocks-with-pagination.mov

QueryString compatibility:

To be able to combine the searchBlock with the pagination parameters, we had to change the parameters of the searchBlock from hash to search (# -> ?).

We are contemplating the possibility of maintaining both types of routes so as not to generate a breaking change.

In general the compatibility is good except for a small error in the design of the SearchInput. With the old hash url, the clear icon does not render well, although the functionality is correct.

search_block_with_hash_compatibility.mov

…nd Search block

netlify · 2022-12-21T10:48:18Z

✅ Deploy Preview for volto canceled.

Name	Link
🔨 Latest commit	`8b264cb`
🔍 Latest deploy log	https://app.netlify.com/sites/volto/deploys/642d810159f71500089f0c86

cypress · 2022-12-21T10:54:32Z

Passing run #4926 ↗︎

0	489	20	0	0

Details:

Merge branch 'master' into pagination-with-router-params
Project: Volto	Commit: `e04278e86f`
Status: Passed	Duration: 14:49 💡
Started: Apr 14, 2023 8:26 AM	Ended: Apr 14, 2023 8:41 AM

_{This comment has been generated by cypress-bot as a result of this
project's GitHub integration settings.}

…one/volto into pagination-with-router-params

ionlizarazu · 2022-12-21T20:12:15Z

The bug you mention exists in the current (16.4.0) Volto version

sneridagh · 2023-02-16T15:37:30Z

@bipoza @erral wow! thanks for working in this. I know is specially difficult to accomplish. How are we maintaining the sync with the state-URL? I know this is a major pain point. Could we have unit tests for this feature? How about acceptance tests?

What we are trying to accomplish here is quite complex and I'd like to discuss this in the next Volto Team meeting with the team, and specially @tiberiuichim who tried to implement this in the past.

I'd like to get this well, specially agree on the format and serialization of the URL query parameters, because if we have to change them in the future for whatever reason, it will force a breaking change (people having saved URLs as bookmarks, etc)

erral · 2023-03-24T07:50:42Z

We have seen that we have a bug in the search block with this PR.

We are preparing a fix and some tests to improve the PR.

tiberiuichim · 2023-03-30T12:08:17Z

src/helpers/Utils/usePagination.js

@@ -24,26 +27,29 @@ const useCreatePageQueryStringKey = (id) => {
 * A pagination helper that tracks the query and resets pagination in case the
 * query changes.
 */
-export const usePagination = (id = null, defaultPage = 1) => {
+export const usePagination = (blockId = null, defaultPage = '1') => {


I'd think we should stick to a generic id rather then blockId and a number for the defaultPage.

You mean the "blockId" naming or something else?

…ead of '1'

ionlizarazu · 2023-03-31T11:21:54Z

We have written some tests for the usePagination.js file

erral · 2023-04-02T18:33:22Z

@sneridagh we think this is ready

* master: (67 commits) Add current page parameter to the route in the listing and search block pagination (#4159) Fixed wrong localization on password reset page(#4656) (#4657) Release notes for 16.19.0 (#4655) Razzle upgrade notice in upgrade guide (#4641) Release generate-volto 7.0.0-alpha.3 Update to latest Razzle - needed since #3997. This fixes the duplicated Razzles issue (#4640) 3092 improve spellcheck (#4633) developer process for first time contributing (#4617) Trigger CI on pull_request event (#4629) Pining of `pydata-sphinx-theme` and `sphinx-book-theme`, CI is complaining. (#4626) Set sameSite in `18N_LANGUAGE` cookie (#4627) Update simple-git (#4546) DefaultView (blocks disabled): Show field name as tip on hover of label (#4598) Fix regexp that checks valid URLs and improve tests (#4601) Release 17.0.0-alpha.3 Update changelog relese 16.18.0 (#4596) InternalURl helper method should incorporate externalRoutes settings … (#4560) Update message Add-on control panel (#4574) Fix video warnings link errors (#4578) Using Vale in CI for spellcheck (#4423) ...

* master: (326 commits) Make URL a literal string to fix broken link (#4667) Move developer guidelines to contributing #4665 (#4666) Update Volto contributing to align with and refer to the new Plone co… (#4634) Release @plone/scripts 3.0.0 Changelog Added querystring search get option (#4658) Add current page parameter to the route in the listing and search block pagination (#4159) Fixed wrong localization on password reset page(#4656) (#4657) Release notes for 16.19.0 (#4655) Razzle upgrade notice in upgrade guide (#4641) Release generate-volto 7.0.0-alpha.3 Update to latest Razzle - needed since #3997. This fixes the duplicated Razzles issue (#4640) 3092 improve spellcheck (#4633) developer process for first time contributing (#4617) Trigger CI on pull_request event (#4629) Pining of `pydata-sphinx-theme` and `sphinx-book-theme`, CI is complaining. (#4626) Set sameSite in `18N_LANGUAGE` cookie (#4627) Update simple-git (#4546) DefaultView (blocks disabled): Show field name as tip on hover of label (#4598) Fix regexp that checks valid URLs and improve tests (#4601) ...

…ck pagination (#4159) Co-authored-by: Mikel Larreategi <mlarreategi@codesyntax.com> Co-authored-by: Víctor Fernández de Alba <sneridagh@gmail.com> Co-authored-by: ionlizarazu <ilizarazu@codesyntax.com>

…arch block pagination (#4159)" This reverts commit c40e772.

…arch block pagination (#4159)" (#4695)

* master: (22 commits) Release changelog notes for 16.20.1 Release 17.0.0-alpha.5 Generate a split sitemap (also fix robots.txt) (#4639) Fix search block in edit mode re-queries multiple blocks with an empty search text (#4694) Fix Move to top of folder ordering in folder content view (#4691) Changelog Revert "Add current page parameter to the route in the listing and search block pagination (#4159)" (#4695) Release generate-volto 7.0.0-alpha.4 Force the resolution of the `react-error-overlay` package to `6.0.9` (#4687) Fix training links (#4635) Release 17.0.0-alpha.4 Release changelog notes for 16.20.0 (#4684) Update to latest backend versions (#4682) Support RelationList field with StaticCatalogVocabulary and SelectWidget. (#4614) Load a theme via a `theme` key in `volto.config.js` or in `package.json` (#4625) docs: improve creating view documentation (#4636) fix sitemap.xml.gz is not compressed #4622 (v2) (#4663) Make URL a literal string to fix broken link (#4667) Move developer guidelines to contributing #4665 (#4666) Update Volto contributing to align with and refer to the new Plone co… (#4634) ...

Fixes: #3868 - Added the current page parameter in route in Listing a…

deb5988

…nd Search block

Merge branch 'master' into pagination-with-router-params

76da8e7

bipoza added 6 commits December 21, 2022 17:42

Documentation improvements

7115d8f

Added support for multiple paginations

dd88b26

Merge branch 'pagination-with-router-params' of https://github.com/pl…

386d340

…one/volto into pagination-with-router-params

usePagination code refactoring

fb04de8

Added unit test

5f18384

Added changelog

0ca3316

bipoza changed the title ~~WIP: Added current page parameter to route in listing and search block~~ WIP: Added the current page parameter to the route in the listing and search block pagination Dec 21, 2022

bipoza requested a review from erral December 21, 2022 18:46

Merge branch 'master' into pagination-with-router-params

b9d518a

erral changed the title ~~WIP: Added the current page parameter to the route in the listing and search block pagination~~ Added the current page parameter to the route in the listing and search block pagination Dec 21, 2022

erral changed the title ~~Added the current page parameter to the route in the listing and search block pagination~~ Add current page parameter to the route in the listing and search block pagination Dec 21, 2022

erral requested review from tiberiuichim and sneridagh December 22, 2022 06:58

erral approved these changes Dec 22, 2022

View reviewed changes

erral and others added 2 commits January 9, 2023 13:45

Merge branch 'master' into pagination-with-router-params

ab87619

Merge branch 'master' into pagination-with-router-params

e0b7b1a

bipoza assigned sneridagh Feb 1, 2023

Merge branch 'master' into pagination-with-router-params

34ee368

bipoza assigned tiberiuichim Feb 1, 2023

bipoza and others added 4 commits February 3, 2023 12:05

Merge branch 'master' into pagination-with-router-params

4effc3d

Merge branch 'master' into pagination-with-router-params

7c4be39

Merge branch 'master' into pagination-with-router-params

b1e86d5

Merge branch 'master' into pagination-with-router-params

ca3c116

Merge branch 'master' into pagination-with-router-params

e59f19b

bipoza added 4 commits March 29, 2023 08:50

Merge branch 'master' into pagination-with-router-params

8fd8b74

fixed the bug when combining the search block with the pagination

a7b3cc9

usePagination jest tests

bdc850d

eslist

3d54c67

tiberiuichim reviewed Mar 30, 2023

View reviewed changes

sneridagh mentioned this pull request Mar 30, 2023

Querystring Search Performance plone/plone.restapi#1252

Closed

7 tasks

ionlizarazu added 4 commits March 30, 2023 16:53

rename the blockId param to id and the defaultPage param to be 1 inst…

015572f

…ead of '1'

fix and add tests for usePagination.js

cc9b1cd

Merge branch 'master' into pagination-with-router-params

5e20cd3

changelog

88b2ae5

Merge branch 'master' into pagination-with-router-params

e04278e

Merge branch 'master' into pagination-with-router-params

205457a

sneridagh approved these changes Apr 5, 2023

View reviewed changes

erral added 2 commits April 5, 2023 12:24

Merge branch 'master' into pagination-with-router-params

09b69ff

Merge branch 'master' into pagination-with-router-params

8b264cb

sneridagh merged commit c40e772 into master Apr 5, 2023

sneridagh deleted the pagination-with-router-params branch April 5, 2023 15:56

This was referenced Apr 11, 2023

Add current page parameter to the route in the listing and search blo… #4673

Merged

A querystring appearing in the URL after accessing a page with a listing/search block #4692

Closed

sneridagh added a commit that referenced this pull request Apr 13, 2023

Revert "Add current page parameter to the route in the listing and se…

78dbc0a

…arch block pagination (#4159)" This reverts commit c40e772.

sneridagh added a commit that referenced this pull request Apr 14, 2023

Revert "Add current page parameter to the route in the listing and se…

7a3c07c

…arch block pagination (#4159)" (#4695)

sneridagh added a commit that referenced this pull request Apr 14, 2023

Revert "Add current page parameter to the route in the listing and se…

0173393

…arch block pagination (#4159)" (#4695)

sneridagh mentioned this pull request Apr 14, 2023

Revert "Add current page parameter to the route in the listing and se… #4696

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add current page parameter to the route in the listing and search block pagination #4159

Add current page parameter to the route in the listing and search block pagination #4159

bipoza commented Dec 21, 2022 •

edited

Loading

netlify bot commented Dec 21, 2022 •

edited

Loading

cypress bot commented Dec 21, 2022 •

edited

Loading

ionlizarazu commented Dec 21, 2022

sneridagh commented Feb 16, 2023

erral commented Mar 24, 2023

tiberiuichim Mar 30, 2023

ionlizarazu Mar 30, 2023

ionlizarazu commented Mar 31, 2023

erral commented Apr 2, 2023

Add current page parameter to the route in the listing and search block pagination #4159

Add current page parameter to the route in the listing and search block pagination #4159

Conversation

bipoza commented Dec 21, 2022 • edited Loading

Demo with listing block

Demo with search block

Demo combining multiple lists

QueryString compatibility:

netlify bot commented Dec 21, 2022 • edited Loading

✅ Deploy Preview for volto canceled.

cypress bot commented Dec 21, 2022 • edited Loading

Passing run #4926 ↗︎

ionlizarazu commented Dec 21, 2022

sneridagh commented Feb 16, 2023

erral commented Mar 24, 2023

tiberiuichim Mar 30, 2023

Choose a reason for hiding this comment

ionlizarazu Mar 30, 2023

Choose a reason for hiding this comment

ionlizarazu commented Mar 31, 2023

erral commented Apr 2, 2023

bipoza commented Dec 21, 2022 •

edited

Loading

netlify bot commented Dec 21, 2022 •

edited

Loading

cypress bot commented Dec 21, 2022 •

edited

Loading