在 TypeScript 中使用带有子项的 forwardRef 组件

IT技术 reactjs typescript jsx tsx
2021-05-25 12:18:19

使用 @types/react 16.8.2 和 TypeScript 3.3.1。

我直接从React 文档中提取了这个前向引用示例,并添加了几个类型参数:

const FancyButton = React.forwardRef<HTMLButtonElement>((props, ref) => (
  <button ref={ref} className="FancyButton">
    {props.children}
  </button>
));

// You can now get a ref directly to the DOM button:
const ref = React.createRef<HTMLButtonElement>();
<FancyButton ref={ref}>Click me!</FancyButton>;

我在最后一行中收到以下错误FancyButton

类型“ { children: string; ref: RefObject<HTMLButtonElement>; }”不可分配给类型“ IntrinsicAttributes & RefAttributes<HTMLButtonElement>”。children类型“ IntrinsicAttributes & RefAttributes<HTMLButtonElement>上不存在属性“ .ts(2322)

看起来 React.forwardRef 返回值的类型定义是错误的,没有正确合并 children 属性。如果我<FancyButton>自动关闭,错误就会消失。缺少此错误的搜索结果使我相信我遗漏了一些明显的东西。

3个回答

trevorsg,您需要传递按钮属性:

import * as React from 'react'

type ButtonProps = React.HTMLProps<HTMLButtonElement>

const FancyButton = React.forwardRef<HTMLButtonElement, ButtonProps>((props, ref) => (
  <button type="button" ref={ref} className="FancyButton">
    {props.children}
  </button>
))

// You can now get a ref directly to the DOM button:
const ref = React.createRef<HTMLButtonElement>()

<FancyButton ref={ref}>Click me!</FancyButton>

添加:

在 TS 和 @types/react 的最新版本中,您还可以使用React.ComponentPropsWithoutRef<'button'>代替React.HTMLProps<HTMLButtonElement>

aMarCruz 和 euvs 给出的答案都有效,但它们对消费者有点撒谎。他们说他们接受所有 HTMLButtonElement props,但他们忽略它们而不是将它们转发到按钮。如果你只是想正确地合并 children props,那么你可能想要使用 React.PropsWithChildren 代替:

import React from 'react';

interface FancyButtonProps {
    fooBar?: string; // my custom prop
}

const FancyButton = React.forwardRef<HTMLButtonElement, React.PropsWithChildren<FancyButtonProps>>((props, ref) => (
    <button type="button" ref={ref} className="fancy-button">
        {props.children}
        {props.fooBar}
    </button>
));

FancyButton.displayName = 'FancyButton';

或者明确添加一个 children props:

interface FancyButtonProps {
    children?: React.ReactNode;
    fooBar?: string; // my custom prop
}

const FancyButton = React.forwardRef<HTMLButtonElement, FancyButtonProps>((props, ref) => (
    <button type="button" ref={ref} className="fancy-button">
        {props.children}
        {props.fooBar}
    </button>
));

FancyButton.displayName = 'FancyButton';

或者,如果您确实想要接受所有按钮props并转发它们(例如,让消费者选择按钮类型 =“提交”),那么您可能需要使用 rest/spread:

import React from 'react';

interface FancyButtonProps extends React.ComponentPropsWithoutRef<'button'> {
    fooBar?: string; // my custom prop
}

const FancyButton = React.forwardRef<HTMLButtonElement, FancyButtonProps>(
    ({ children, className = '', fooBar, ...buttonProps }, ref) => (
        <button {...buttonProps} className={`fancy-button ${className}`} ref={ref}>
            {children}
            {fooBar}
        </button>
    ),
);

FancyButton.displayName = 'FancyButton';

aMarCruz 给出的答案效果很好。但是,如果您还需要将自定义props传递给FancyButton,则可以通过以下方式完成。

interface FancyButtonProps extends React.ComponentPropsWithoutRef<'button'> {
    fooBar?: string; // my custom prop
}

const FancyButton = React.forwardRef<HTMLButtonElement, FancyButtonProps>((props, ref) => (
    <button type="button" ref={ref} className="FancyButton">
        {props.children}
        {props.fooBar}
    </button>
));


/// Use later

// You can now get a ref directly to the DOM button:
const ref = React.createRef<HTMLButtonElement>()

<FancyButton ref={ref} fooBar="someValue">Click me!</FancyButton>

只需在此处添加即可完成。