Skip to content

Feat: Add lifecycle callback to useId #8630

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.

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 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
15 changes: 9 additions & 6 deletions packages/@react-aria/utils/src/useId.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,26 +26,28 @@ export let idsUpdaterMap: Map<string, { current: string | null }[]> = new Map();
// This allows us to clean up the idsUpdaterMap when the id is no longer used.
// Map is a strong reference, so unused ids wouldn't be cleaned up otherwise.
// This can happen in suspended components where mount/unmount is not called.
let registry;
let registry: FinalizationRegistry<[string, (id: string) => void]> | undefined;
if (typeof FinalizationRegistry !== 'undefined') {
registry = new FinalizationRegistry<string>((heldValue) => {
idsUpdaterMap.delete(heldValue);
registry = new FinalizationRegistry(([id, cleanupCallback]) => {
idsUpdaterMap.delete(id);
cleanupCallback(id);
});
}

/**
* If a default is not provided, generate an id.
* @param defaultId - Default component id.
*/
export function useId(defaultId?: string): string {
export function useId(defaultId?: string, cleanupCallback?: (id: string) => void): string {
let [value, setValue] = useState(defaultId);
let nextId = useRef(null);

let res = useSSRSafeId(value);
let cleanupRef = useRef(null);
let cleanup = useCallback((id: string) => cleanupCallback?.(id), [cleanupCallback]);

if (registry) {
registry.register(cleanupRef, res);
registry.register(cleanupRef, [res, cleanup]);
}

if (canUseDOM) {
Expand All @@ -66,8 +68,9 @@ export function useId(defaultId?: string): string {
registry.unregister(cleanupRef);
}
idsUpdaterMap.delete(r);
cleanup(r);
};
}, [res]);
}, [res, cleanup]);

// This cannot cause an infinite loop because the ref is always cleaned up.
// eslint-disable-next-line
Expand Down