Feat: Add support for multiple adjacent collections #8553
+270
−32
Conversation
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
nwidynski
changed the title
useCollectionRef hook to improve controlled collection casesuseCollectionRef hook to improve adjacent child collections
nwidynski
changed the title
useCollectionRef hook to improve adjacent child collectionsuseCollectionRef hook to support adjacent child collections
nwidynski
commented
Jul 16, 2025
| @@ -157,6 +176,12 @@ function useSSRCollectionNode<T extends Element>(Type: string, props: object, re | |||
| return <Type ref={itemRef}>{children}</Type>; | |||
| } | |||
|
|
|||
| export function useCollectionRef<C extends BaseCollection<object>, E extends Element>(props: CollectionRenderProps<C>, ref: Ref<E>): CollectionRef<C, E> { | |||
There was a problem hiding this comment.
Naming and argument order is TBD. I was also considering useImperativeCollectionRef or something alike. Open for suggestions here 👍
nwidynski
commented
Jul 23, 2025
nwidynski
changed the title
useCollectionRef hook to support adjacent child collectionsuseCollectionRef hook to support different context for adjacent collections
nwidynski
changed the title
useCollectionRef hook to support different context for adjacent collections
5 tasks
nwidynski
changed the title
5 tasks
nwidynski
commented
Jul 27, 2025
| @@ -94,7 +116,7 @@ const useSyncExternalStore = typeof React['useSyncExternalStore'] === 'function' | |||
| ? React['useSyncExternalStore'] | |||
| : useSyncExternalStoreFallback; | |||
|
|
|||
| function useCollectionDocument<T extends object, C extends BaseCollection<T>>(createCollection?: () => C): CollectionDocumentResult<T, C> { | |||
| export function useCollectionDocument<T extends object, C extends BaseCollection<T>>(createCollection?: () => C): CollectionDocumentResult<T, C> { | |||
There was a problem hiding this comment.
Please let me know if you’re okay with exporting this. Our use case only requires one-way sync, so we wouldn’t necessarily need it, but I feel that a true sync might be preferable, in which case this would be required.
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.
This PR adds support for hooking into the
CollectionBuilderof child collections via a newuseCollectionRefhook. This hook supports the attachment of wrapper hooks to the ref of the collection element, which enables advanced controlled use cases, such as a hoisting multiple collections to a parent component.Background: We make use of this in our
Carousel, which provides a custom collection renderer to implement its scroll controls and infinite loops.Carouselsupports an adjacent collection next to aGridListorListBoxfor the tabbed carousel pattern, so we require a way to target the renderer & builder of specific slots 👍✅ Pull Request Checklist:
📝 Test Instructions:
🧢 Your Project: