Skip to content

feat: Add CollectionNode to collection renderer #8523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: Add CollectionNode to collection renderer #8523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b82fb5
feat: add node component to collection renderer
nwidynski Jul 10, 2025
d6210b6
fix: drop indicators
nwidynski Jul 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions packages/@react-spectrum/s2/src/Breadcrumbs.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import {baseColor, focusRing, size, style} from '../style' with { type: 'macro'
import ChevronIcon from '../ui-icons/Chevron';
import {Collection, DOMRef, DOMRefValue, LinkDOMProps, Node} from '@react-types/shared';
import {controlFont, controlSize, getAllowedOverrides, StyleProps} from './style-utils' with {type: 'macro'};
import {createContext, forwardRef, Fragment, ReactNode, RefObject, useCallback, useContext, useEffect, useMemo, useRef, useState} from 'react';
import {createContext, forwardRef, ReactNode, RefObject, useCallback, useContext, useEffect, useMemo, useRef, useState} from 'react';
import FolderIcon from '../s2wf-icons/S2_Icon_FolderBreadcrumb_20_N.svg';
import {forwardRefType} from './types';
import {inertValue, useLayoutEffect} from '@react-aria/utils';
Expand Down Expand Up @@ -380,6 +380,7 @@ let CollapsingCollectionRenderer: CollectionRenderer = {
};

let useCollectionRender = (collection: Collection<Node<unknown>>) => {
let {CollectionNode = DefaultCollectionRenderer.CollectionNode} = useContext(CollectionRendererContext);
let {containerRef, onAction} = useContext(CollapseContext) ?? {};
let [visibleItems, setVisibleItems] = useState(collection.size);
let {size = 'M'} = useContext(InternalBreadcrumbsContext);
Expand Down Expand Up @@ -468,13 +469,13 @@ let useCollectionRender = (collection: Collection<Node<unknown>>) => {
<HiddenBreadcrumbs items={children} size={size} listRef={listRef} />
{visibleItems < collection.size && collection.size > 2 ? (
<>
{children[0].render?.(children[0])}
<CollectionNode node={children[0]} parent={null} collection={collection} />
<BreadcrumbMenu items={children.slice(1, sliceIndex)} onAction={onAction} />
{children.slice(sliceIndex).map(node => <Fragment key={node.key}>{node.render?.(node)}</Fragment >)}
{children.slice(sliceIndex).map(node => <CollectionNode node={node} parent={null} collection={collection} key={node.key} />)}
</>
) : (
<>
{children.map(node => <Fragment key={node.key}>{node.render?.(node)}</Fragment>)}
{children.map(node => <CollectionNode node={node} parent={null} collection={collection} key={node.key} />)}
</>
)}
</>
Expand Down
55 changes: 39 additions & 16 deletions packages/react-aria-components/src/Collection.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,20 @@ export const Section = /*#__PURE__*/ createBranchComponent('section', <T extends
return render(props, ref, section, 'react-aria-Section');
});

export interface CollectionBranchProps {
export interface CollectionNodeProps<T = Node<unknown>> extends HTMLAttributes<HTMLElement> {
/** The collection of items to render. */
collection: ICollection<Node<unknown>>,
/** The node of the item to render. */
node: T,
/** The parent node of the item to render. */
parent: T | null,
/** The content that should be rendered before the item. */
before?: ReactNode,
/** The content that should be rendered after the item. */
after?: ReactNode
}

export interface CollectionBranchProps extends HTMLAttributes<HTMLElement> {
/** The collection of items to render. */
collection: ICollection<Node<unknown>>,
/** The parent node of the items to render. */
Expand All @@ -128,7 +141,7 @@ export interface CollectionRootProps extends HTMLAttributes<HTMLElement> {
renderDropIndicator?: (target: ItemDropTarget, keys?: Set<Key>, draggedKey?: Key) => ReactNode
}

export interface CollectionRenderer {
export interface CollectionRenderer<T = Node<unknown>> {
/** Whether this is a virtualized collection. */
isVirtualized?: boolean,
/** A delegate object that provides layout information for items in the collection. */
Expand All @@ -138,15 +151,25 @@ export interface CollectionRenderer {
/** A component that renders the root collection items. */
CollectionRoot: React.ComponentType<CollectionRootProps>,
/** A component that renders the child collection items. */
CollectionBranch: React.ComponentType<CollectionBranchProps>
CollectionBranch: React.ComponentType<CollectionBranchProps>,
/** A component that renders the collection item. */
CollectionNode?: React.ComponentType<CollectionNodeProps<T>>
}

export const DefaultCollectionRenderer: CollectionRenderer = {
interface DefaultRenderer extends CollectionRenderer<Node<unknown>> {
/** A component that renders the collection item. */
CollectionNode: React.ComponentType<CollectionNodeProps<Node<unknown>>>
}

export const DefaultCollectionRenderer: DefaultRenderer = {
CollectionRoot({collection, renderDropIndicator}) {
return useCollectionRender(collection, null, renderDropIndicator);
},
CollectionBranch({collection, parent, renderDropIndicator}) {
return useCollectionRender(collection, parent, renderDropIndicator);
},
CollectionNode({node, before, after}) {
return <>{before}{node.render!(node)}{after}</>;
}
};

Expand All @@ -155,22 +178,22 @@ function useCollectionRender(
parent: Node<unknown> | null,
renderDropIndicator?: (target: ItemDropTarget, keys?: Set<Key>, draggedKey?: Key) => ReactNode
) {
let {CollectionNode = DefaultCollectionRenderer.CollectionNode} = useContext(CollectionRendererContext);

return useCachedChildren({
items: parent ? collection.getChildren!(parent.key) : collection,
dependencies: [renderDropIndicator],
dependencies: [CollectionNode, parent, renderDropIndicator],
children(node) {
let rendered = node.render!(node);
if (!renderDropIndicator || node.type !== 'item') {
return rendered;
let pseudoProps = {};

if (renderDropIndicator && node.type === 'item') {
pseudoProps = {
before: renderDropIndicator({type: 'item', key: node.key, dropPosition: 'before'}),
after: renderAfterDropIndicators(collection, node, renderDropIndicator)
};
}

return (
<>
{renderDropIndicator({type: 'item', key: node.key, dropPosition: 'before'})}
{rendered}
{renderAfterDropIndicators(collection, node, renderDropIndicator)}
</>
);
return <CollectionNode {...pseudoProps} node={node} parent={parent} collection={collection} key={node.key} />;
}
});
}
Expand Down Expand Up @@ -211,7 +234,7 @@ export function renderAfterDropIndicators(collection: ICollection<Node<unknown>>
return afterIndicators;
}

export const CollectionRendererContext = createContext<CollectionRenderer>(DefaultCollectionRenderer);
export const CollectionRendererContext = createContext<CollectionRenderer<any>>(DefaultCollectionRenderer);

type PersistedKeysReturnValue = Set<Key> | null;
export function usePersistedKeys(focusedKey: Key | null): PersistedKeysReturnValue {
Expand Down
74 changes: 39 additions & 35 deletions packages/react-aria-components/src/Virtualizer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@
* governing permissions and limitations under the License.
*/

import {CollectionBranchProps, CollectionRenderer, CollectionRendererContext, CollectionRootProps, renderAfterDropIndicators} from './Collection';
import {CollectionBranchProps, CollectionNodeProps, CollectionRenderer, CollectionRendererContext, CollectionRootProps, renderAfterDropIndicators} from './Collection';
import {DropTargetDelegate, ItemDropTarget, Key, Node} from '@react-types/shared';
import {Layout, ReusableView, useVirtualizerState, VirtualizerState} from '@react-stately/virtualizer';
import {mergeProps} from '@react-aria/utils';
import React, {createContext, JSX, ReactNode, useContext, useMemo} from 'react';
import {useScrollView, VirtualizerItem} from '@react-aria/virtualizer';

Expand Down Expand Up @@ -53,12 +54,13 @@ const LayoutContext = createContext<LayoutContextValue | null>(null);
export function Virtualizer<O>(props: VirtualizerProps<O>): JSX.Element {
let {children, layout: layoutProp, layoutOptions} = props;
let layout = useMemo(() => typeof layoutProp === 'function' ? new layoutProp() : layoutProp, [layoutProp]);
let renderer: CollectionRenderer = useMemo(() => ({
let renderer: CollectionRenderer<ReusableView<Node<unknown>, ReactNode>> = useMemo(() => ({
isVirtualized: true,
layoutDelegate: layout,
dropTargetDelegate: layout.getDropTargetFromPoint ? layout as DropTargetDelegate : undefined,
CollectionRoot,
CollectionBranch
CollectionBranch,
CollectionNode
}), [layout]);

return (
Expand All @@ -70,7 +72,7 @@ export function Virtualizer<O>(props: VirtualizerProps<O>): JSX.Element {
);
}

function CollectionRoot({collection, persistedKeys, scrollRef, renderDropIndicator}: CollectionRootProps) {
function CollectionRoot({collection, persistedKeys, scrollRef, renderDropIndicator, ...props}: CollectionRootProps) {
let {layout, layoutOptions} = useContext(LayoutContext)!;
let layoutOptions2 = layout.useLayoutOptions?.();
let state = useVirtualizerState({
Expand Down Expand Up @@ -103,9 +105,9 @@ function CollectionRoot({collection, persistedKeys, scrollRef, renderDropIndicat
}, scrollRef!);

return (
<div {...contentProps}>
<div {...mergeProps(contentProps, props)} style={{...contentProps.style, ...props.style}}>
<VirtualizerContext.Provider value={state}>
{renderChildren(null, state.visibleViews, renderDropIndicator)}
{useRenderChildren(null, state.visibleViews, renderDropIndicator)}
</VirtualizerContext.Provider>
</div>
);
Expand All @@ -114,41 +116,43 @@ function CollectionRoot({collection, persistedKeys, scrollRef, renderDropIndicat
function CollectionBranch({parent, renderDropIndicator}: CollectionBranchProps) {
let virtualizer = useContext(VirtualizerContext);
let parentView = virtualizer!.virtualizer.getVisibleView(parent.key)!;
return renderChildren(parentView, Array.from(parentView.children), renderDropIndicator);
}

function renderChildren(parent: View | null, children: View[], renderDropIndicator?: (target: ItemDropTarget, keys?: Set<Key>, draggedKey?: Key) => ReactNode) {
return children.map(view => renderWrapper(parent, view, renderDropIndicator));
return useRenderChildren(parentView, Array.from(parentView.children), renderDropIndicator);
}

function renderWrapper(
parent: View | null,
reusableView: View,
renderDropIndicator?: (target: ItemDropTarget, keys?: Set<Key>, draggedKey?: Key) => ReactNode
): ReactNode {
let rendered = (
<VirtualizerItem
key={reusableView.key}
layoutInfo={reusableView.layoutInfo!}
virtualizer={reusableView.virtualizer}
parent={parent?.layoutInfo}>
{reusableView.rendered}
</VirtualizerItem>
function CollectionNode({node, parent, before, after, ...props}: CollectionNodeProps<ReusableView<Node<unknown>, ReactNode>>) {
return (
<>
{before}
<VirtualizerItem
{...props}
layoutInfo={node.layoutInfo!}
virtualizer={node.virtualizer}
parent={parent?.layoutInfo}
key={node.key}>
{node.rendered}
</VirtualizerItem>
{after}
</>
);
}

let {collection, layout} = reusableView.virtualizer;
let node = reusableView.content;
if (node?.type === 'item' && renderDropIndicator && layout.getDropTargetLayoutInfo) {
rendered = (
<React.Fragment key={reusableView.key}>
{renderDropIndicatorWrapper(parent, reusableView, {type: 'item', key: reusableView.content!.key, dropPosition: 'before'}, (target, keys, draggedKey) => renderDropIndicator(target, keys, draggedKey))}
{rendered}
{renderAfterDropIndicators(collection, node, (target, keys, draggedKey) => renderDropIndicatorWrapper(parent, reusableView, target, (innerTarget, innerKeys, innerDraggedKey) => renderDropIndicator(innerTarget, innerKeys, innerDraggedKey), keys, draggedKey))}
</React.Fragment>
);
}
function useRenderChildren(parent: View | null, children: View[], renderDropIndicator?: (target: ItemDropTarget, keys?: Set<Key>, draggedKey?: Key) => ReactNode) {
let {CollectionNode: Item = CollectionNode} = useContext(CollectionRendererContext);

return rendered;
return children.map(node => {
let {collection, layout} = node.virtualizer;
let pseudoProps = {};

if (layout.getDropTargetLayoutInfo && renderDropIndicator && node.content?.type === 'item') {
pseudoProps = {
before: renderDropIndicatorWrapper(parent, node, {type: 'item', key: node.content!.key, dropPosition: 'before'}, renderDropIndicator),
after: renderAfterDropIndicators(collection, node.content, target => renderDropIndicatorWrapper(parent, node, target, renderDropIndicator))
};
}

return <Item {...pseudoProps} node={node} parent={parent} collection={collection} key={node.key} />;
});
}

function renderDropIndicatorWrapper(
Expand Down