Skip to content

React 19 types: migrate away from MutableRefObject #84550

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

Merged
jsnajdr merged 2 commits into from
Oct 12, 2026
Merged

React 19 types: migrate away from MutableRefObject #84550

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
3edf200
React 19 types: migrate away from MutableRefObject
jsnajdr Oct 12, 2026
7f5e512
Add changelog entries
jsnajdr Oct 12, 2026
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
4 changes: 4 additions & 0 deletions packages/compose/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@

- Raise the minimum required Node.js version to `>=22.13.0`, for stable `require(esm)` support ([#84313](https://github.com/WordPress/gutenberg/pull/84313)).

### Internal

- Use the `RefObject` React type instead of `MutableRefObject` which is deprecated in React 19 types ([#84550](https://github.com/WordPress/gutenberg/pull/84550)).

## 8.10.0 (2026-10-07)

### Bug Fixes
Expand Down
4 changes: 2 additions & 2 deletions packages/compose/src/hooks/use-copy-to-clipboard/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { useRef, useLayoutEffect } from '@wordpress/element';
import type { MutableRefObject, RefCallback } from 'react';
import type { RefObject, RefCallback } from 'react';
import useRefEffect from '../use-ref-effect';

/**
Expand Down Expand Up @@ -60,7 +60,7 @@ export function restoreFocus( trigger: Element ): void {
* @param value
* @return A ref to assign to the target element.
*/
function useUpdatedRef< T >( value: T ): MutableRefObject< T > {
function useUpdatedRef< T >( value: T ): RefObject< T > {
const ref = useRef< T >( value );
useLayoutEffect( () => {
ref.current = value;
Expand Down
1 change: 1 addition & 0 deletions packages/dataviews/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
### Internal

- Update Ariakit to 0.4.41 ([#84539](https://github.com/WordPress/gutenberg/pull/84539)).
- Use the `RefObject` React type instead of `MutableRefObject` which is deprecated in React 19 types ([#84550](https://github.com/WordPress/gutenberg/pull/84550)).

## 20.0.0 (2026-10-07)

Expand Down
4 changes: 2 additions & 2 deletions packages/dataviews/src/hooks/use-infinite-scroll.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import type { View } from '../types';
*/
function captureAnchorElement(
container: HTMLElement,
anchorElementRef: React.MutableRefObject< {
anchorElementRef: React.RefObject< {
posinset: number;
viewportOffset: number;
scrollTop: number;
Expand Down Expand Up @@ -69,7 +69,7 @@ type UseInfiniteScrollProps = {
totalItems: number;
totalPages: number;
};
containerRef: React.MutableRefObject< HTMLDivElement | null >;
containerRef: React.RefObject< HTMLDivElement | null >;
setVisibleEntries?: React.Dispatch< React.SetStateAction< number[] > >;
};

Expand Down
4 changes: 2 additions & 2 deletions packages/editor/src/components/collab-sidebar/rich-text-control/format-edit.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { ComponentType, MutableRefObject } from 'react';
import type { ComponentType, RefObject } from 'react';
import { getActiveFormat, getActiveObject } from '@wordpress/rich-text';
import type { RichTextValue } from '@wordpress/rich-text';

Expand All @@ -22,7 +22,7 @@ type EditProps = {
onChange: ( value: RichTextValue ) => void;
onFocus: () => void;
value: RichTextValue;
forwardedRef: MutableRefObject< HTMLElement | undefined >;
forwardedRef: RefObject< HTMLElement | undefined >;
isVisible: boolean;
};

Expand Down
2 changes: 1 addition & 1 deletion packages/editor/src/components/collaborators-overlay/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export function CollaboratorsOverlay( {
{ ( {
containerRef,
}: {
containerRef: React.MutableRefObject< HTMLElement | null >;
containerRef: React.RefObject< HTMLElement | null >;
} ) => (
<Overlay
blockEditorDocument={ containerRef.current?.ownerDocument }
Expand Down
4 changes: 4 additions & 0 deletions packages/grid/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@

- Raise the minimum required Node.js version to `>=22.13.0`, for stable `require(esm)` support ([#84313](https://github.com/WordPress/gutenberg/pull/84313)).

### Internal

- Use the `RefObject` React type instead of `MutableRefObject` which is deprecated in React 19 types ([#84550](https://github.com/WordPress/gutenberg/pull/84550)).

## 0.9.0 (2026-10-07)

### Breaking Changes
Expand Down
4 changes: 1 addition & 3 deletions packages/grid/src/shared/use-item-exit-animation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,7 @@ type UseItemExitAnimationOptions = {
string,
RectSnapshot
> | null;
childrenCacheRef: React.MutableRefObject<
Map< string, React.ReactElement >
>;
childrenCacheRef: React.RefObject< Map< string, React.ReactElement > >;
};

type UseItemExitAnimationResult = {
Expand Down
16 changes: 1 addition & 15 deletions packages/media-editor/src/image-editor/react/components/cropper.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -967,23 +967,9 @@ function CropperInner(
};
}

// Forward the root element to the consumer's ref.
const setContainerRef = useCallback(
( element: HTMLDivElement | null ) => {
if ( typeof ref === 'function' ) {
ref( element );
} else if ( ref ) {
(
ref as React.MutableRefObject< HTMLDivElement | null >
).current = element;
}
},
[ ref ]
);

@jsnajdr jsnajdr Oct 12, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a wrapper around ref that is today completely redundant. In the original #77479 it used to merge two refs (could have been a use of useMergeRefs) but the second ref was since removed. cc @ramonjd


return (
<div
ref={ setContainerRef }
ref={ ref }
className={ clsx(
'wp-media-editor-image-editor',
isDragging && 'wp-media-editor-image-editor--dragging',
Expand Down
Loading