Skip to content
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

[Composite] Derive sorted map state #1489

Merged
merged 2 commits into from
Feb 28, 2025
Merged

[Composite] Derive sorted map state #1489

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f8f3d5f
[Composite] Derive sorted map state
atomiks Feb 28, 2025
52a38df
Merge branch 'master' into fix/composite-list
atomiks Feb 28, 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
48 changes: 13 additions & 35 deletions packages/react/src/composite/list/CompositeList.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@
'use client';
import * as React from 'react';
import PropTypes from 'prop-types';
import { fastObjectShallowCompare } from '../../utils/fastObjectShallowCompare';
import { useEnhancedEffect } from '../../utils/useEnhancedEffect';
import { CompositeListContext } from './CompositeListContext';
import { useEnhancedEffect } from '../../utils/useEnhancedEffect';

function sortByDocumentPosition(a: Node, b: Node) {
const position = a.compareDocumentPosition(b);
Expand All @@ -25,26 +24,6 @@ function sortByDocumentPosition(a: Node, b: Node) {

export type CompositeMetadata<CustomMetadata> = { index?: number | null } & CustomMetadata;

function areMapsEqual<Metadata>(
map1: Map<Node, CompositeMetadata<Metadata> | null>,
map2: Map<Node, CompositeMetadata<Metadata> | null>,
) {
if (map1.size !== map2.size) {
return false;
}
for (const [key, value] of map1.entries()) {
const value2 = map2.get(key);
// compare the index before comparing everything else
if (value?.index !== value2?.index) {
return false;
}
if (value2 !== undefined && !fastObjectShallowCompare(value, value2)) {
return false;
}
}
return true;
}

/**
* Provides context for a list of items in a composite component.
* @ignore - internal component.
Expand All @@ -66,26 +45,25 @@ function CompositeList<Metadata>(props: CompositeList.Props<Metadata>) {
});
}, []);

useEnhancedEffect(() => {
const newMap = new Map(map);

const nodes = Array.from(newMap.keys()).sort(sortByDocumentPosition);
const sortedMap = React.useMemo(() => {
const newMap = new Map<Node, CompositeMetadata<Metadata>>();
const sortedNodes = Array.from(map.keys()).sort(sortByDocumentPosition);

nodes.forEach((node, index) => {
sortedNodes.forEach((node, index) => {
const metadata = map.get(node) ?? ({} as CompositeMetadata<Metadata>);

newMap.set(node, { ...metadata, index });
});

if (!areMapsEqual(map, newMap)) {
setMap(newMap);
onMapChange?.(newMap);
}
}, [map, onMapChange]);
return newMap;
}, [map]);

useEnhancedEffect(() => {
onMapChange?.(sortedMap);
}, [sortedMap, onMapChange]);

const contextValue = React.useMemo(
() => ({ register, unregister, map, elementsRef, labelsRef }),
[register, unregister, map, elementsRef, labelsRef],
() => ({ register, unregister, map: sortedMap, elementsRef, labelsRef }),
[register, unregister, sortedMap, elementsRef, labelsRef],
);

return (
Expand Down