在 React 中，使用 TypeScript，如何使用 RefForwardingComponent 和 forwardRef 将 ref 传递给自定义组件？

Question

我正在尝试将 ref 传递给自定义组件（以便我可以将焦点设置到该组件）。

但我不断收到此错误

const RefComp: React.RefForwardingComponent<HTMLInputElement, Props>
Type '{ value: string; onChange: Dispatch<SetStateAction<string>>; ref: MutableRefObject<HTMLInputElement | undefined>; }'
is not assignable to type 'IntrinsicAttributes & Props & { children?: ReactNode; }'.
  Property 'ref' does not exist on type 'IntrinsicAttributes & Props & { children?: ReactNode; }'.ts(2322)

这是我的代码

import * as React from 'react';
import {useRef, useState, RefForwardingComponent, forwardRef} from 'react';

interface Props {
    value: string;
    onChange(event: string): void;
}

const RefComp: RefForwardingComponent<HTMLInputElement, Props> = forwardRef<
    HTMLInputElement,
    Props
>(({value, onChange}, ref) => (
    <input
        value={value}
        onChange={event => onChange(event.target.value)}
        ref={ref}
    />
));

export default function App() {
    const [val, setVal] = useState('');
    const inputRef = useRef<HTMLInputElement>();

    return (
        <div className="App">
            <RefComp value={val} onChange={setVal} ref={inputRef} />
            <p>{val}</p>
        </div>
    );
}

这是一个代码框 https://codesandbox.io/s/crimson-cdn-klfp5

如果我忽略错误，代码似乎可以正常工作。所以不知道为什么我会得到它......

谁能解释我为什么会收到这个错误，以及我如何解决它？ :)

编辑：

如 cmets 中所述，您可以通过将 ref 添加到您的道具来解决此问题。

import * as React from 'react';
import {
    useRef,
    useState,
    RefForwardingComponent,
    forwardRef,
    MutableRefObject,
} from 'react';

interface Props {
    value: string;
    onChange(event: string): void;
    ref?: MutableRefObject<HTMLInputElement | null>;
}

const RefComp: RefForwardingComponent<HTMLInputElement, Props> = forwardRef<
    HTMLInputElement,
    Props
>(({value, onChange}, ref) => (
    <input
        value={value}
        onChange={event => onChange(event.target.value)}
        ref={ref}
    />
));

export default function App() {
    const [val, setVal] = useState('');
    const inputRef = useRef<HTMLInputElement>(null);

    return (
        <div className="App">
            <RefComp value={val} onChange={setVal} ref={inputRef} />
            <p>{val}</p>
        </div>
    );
}

但这感觉不对。现在我们说 ref 既作为 props 的一部分，又作为传递给 forwardRef 的函数的第二个回调参数

如果我这样写，我的问题可能会更清楚

const RefComp: RefForwardingComponent<HTMLInputElement, Props> = forwardRef<
    HTMLInputElement,
    Props
>((props: Props, ref) => (
    <input
        value={props.value}
        onChange={event => props.onChange(event.target.value)}
        ref={ref /* here, props.ref is also available, but wouldn't work */ }
    />
));

编辑 2：

这是一个相关的问题

Typescript RefForwardingComponent not working

编辑 3：

我找到了相关的源代码。 https://github.com/DefinitelyTyped/DefinitelyTyped/blob/33f6179e0f25b0ca798ad89a667c0a27ea0c98dd/types/react/index.d.ts#L702

function forwardRef<T, P = {}>(Component: RefForwardingComponent<T, P>): ForwardRefExoticComponent<PropsWithoutRef<P> & RefAttributes<T>>;

所以forwardRef 函数返回一个ForwardRefExoticComponent<PropsWithoutRef<P> & RefAttributes<T>> 类型的组件。这是一个组件，它采用与RefAttributes<T> 相交的PropsWithoutRef<P> 类型的道具。这两种类型也在同一个文件中定义。

据我了解，第一个基本上只是从 P 中排除 ref（在我的原始示例中是 Props）。第二个定义为

interface RefAttributes<T> extends Attributes {
    ref?: Ref<T>;
}

鉴于这些信息，我真的不明白为什么我必须将ref 添加到我自己的Props 中。看起来forwardRef 真的应该为我做这件事——甚至实际上从我自己的Props 中删除ref...

有人可以解释一下这里发生了什么吗？

Answer 1

问题是RefComp 的类型定义错误。删除它（让 TypeScript 推断类型），代码就可以正常工作了。

import * as React from 'react';
import {useRef, useState, forwardRef} from 'react';

interface Props {
    value: string;
    onChange(event: string): void;
}

const RefComp = forwardRef<HTMLInputElement, Props>(
    ({value, onChange}, ref) => (
        <input
            value={value}
            onChange={event => onChange(event.target.value)}
            ref={ref}
        />
    ),
);

export default function App() {
    const [val, setVal] = useState('');
    const inputRef = useRef<HTMLInputElement>(null);

    React.useEffect(() => {
        if (inputRef.current) {
            inputRef.current.focus();
        }
    }, []);

    return (
        <div className="App">
            <RefComp value={val} onChange={setVal} ref={inputRef} />
            <p>{val}</p>
        </div>
    );
}

https://codesandbox.io/s/quizzical-liskov-bsruh