feat(api): add namespace when storing widgets state #1627
Merged
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
mthuret
force-pushed
the
feat/add-namespace-to-state
branch
from
9057def to
0186a6d
Compare
|
Added the first documentation attempt. Also see this #1581 (comment). |
mthuret
force-pushed
the
feat/add-namespace-to-state
branch
from
0186a6d to
1a53b0c
Compare
BREAKING CHANGE: - our internal state shape now includes namespacing to avoid id collision. Also some existing keys were renamed: * searchbox was using 'q' now it uses 'query' * hitsPerPage was using 'hPP' now it uses 'hitsPerPage' * pagination and infiniteHits were using 'p' now it uses 'page' - toggle internal state change from 'on/off' to 'true/false' For more information about the state shape, please read our documentation.
mthuret
force-pushed
the
feat/add-namespace-to-state
branch
from
1a53b0c to
9f27a20
Compare
|
Do we need to update our examples synchronizing the state into the url and any example reading the state? |
|
In the future (noted as a task to discuss), we will have to think about an easy way/API to sync/parse state in the url so that urls are not too long and easily shareable. |
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.
Does not contain the doc yet, only the namespacing.
{ "range": { "price": { "min": "200", "max": "500" } }, "refinementList": { "colors": [ "White", "High gloss gray", "Black-brown", "High gloss white", "Walnut effect" ] }, "hierarchicalMenu": { "category": "Bathroom" }, "hitsPerPage": "2", "menu": { "type": "High cabinet with mirror door, black-brown" }, "multiRange": { "price": "100:500" }, "toggle": { "materials": "on" }, "sortBy": "index_name", "query": "chair", "page": 2 }