feat(instantsearch): add React custom widgets, middleware, SSR (3/4)#24
Merged
NatanTechofNY merged 4 commits intoJun 10, 2026
Conversation
6 tasks
Adds the canonical widget tree (SearchBox, Configure, Hits, Pagination, Stats, NoResultsBoundary), the refinements catalog (RefinementList, HierarchicalMenu, RangeInput, ToggleRefinement, CurrentRefinements, ClearRefinements), sort via SortBy with replicas, and multi-index guidance. The pattern reference points reviewers at types and live docs for prop-level details rather than baking them in. Adds evals 6 and 7 covering the full results page and a searchable refinement list with active-filter chips. Stacks on feat/instantsearch-source-of-truth.
vascobettencourt
force-pushed
the
feat/instantsearch-react-advanced
branch
from
adad646 to
2d46652
Compare
6 tasks
Member
|
@vascobettencourt This PR seems to contain the work from #23, unlike what the description suggests (sibling, based off #22). Can we rebase so the review is only on those changes, or do you want to rebase onto #23 to clean the diff? |
vascobettencourt
added a commit
that referenced
this pull request
May 20, 2026
Three duplications tightened, all per Sarah's review:
- features.md: collapsed five "read .d.ts" / "wire props from types"
mentions down to a single intro reference to the Source-of-truth
check. The intro on line 5 is the canonical pointer; the rest are
rephrased to drop the rule restatement.
- features.md: removed "Do not combine both" from the
Pagination-vs-InfiniteHits prose. The dedicated entry already lives
in anti-patterns.md; the checklist's "(or InfiniteHits, not both)"
is enough of a reminder.
- anti-patterns.md: removed the "Forgetting routing={true}" and
"Forgetting insights={true}" rows. Both are already covered by
PR #22's Always rules and the features checklist; the anti-patterns
rows were the redundant copy.
Forward-references to ../custom-widgets.md and ../ssr.md (PR #24)
left in place per Sarah's "non-blocking, fine if 2 -> 3 ships in
order" note.
Co-authored-by: Cursor <cursoragent@cursor.com>
vascobettencourt
force-pushed
the
feat/instantsearch-react-advanced
branch
from
2d46652 to
cf25f16
Compare
6 tasks
vascobettencourt
added a commit
that referenced
this pull request
May 20, 2026
Three duplications tightened, all per Sarah's review:
- features.md: collapsed five "read .d.ts" / "wire props from types"
mentions down to a single intro reference to the Source-of-truth
check. The intro on line 5 is the canonical pointer; the rest are
rephrased to drop the rule restatement.
- features.md: removed "Do not combine both" from the
Pagination-vs-InfiniteHits prose. The dedicated entry already lives
in anti-patterns.md; the checklist's "(or InfiniteHits, not both)"
is enough of a reminder.
- anti-patterns.md: removed the "Forgetting routing={true}" and
"Forgetting insights={true}" rows. Both are already covered by
PR #22's Always rules and the features checklist; the anti-patterns
rows were the redundant copy.
Forward-references to ../custom-widgets.md and ../ssr.md (PR #24)
left in place per Sarah's "non-blocking, fine if 2 -> 3 ships in
order" note.
Three duplications tightened, all per Sarah's review:
- features.md: collapsed five "read .d.ts" / "wire props from types"
mentions down to a single intro reference to the Source-of-truth
check. The intro on line 5 is the canonical pointer; the rest are
rephrased to drop the rule restatement.
- features.md: removed "Do not combine both" from the
Pagination-vs-InfiniteHits prose. The dedicated entry already lives
in anti-patterns.md; the checklist's "(or InfiniteHits, not both)"
is enough of a reminder.
- anti-patterns.md: removed the "Forgetting routing={true}" and
"Forgetting insights={true}" rows. Both are already covered by
PR #22's Always rules and the features checklist; the anti-patterns
rows were the redundant copy.
Forward-references to ../custom-widgets.md and ../ssr.md (PR #24)
left in place per Sarah's "non-blocking, fine if 2 -> 3 ships in
order" note.
vascobettencourt
added a commit
that referenced
this pull request
May 20, 2026
Three duplications tightened, all per Sarah's review:
- features.md: collapsed five "read .d.ts" / "wire props from types"
mentions down to a single intro reference to the Source-of-truth
check. The intro on line 5 is the canonical pointer; the rest are
rephrased to drop the rule restatement.
- features.md: removed "Do not combine both" from the
Pagination-vs-InfiniteHits prose. The dedicated entry already lives
in anti-patterns.md; the checklist's "(or InfiniteHits, not both)"
is enough of a reminder.
- anti-patterns.md: removed the "Forgetting routing={true}" and
"Forgetting insights={true}" rows. Both are already covered by
PR #22's Always rules and the features checklist; the anti-patterns
rows were the redundant copy.
Forward-references to ../custom-widgets.md and ../ssr.md (PR #24)
left in place per Sarah's "non-blocking, fine if 2 -> 3 ships in
order" note.
vascobettencourt
force-pushed
the
feat/instantsearch-react-advanced
branch
from
cf25f16 to
267e553
Compare
…nces Adds three library-level references that close the gaps the Source-of-truth check on its own can't fully bridge: - custom-widgets.md: when widget + classNames suffices vs when to reach for useConnector / useXxx, the renderState contract, common pitfalls (stale state, re-render storms, lost A11y). - middleware.md: contract (subscribe / started / unsubscribe / onStateChange), legitimate uses, and what middleware should NOT be used for (URL sync, default refinements). - ssr.md: App Router via InstantSearchNext (no extra helpers needed) vs Pages Router / non-Next React via getServerState + InstantSearchSSRProvider, with explicit guidance against mixing them. Adds evals 8 (Pages Router SSR) and 9 (custom chip widget via useRefinementList). Stacks on feat/instantsearch-source-of-truth.
vascobettencourt
force-pushed
the
feat/instantsearch-source-of-truth
branch
from
8eb583d to
9b69b3d
Compare
vascobettencourt
force-pushed
the
feat/instantsearch-react-advanced
branch
from
267e553 to
33dffde
Compare
vascobettencourt
changed the base branch from
feat/instantsearch-source-of-truth
to
feat/instantsearch-search-results-page
Member
Author
|
@sarahdayan good catch, thank you |
Base automatically changed from
feat/instantsearch-search-results-page
to
feat/instantsearch-source-of-truth
June 10, 2026 18:36
…arch-react-advanced
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What does this skill do?
Adds three React library-level references that cover surfaces the Source-of-truth check on its own can't fully bridge — they involve enough nuance and trade-offs that a baked structural skeleton earns its keep.
This is part 3 of 4. Stacks on #23 (which stacks on #22). Review #22 and #23 first; this PR's diff now contains only its own changes.
What's in this PR
references/react/custom-widgets.md— when widget +classNames+transformItemsis enough, when to reach foruseConnector/useXxx, the renderState contract, common pitfalls (stale state in handlers, re-render storms, lost A11y, duplicate connector instances). Includes a "do you actually need this?" walkthrough so the agent doesn't reach for hooks reflexively.references/react/middleware.md— middleware contract (subscribe,started,unsubscribe,onStateChange), legitimate uses (custom analytics, non-URL state sync), and what middleware should NOT do (URL sync, default refinements — both belong inrouting/<Configure>).references/react/ssr.md— App Router via<InstantSearchNext>(no extra helpers needed) vs Pages Router / non-Next React viagetServerState+<InstantSearchSSRProvider>. Explicit guidance against doubling up.SKILL.md: addsCustom widgets,Middleware,SSRrows to the library-level references table.references/react/{technology-rules,anti-patterns,glossary}.md: adds the cross-references / rule pointers thatsource-of-truth.md's self-contained PR feat(instantsearch): add Source-of-truth check workflow step (1/4) #22 deliberately omitted; they only make sense once these three files exist.evals/evals.json: adds eval 8 (Pages Router SSR) and eval 9 (custom chip widget viauseRefinementList).Checklist
python3 scripts/validate_skills.py .passes (31/31)evals/evals.jsonhas 10 prompts after this PR (1–7 from feat(instantsearch): add Source-of-truth check workflow step (1/4) #22 and feat(instantsearch): add React search results page pattern (2/4) #23, plus 8 and 9 here, plus 10 from feat(instantsearch): add Source-of-truth check workflow step (1/4) #22)skills/Behavioral test
Evals 8 and 9 were exercised via fresh subagents. Eval 8 (Pages Router SSR) hit 8/8:
getServerStatefromreact-instantsearch/server,<InstantSearchSSRProvider>,renderToStringfromreact-dom/server, module-scopesearchClient,routingupgraded for server-side URL resolution, no<InstantSearchNext>. Eval 9 (custom widget) hit 6/6: walked the "do you actually need this?" gates, useduseRefinementList(correctly preferred over rawuseConnector), calledrefine(item.value), added explicit ARIA, consideredtransformItemsfirst.