Revert "experiment: keep MutableRefObject"

This reverts commit 6c06950.
pmndrs · Jan 10, 2025 · 51312c3 · 51312c3
1 parent 33364f8
commit 51312c3
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 11 deletions.
diff --git a/packages/core/src/hooks/useInView.ts b/packages/core/src/hooks/useInView.ts
@@ -8,7 +8,7 @@ import { Valid } from '../types/common'
 
 export interface IntersectionArgs
   extends Omit<IntersectionObserverInit, 'root' | 'threshold'> {
-  root?: React.MutableRefObject<HTMLElement>
+  root?: React.RefObject<HTMLElement>
   once?: boolean
   amount?: 'any' | 'all' | number | number[]
 }

diff --git a/packages/core/src/hooks/useResize.ts b/packages/core/src/hooks/useResize.ts
@@ -1,12 +1,12 @@
-import { MutableRefObject } from 'react'
+import { RefObject } from 'react'
 import { onResize, each, useIsomorphicLayoutEffect } from '@react-spring/shared'
 
 import { SpringProps, SpringValues } from '../types'
 
 import { useSpring } from './useSpring'
 
 export interface UseResizeOptions extends Omit<SpringProps, 'to' | 'from'> {
-  container?: MutableRefObject<HTMLElement | null | undefined>
+  container?: RefObject<HTMLElement | null | undefined>
 }
 
 /**
@@ -30,7 +30,7 @@ export interface UseResizeOptions extends Omit<SpringProps, 'to' | 'from'> {
   ```
  * 
  * @param {UseResizeOptions} UseResizeOptions options for the useScroll hook.
- * @param {MutableRefObject<HTMLElement>} UseResizeOptions.container the container to listen to scroll events on, defaults to the window.
+ * @param {RefObject<HTMLElement>} UseResizeOptions.container the container to listen to scroll events on, defaults to the window.
  *
  * @returns {SpringValues<{width: number; height: number;}>} SpringValues the collection of values returned from the inner hook
  */

diff --git a/packages/core/src/hooks/useScroll.ts b/packages/core/src/hooks/useScroll.ts
@@ -1,12 +1,12 @@
-import { MutableRefObject } from 'react'
+import { RefObject } from 'react'
 import { each, onScroll, useIsomorphicLayoutEffect } from '@react-spring/shared'
 
 import { SpringProps, SpringValues } from '../types'
 
 import { useSpring } from './useSpring'
 
 export interface UseScrollOptions extends Omit<SpringProps, 'to' | 'from'> {
-  container?: MutableRefObject<HTMLElement>
+  container?: RefObject<HTMLElement>
 }
 
 /**
@@ -30,7 +30,7 @@ export interface UseScrollOptions extends Omit<SpringProps, 'to' | 'from'> {
   ```
  * 
  * @param {UseScrollOptions} useScrollOptions options for the useScroll hook.
- * @param {MutableRefObject<HTMLElement>} useScrollOptions.container the container to listen to scroll events on, defaults to the window.
+ * @param {RefObject<HTMLElement>} useScrollOptions.container the container to listen to scroll events on, defaults to the window.
  *
  * @returns {SpringValues<{scrollX: number; scrollY: number; scrollXProgress: number; scrollYProgress: number}>} SpringValues the collection of values returned from the inner hook
  */

diff --git a/packages/parallax/src/index.tsx b/packages/parallax/src/index.tsx
@@ -52,8 +52,8 @@ export interface IParallax {
   current: number
   controller: Controller<{ scroll: number }>
   layers: Set<IParallaxLayer>
-  container: React.MutableRefObject<any>
-  content: React.MutableRefObject<any>
+  container: React.RefObject<any>
+  content: React.RefObject<any>
   scrollTo(offset: number): void
   update(): void
   stop(): void

diff --git a/packages/types/src/utils.ts b/packages/types/src/utils.ts
@@ -23,7 +23,7 @@
  */
 
 import * as React from 'react'
-import { ReactElement, MutableRefObject } from 'react'
+import { ReactElement, RefObject } from 'react'
 
 /** Ensure each type of `T` is an array */
 export type Arrify<T> = [T, T] extends [infer T, infer DT]
@@ -139,7 +139,7 @@ export interface Disposable {
 }
 
 // react.d.ts
-export type RefProp<T> = MutableRefObject<T | null | undefined>
+export type RefProp<T> = RefObject<T | null | undefined>
 
 // https://github.com/DefinitelyTyped/DefinitelyTyped/issues/34237
 export type ElementType<P = any> =