pre-installations and preparations
This commit is contained in:
1 parent
3e5a0329cb
commit
201d621ac3
6977 files changed
+742826
No files matched your search
+4
@@ -0,0 +1,4 @@
|
||||
'use client';
|
||||
|
||||
export * from './useCompoundParent';
|
||||
export * from './useCompoundItem';
|
||||
+38
@@ -0,0 +1,38 @@
|
||||
'use client';
|
||||
|
||||
import * as React from 'react';
|
||||
import { unstable_useEnhancedEffect as useEnhancedEffect } from '@mui/utils';
|
||||
import { CompoundComponentContext } from './useCompoundParent';
|
||||
/**
|
||||
* Registers a child component with the parent component.
|
||||
*
|
||||
* @param id A unique key for the child component. If the `id` is `undefined`, the registration logic will not run (this can sometimes be the case during SSR).
|
||||
* This can be either a value, or a function that generates a value based on already registered siblings' ids.
|
||||
* If a function, it's called with the set of the ids of all the items that have already been registered.
|
||||
* Return `existingKeys.size` if you want to use the index of the new item as the id.
|
||||
* @param itemMetadata Arbitrary metadata to pass to the parent component. This should be a stable reference (for example a memoized object), to avoid unnecessary re-registrations.
|
||||
*
|
||||
* @ignore - internal hook.
|
||||
*/
|
||||
export function useCompoundItem(id, itemMetadata) {
|
||||
var context = React.useContext(CompoundComponentContext);
|
||||
if (context === null) {
|
||||
throw new Error('useCompoundItem must be used within a useCompoundParent');
|
||||
}
|
||||
var registerItem = context.registerItem;
|
||||
var _React$useState = React.useState(typeof id === 'function' ? undefined : id),
|
||||
registeredId = _React$useState[0],
|
||||
setRegisteredId = _React$useState[1];
|
||||
useEnhancedEffect(function () {
|
||||
var _registerItem = registerItem(id, itemMetadata),
|
||||
returnedId = _registerItem.id,
|
||||
deregister = _registerItem.deregister;
|
||||
setRegisteredId(returnedId);
|
||||
return deregister;
|
||||
}, [registerItem, itemMetadata, id]);
|
||||
return {
|
||||
id: registeredId,
|
||||
index: registeredId !== undefined ? context.getItemIndex(registeredId) : -1,
|
||||
totalItemCount: context.totalSubitemCount
|
||||
};
|
||||
}
|
||||
+96
@@ -0,0 +1,96 @@
|
||||
'use client';
|
||||
|
||||
import * as React from 'react';
|
||||
export var CompoundComponentContext = /*#__PURE__*/React.createContext(null);
|
||||
if (process.env.NODE_ENV !== 'production') {
|
||||
CompoundComponentContext.displayName = 'CompoundComponentContext';
|
||||
}
|
||||
/**
|
||||
* Sorts the subitems by their position in the DOM.
|
||||
*/
|
||||
function sortSubitems(subitems) {
|
||||
var subitemsArray = Array.from(subitems.keys()).map(function (key) {
|
||||
var subitem = subitems.get(key);
|
||||
return {
|
||||
key: key,
|
||||
subitem: subitem
|
||||
};
|
||||
});
|
||||
subitemsArray.sort(function (a, b) {
|
||||
var aNode = a.subitem.ref.current;
|
||||
var bNode = b.subitem.ref.current;
|
||||
if (aNode === null || bNode === null || aNode === bNode) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
// eslint-disable-next-line no-bitwise
|
||||
return aNode.compareDocumentPosition(bNode) & Node.DOCUMENT_POSITION_PRECEDING ? 1 : -1;
|
||||
});
|
||||
return new Map(subitemsArray.map(function (item) {
|
||||
return [item.key, item.subitem];
|
||||
}));
|
||||
}
|
||||
|
||||
/**
|
||||
* Provides a way for a component to know about its children.
|
||||
*
|
||||
* Child components register themselves with the `useCompoundItem` hook, passing in arbitrary metadata to the parent.
|
||||
*
|
||||
* This is a more powerful altervantive to `children` traversal, as child components don't have to be placed
|
||||
* directly inside the parent component. They can be anywhere in the tree (and even rendered by other components).
|
||||
*
|
||||
* The downside is that this doesn't work with SSR as it relies on the useEffect hook.
|
||||
*
|
||||
* @ignore - internal hook.
|
||||
*/
|
||||
export function useCompoundParent() {
|
||||
var _React$useState = React.useState(new Map()),
|
||||
subitems = _React$useState[0],
|
||||
setSubitems = _React$useState[1];
|
||||
var subitemKeys = React.useRef(new Set());
|
||||
var deregisterItem = React.useCallback(function deregisterItem(id) {
|
||||
subitemKeys.current.delete(id);
|
||||
setSubitems(function (previousState) {
|
||||
var newState = new Map(previousState);
|
||||
newState.delete(id);
|
||||
return newState;
|
||||
});
|
||||
}, []);
|
||||
var registerItem = React.useCallback(function registerItem(id, item) {
|
||||
var providedOrGeneratedId;
|
||||
if (typeof id === 'function') {
|
||||
providedOrGeneratedId = id(subitemKeys.current);
|
||||
} else {
|
||||
providedOrGeneratedId = id;
|
||||
}
|
||||
subitemKeys.current.add(providedOrGeneratedId);
|
||||
setSubitems(function (previousState) {
|
||||
var newState = new Map(previousState);
|
||||
newState.set(providedOrGeneratedId, item);
|
||||
return newState;
|
||||
});
|
||||
return {
|
||||
id: providedOrGeneratedId,
|
||||
deregister: function deregister() {
|
||||
return deregisterItem(providedOrGeneratedId);
|
||||
}
|
||||
};
|
||||
}, [deregisterItem]);
|
||||
var sortedSubitems = React.useMemo(function () {
|
||||
return sortSubitems(subitems);
|
||||
}, [subitems]);
|
||||
var getItemIndex = React.useCallback(function getItemIndex(id) {
|
||||
return Array.from(sortedSubitems.keys()).indexOf(id);
|
||||
}, [sortedSubitems]);
|
||||
var contextValue = React.useMemo(function () {
|
||||
return {
|
||||
getItemIndex: getItemIndex,
|
||||
registerItem: registerItem,
|
||||
totalSubitemCount: subitems.size
|
||||
};
|
||||
}, [getItemIndex, registerItem, subitems.size]);
|
||||
return {
|
||||
contextValue: contextValue,
|
||||
subitems: sortedSubitems
|
||||
};
|
||||
}
|
||||
Reference in new issue
Block a user