Support multiple Pagination components on the same page #2649
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Oxygen deployed a preview of your
Learn more about Hydrogen's GitHub integration. |
rbshop
reviewed
Nov 22, 2024
rbshop
reviewed
Nov 22, 2024
Comment on lines
228
to
243
| // Handle non-namespaced params (empty string namespace) | ||
| if (activeNamespaces.includes('')) { | ||
| params.delete('cursor'); | ||
| params.delete('direction'); | ||
| } | ||
|
|
||
| activeNamespaces | ||
| .filter((namespace) => namespace !== '') | ||
| .forEach((namespace) => { | ||
| const cursorParam = `${namespace}_cursor`; | ||
| const directionParam = `${namespace}_direction`; | ||
|
|
||
| params.delete(cursorParam); | ||
| params.delete(directionParam); | ||
| }); | ||
|
|
There was a problem hiding this comment.
Optionally, you could roll this into one by doing:
const namespacePrefix = namespace === '' ? '' : `${namespace}_`
const cursorParam = `${namespacePrefix}cursor`;
const directionParam = `${namespacePrefix}direction`;
Though tbh it would have been fine to give no special treatment to the empty namespace, and just used _cursor and _direction when working with it (although granted that might look ugly in the URL)
There was a problem hiding this comment.
Yess much cleaner, thanks!
There was a problem hiding this comment.
And yeah I thought _cursor was a bit of an eye sore + would break existing links when folks upgrade.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WHY are these changes introduced?
Enables the use of multiple
<Pagination />components on a single page.Resolves https://github.com/Shopify/hydrogen-internal/issues/124
WHAT is this pull request doing?
namespaceprop on the<Pagination />component. If provided, the namespace value prepends the URL parameters - as in<namespace>_cursorand<namespace>_direction.cursoranddirectionparams are used.namespaces are stored in the location state so we can:getPaginationVariablesutility to accept an optional namespace.HOW to test your changes?
app/routes/collections.all.tsxwith this contentapp/components/PaginatedResourceSection.tsxwith this contentnamespace.Checklist