有没有办法提取 JSX 元素的道具类型？

Question

我的意图是从给定的 JSX 元素中提取道具，这可能吗？

这几乎是我失败的尝试...... 在此先感谢您的帮助；）

function getComponentProps<T extends React.ReactElement>(element: T): ExtractProps<T>;

function Component({ name }: { name: string }) {
  return <h1>{name}</h1>;
}

type ExtractProps<TComponentOrTProps> = TComponentOrTProps extends React.ComponentType<infer TProps>
  ? TProps
  : TComponentOrTProps;

const componentProps = getComponentProps(<Component name="jon" />); //type is JSX.Element

Answer 1

在大多数情况下，你不能这样做。

在理论中，React.ReactElement 类型是泛型的，类型参数P 取决于道具。所以如果你有一个强类型元素，那么你可以向后工作。

type ElementProps<T extends React.ReactNode> = T extends React.ReactElement<infer P> ? P : never;

在现实中，只有通过 React.createElement 而不是 JSX 创建元素，才能获得正确的道具类型。

任何 JSX 元素 <Component name="John" /> 只会获得 JSX.Element 类型，它显然没有关于 props 的信息，所以你不能从它向后工作到 props 类型。

const e1 = React.createElement(
  Component,
  { name: 'John' }
)

type P1 = ElementProps<typeof e1> // type: {name: string}

console.log(getElementProps(e1)); // will log {name: "John"}

const e2 = <Component name="John" />

type P2 = ElementProps<typeof e2>  // type: any

console.log(getElementProps(e2)); // will log {name: "John"}

Playground Link

从不同的角度处理这种情况要容易得多。如果您的函数采用 Component 或 div 之类的组件而不是已解析的元素，则您将能够派生正确的道具类型。您可以将ComponentProps 实用程序类型用于函数和类组件，将JSX.IntrinsicElements 映射用于内置组件。

Answer 2

您可以使用任何组件提取道具的类型

React.ComponentProps<typeof T>

您可以参考此TS Playground 了解更多选项

import * as React from 'react';

type TProps = {
   name:string;
   age:number;
   isStackoverflow:boolean;
 }

const App = (props:TProps) => <div>Hello World</div>;

//You can extract any components props like this.
type AppProps = React.ComponentProps<typeof App>;

`

Answer 3

这对于getComponentProps(<Component name="jon" />); 是不可能的，因为写出的 JSX-Elements 总是导致 JSX.Element-type 没有提供任何您可以提取的额外类型信息。如果你从组件函数本身中提取它是可能的：

export function Component({ name }: { name: string}) {
    return <h1>{name}</h1>;
}

function getComponentProps<T extends (...args: any[]) => JSX.Element>(element: T): Parameters<T>[0] {
    return null as any;
}

const test = getComponentProps(Component); // { name: string;}

此解决方案使用实用程序类型parameter，它从函数中推断出所有参数。然后我们索引第一个参数，因为 prop 对象是纯 jsx 函数的第一个参数。不过，类组件需要不同的解决方案。