React报错之Cannot assign to 'current' because a read-only property

原文链接：https://bobbyhadz.com/blog/react-cannot-assign-to-current-because-read-only-property[1]

作者：Borislav Hadzhiev[2]

正文从这开始~

总览

当我们用一个null值初始化一个ref，但在其类型中不包括null时，就会发生"Cannot assign to 'current' because it is a read-only property"错误。为了解决该错误，请在ref的类型中包含null。比如说，const ref = useRef<string | null>(null) 。

react-cannot-assign-to-current-because-read-only.png

这里有个例子来展示错误是如何发生的。

// App.tsx
import {useEffect, useRef} from 'react';

const App = () => {
  const ref = useRef<string>(null);

  useEffect(() => {
    // ⛔️ Error: Cannot assign to 'current' because it is a read-only property.ts(2540)
    ref.current = 'hello';
  }, []);

  return (
    <div>
      <h2>hello world</h2>
    </div>
  );
};

export default App;

上面例子的问题在于，当我们将null作为初始值传递到useRef钩子中时，并且我们传递给钩子的泛型中没有包括null类型，我们创建了一个不可变的ref对象。

正确的泛型

为了解决该错误，我们必须在传递给钩子的泛型中包括null类型。

// App.tsx
import {useEffect, useRef} from 'react';

const App = () => {
  // 👇️ include null in the ref's type
  const ref = useRef<string | null>(null);

  useEffect(() => {
    ref.current = 'hello';
  }, []);

  return (
    <div>
      <h2>hello world</h2>
    </div>
  );
};

export default App;

在ref的类型中，我们使用联合类型来包括null类型，这使它成为可变ref对象。

现在这个例子中ref的类型是字符串或null，它的current属性可以赋值为这两种类型中的任意一种的值。

DOM元素

如果你的引用指向一个DOM元素，情况也是一样的。如果你需要改变ref的current属性的值，你必须将钩子的类型定为 const ref = useRef<HTMLElement | null>(null)。

注意，如果你不直接赋值给它的current属性，你不必在 ref 的类型中包含 null。

// App.tsx
import {useEffect, useRef} from 'react';

const App = () => {
  const ref = useRef<HTMLInputElement>(null);

  useEffect(() => {
    ref.current?.focus();
  }, []);

  return (
    <div>
      <input ref={ref} type="text" defaultValue="" />
    </div>
  );
};

export default App;

上述例子中的ref是用来聚焦input元素的。因为没有对其.current属性进行赋值，所以没有必要在其类型中包含null。

参考资料

[1]

https://bobbyhadz.com/blog/react-cannot-assign-to-current-because-read-only-property: https://bobbyhadz.com/blog/react-cannot-assign-to-current-because-read-only-property

[2]

Borislav Hadzhiev: https://bobbyhadz.com/about