在 Typescript React App 中指定特定的道具并接受一般的 HTML 道具

Question

我有一个 React Wrapper 组件，它接受一些道具，但将所有其他道具转发给子组件（尤其是与 className、id 等原生道具相关）。

但是，当我传递原生道具时，Typescript 会抱怨。查看错误信息：

TS2339：类型上不存在属性“className” 'IntrinsicAttributes & IntrinsicClassAttributes & Readonly & 只读'。

我怎样才能得到一个带有特定 props 的组件也接受原生 props（ 不接受任何 props 并放弃类型检查）？

我的代码如下所示：

interface WrapperProps extends JSX.IntrinsicAttributes {
  callback?: Function
}

export class Wrapper extends React.Component<WrapperProps>{
  render() {
    const { callback, children, ...rest } = this.props;
    return <div {...rest}>
      {children}
    </div>;
  }
}

export const Test = () => {
  return <Wrapper className="test">Hi there</Wrapper>
}

仅供参考：我在这里发现了一个类似的问题，但答案基本上放弃了类型检查，我想避免这种情况：Link to SO-Question

Answer 1

我们可以看看div props 是如何定义的：

interface IntrinsicElements {
    div: React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>;
}

如果我们使用React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement> 作为基本类型，我们将拥有div 的所有属性。由于DetailedHTMLProps 只是将ref 添加到React.HTMLAttributes<HTMLDivElement>，我们可以使用它作为基本接口来获取所有div 属性：

interface WrapperProps extends React.HTMLAttributes<HTMLDivElement> {
  callback?: Function
}

export class Wrapper extends React.Component<WrapperProps>{
  render() {
    const { callback, children, ...rest } = this.props;
    return <div {...rest}>
      {children}
    </div>;
  }
}

export const Test = () => {
  return <Wrapper className="test">Hi there</Wrapper> // works now
}

Answer 2

我的一位同事想通了。在此处分享以扩大知名度：

interface ComponentPropTypes = {
  elementName?: keyof JSX.IntrinsicElements; // list of all native DOM components
  ...
}


// Function component
function Component({
  elementName: Component = 'div',
  ...rest,
  // React.HTMLAttributes<HTMLOrSVGElement>) provides all possible native DOM attributes
}: ComponentPropTypes & React.HTMLAttributes<HTMLOrSVGElement>)): JSX.Element {
  return <Component {...rest} />;
}

// Class component
class Component extends React.Component<ComponentPropTypes & React.HTMLAttributes<HTMLOrSVGElement>> {
  render() {
    const {
      elementName: Component,
      ...rest,
    } = this.props;
    return <Component {...rest} />
  }
}

Answer 3

JSX.IntrinsicElements 有这个信息，例如

const FooButton: React.FC<JSX.IntrinsicElements['button']> = props => (
  <button {...props} className={`foo ${props.className}`} />
)

// alternative...
const FooButton: React.FC<React.PropsWithoutRef<
  JSX.IntrinsicElements['button']
>> = props => <button {...props} className={`foo ${props.className}`} />

在react-typescript-cheatsheet 项目中发现了这一点。

Answer 4

查看ComponentProps、ComponentPropsWithRef 和ComponentPropsWithoutRef - 这将接受可以是"div"、"button" 或任何其他组件的通用输入。它将包括反应特定的道具，例如className：

import React, {
  forwardRef,
  ComponentPropsWithoutRef,
  ComponentProps,
  ComponentPropsWithRef
} from "react";

const ExampleDivComponent = forwardRef<
  HTMLDivElement,
  ComponentPropsWithoutRef<"div">
>(({ children, ...props }, ref) => {
  return (
    <div {...props} ref={ref}>
      {children}
    </div>
  );
});

<ExampleDivComponent
  className=""
  style={{ background: "green" }}
  tabIndex={0}
  onTouchStart={() => alert("touched")}
/>;

const ExampleButtonComponent: React.FC<ComponentProps<"button">> = ({
  children,
  ...props
}) => {
  return <button {...props}>{children}</button>;
};

<ExampleButtonComponent onClick={() => alert("clicked")} />;