如何使用 TypeScript 为无状态的功能性 React 组件指定（可选）默认道具？

Question

我正在尝试在 Typescript 中创建一个带有可选 props 和 defaultProps 的无状态 React 组件（用于 React Native 项目）。这对于 vanilla JS 来说是微不足道的，但我不知道如何在 TypeScript 中实现它。

使用以下代码：

import React, { Component } from 'react';
import { Text } from 'react-native';

interface TestProps {
    title?: string,
    name?: string
}

const defaultProps: TestProps = {
    title: 'Mr',
    name: 'McGee'
}

const Test = (props = defaultProps) => (
    <Text>
        {props.title} {props.name}
    </Text>
);

export default Test;

调用<Test title="Sir" name="Lancelot" /> 会按预期呈现“Sir Lancelot”，但<Test /> 在应该输出时什么也没有 “麦基先生”。

非常感谢任何帮助。

Answer 1

对我来说，这看起来不像打字稿问题。

免责声明：我只用打字稿试过这个。

但是，问题在于 props 总是 存在（即使在没有传入任何内容时作为空对象）。不过，有两种解决方法。

不幸的是，第一个会扼杀您拥有的超级干净的无花括号语法，但让我们保留defaultProps。

interface TestProps {
    title?: string;
    name?: string;
}

const defaultProps: TestProps = {
    title: 'Mr',
    name: 'McGee'
}

const Test = (passedIn: TestProps) => {
    const props = Object.assign({}, defaultProps, passedIn);
    return (
        <p>
            {props.title} {props.name}
        </p>
    );
}

如果你有大量道具，另一种可能会有点麻烦的替代方法，但它可以让你保持原来的语法是这样的：

const Test = (props: TestProps) => (
    <Text>
        {props.title || 'Mr'} {props.name || 'McGee'}
    </Text>
);

希望这会有所帮助！

Answer 2

这是一个类似的问题和答案：React with TypeScript - define defaultProps in stateless function

import React, { Component } from 'react';
import { Text } from 'react-native';

interface TestProps {
    title?: string,
    name?: string
}

const defaultProps: TestProps = {
    title: 'Mr',
    name: 'McGee'
}

const Test: React.SFC<TestProps> = (props) => (
    <Text>
        {props.title} {props.name}
    </Text>
);

Test.defaultProps = defaultProps;

export default Test;

Answer 3

我发现最简单的方法是使用可选参数。请注意，defaultProps 最终将是 deprecated on functional components。

例子：

interface TestProps {
    title?: string;
    name?: string;
}

const Test = ({title = 'Mr', name = 'McGee'}: TestProps) => {
    return (
        <p>
            {title} {name}
        </p>
    );
}

Answer 4

我喜欢这样做：

type TestProps = { foo: Foo } & DefaultProps
type DefaultProps = Partial<typeof defaultProps>
const defaultProps = {
  title: 'Mr',
  name: 'McGee'
}

const Test = (props: Props) => {
  props = {...defaultProps, ...props}
  return (
    <Text>
      {props.title} {props.name}
    </Text>
  )
}

export default Test

Answer 5

将我的解决方案添加到锅中，我认为它为现有解决方案增加了额外的可读性和优雅度。

假设您有一个组件MyComponent，其中混合了必需和可选道具。我们可以将这些必需的和可选的 props 分离成两个接口，组合成组件的完整的 prop 接口，但只使用可选的一个来设置默认的 props：

import * as React from "react";

// Required props
interface IMyComponentRequiredProps {
  title: string;
}

// Optional props
interface IMyComponentOptionalProps {
  color: string;
  fontSize: number;
}

// Combine required and optional props to build the full prop interface
interface IMyComponentProps
  extends IMyComponentRequiredProps,
    IMyComponentOptionalProps {}

// Use the optional prop interface to define the default props
const defaultProps: IMyComponentOptionalProps = {
  color: "red",
  fontSize: 40,
};

// Use the full props within the actual component
const MyComponent = (props: IMyComponentProps) => {
  const { title, color, fontSize } = props;
  return <h1 style={{ color, fontSize }}>{title}</h1>;
};

// Be sure to set the default props
MyComponent.defaultProps = defaultProps;

export default MyComponent;

Answer 6

我可能错了，但是在第二个投票回复中传递函数的默认 prop 值可能会导致细微的错误或过度执行 useEffects（我没有足够的代表在那里回复，所以 here's a可重现的codesanbox）

即使这是一个非常人为的示例，并且在大多数情况下可能只是糟糕的组件设计，我也不止一次看到过这种情况，甚至打破了整页。