refactor(range): make range connector more consistent and simpler to use #6508
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
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit c5f05da:
|
dhayab
requested review from
a team,
sarahdayan,
shaejaz and
Haroenv
and removed request for
a team
Haroenv
reviewed
Jan 6, 2025
packages/create-instantsearch-app/e2e/__snapshots__/templates.test.js.snap
Outdated
Show resolved
Hide resolved
packages/instantsearch.js/src/widgets/range-slider/range-slider.tsx
Outdated
Show resolved
Hide resolved
packages/instantsearch.js/src/widgets/range-input/range-input.tsx
Outdated
Show resolved
Hide resolved
| @@ -96,7 +98,6 @@ export type RangeWidgetDescription = { | |||
| }; | |||
| indexUiState: { | |||
| range: { | |||
| // @TODO: this could possibly become `${number}:${number}` later | |||
There was a problem hiding this comment.
changing it required casting in too many places?
There was a problem hiding this comment.
The uiState for range is already ${min}:${max}, so I discarded the todo.
There was a problem hiding this comment.
yes but typed as string though? not much benefit so I'm ok with leaving it as is
There was a problem hiding this comment.
Ah this was meant as a template literal type! I didn't get it. Tried it and there is a type inconsistency somewhere. I'll look into it.
This reverts commit ec478bf.
- currentRefinement values are clamped to range - currentRefinement values are undefined if equal to range
Haroenv
approved these changes
Jan 7, 2025
Haroenv
pushed a commit
that referenced
this pull request
Jan 9, 2025
…use (#6508) BREAKING CHANGE: `start` is now called `currentRefinement` and its data structure and behavior are different
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.
Summary
This PR reworks
connectRangeand its widgets to provide a simpler and more consistent experience.BREAKING CHANGE:
startis now calledcurrentRefinementand has the same type asrange({ min: number, max: number })FX-3189