100 lines
4.5 KiB
JavaScript
100 lines
4.5 KiB
JavaScript
import * as React from 'react';
|
|
import { TimerBasedCleanupTracking } from '../../utils/cleanupTracking/TimerBasedCleanupTracking';
|
|
import { FinalizationRegistryBasedCleanupTracking } from '../../utils/cleanupTracking/FinalizationRegistryBasedCleanupTracking';
|
|
/**
|
|
* Signal to the underlying logic what version of the public component API
|
|
* of the data grid is exposed.
|
|
*/
|
|
var GridSignature = /*#__PURE__*/function (GridSignature) {
|
|
GridSignature["DataGrid"] = "DataGrid";
|
|
GridSignature["DataGridPro"] = "DataGridPro";
|
|
return GridSignature;
|
|
}(GridSignature || {});
|
|
// We use class to make it easier to detect in heap snapshots by name
|
|
class ObjectToBeRetainedByReact {}
|
|
|
|
// Based on https://github.com/Bnaya/use-dispose-uncommitted/blob/main/src/finalization-registry-based-impl.ts
|
|
// Check https://github.com/facebook/react/issues/15317 to get more information
|
|
export function createUseGridApiEventHandler(registryContainer) {
|
|
let cleanupTokensCounter = 0;
|
|
return function useGridApiEventHandler(apiRef, eventName, handler, options) {
|
|
if (registryContainer.registry === null) {
|
|
registryContainer.registry = typeof FinalizationRegistry !== 'undefined' ? new FinalizationRegistryBasedCleanupTracking() : new TimerBasedCleanupTracking();
|
|
}
|
|
const [objectRetainedByReact] = React.useState(new ObjectToBeRetainedByReact());
|
|
const subscription = React.useRef(null);
|
|
const handlerRef = React.useRef();
|
|
handlerRef.current = handler;
|
|
const cleanupTokenRef = React.useRef(null);
|
|
if (!subscription.current && handlerRef.current) {
|
|
const enhancedHandler = (params, event, details) => {
|
|
if (!event.defaultMuiPrevented) {
|
|
var _handlerRef$current;
|
|
(_handlerRef$current = handlerRef.current) == null || _handlerRef$current.call(handlerRef, params, event, details);
|
|
}
|
|
};
|
|
subscription.current = apiRef.current.subscribeEvent(eventName, enhancedHandler, options);
|
|
cleanupTokensCounter += 1;
|
|
cleanupTokenRef.current = {
|
|
cleanupToken: cleanupTokensCounter
|
|
};
|
|
registryContainer.registry.register(objectRetainedByReact,
|
|
// The callback below will be called once this reference stops being retained
|
|
() => {
|
|
var _subscription$current;
|
|
(_subscription$current = subscription.current) == null || _subscription$current.call(subscription);
|
|
subscription.current = null;
|
|
cleanupTokenRef.current = null;
|
|
}, cleanupTokenRef.current);
|
|
} else if (!handlerRef.current && subscription.current) {
|
|
subscription.current();
|
|
subscription.current = null;
|
|
if (cleanupTokenRef.current) {
|
|
registryContainer.registry.unregister(cleanupTokenRef.current);
|
|
cleanupTokenRef.current = null;
|
|
}
|
|
}
|
|
React.useEffect(() => {
|
|
if (!subscription.current && handlerRef.current) {
|
|
const enhancedHandler = (params, event, details) => {
|
|
if (!event.defaultMuiPrevented) {
|
|
var _handlerRef$current2;
|
|
(_handlerRef$current2 = handlerRef.current) == null || _handlerRef$current2.call(handlerRef, params, event, details);
|
|
}
|
|
};
|
|
subscription.current = apiRef.current.subscribeEvent(eventName, enhancedHandler, options);
|
|
}
|
|
if (cleanupTokenRef.current && registryContainer.registry) {
|
|
// If the effect was called, it means that this render was committed
|
|
// so we can trust the cleanup function to remove the listener.
|
|
registryContainer.registry.unregister(cleanupTokenRef.current);
|
|
cleanupTokenRef.current = null;
|
|
}
|
|
return () => {
|
|
var _subscription$current2;
|
|
(_subscription$current2 = subscription.current) == null || _subscription$current2.call(subscription);
|
|
subscription.current = null;
|
|
};
|
|
}, [apiRef, eventName, options]);
|
|
};
|
|
}
|
|
const registryContainer = {
|
|
registry: null
|
|
};
|
|
|
|
// TODO: move to @mui/x-data-grid/internals
|
|
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
export const unstable_resetCleanupTracking = () => {
|
|
var _registryContainer$re;
|
|
(_registryContainer$re = registryContainer.registry) == null || _registryContainer$re.reset();
|
|
registryContainer.registry = null;
|
|
};
|
|
export const useGridApiEventHandler = createUseGridApiEventHandler(registryContainer);
|
|
const optionsSubscriberOptions = {
|
|
isFirst: true
|
|
};
|
|
export function useGridApiOptionHandler(apiRef, eventName, handler) {
|
|
// Validate that only one per event name?
|
|
useGridApiEventHandler(apiRef, eventName, handler, optionsSubscriberOptions);
|
|
}
|
|
export { GridSignature }; |