ReactJs：this.props.children 的 PropTypes 应该是什么？

Question

给定一个呈现其子级的简单组件：

class ContainerComponent extends Component {
  static propTypes = {
    children: PropTypes.object.isRequired,
  }

  render() {
    return (
      <div>
        {this.props.children}
      </div>
    );
  }
}

export default ContainerComponent;

问题：children prop 的 propType 应该是什么？

当我将它设置为一个对象时，当我使用带有多个子组件的组件时它会失败：

<ContainerComponent>
  <div>1</div>
  <div>2</div>
</ContainerComponent>

警告：失败的道具类型：无效的道具children 类型为array 提供给ContainerComponent，预期object。

如果我将它设置为一个数组，如果我只给它一个孩子，它会失败，即：

<ContainerComponent>
  <div>1</div>
</ContainerComponent>

警告：道具类型失败：对象类型的道具子对象无效 提供给 ContainerComponent，预期的数组。

请告知，我是否应该不费心对子元素进行 propTypes 检查？

Answer 1

使用oneOfType 或PropTypes.node 尝试类似的操作

import PropTypes from 'prop-types'

...

static propTypes = {
    children: PropTypes.oneOfType([
        PropTypes.arrayOf(PropTypes.node),
        PropTypes.node
    ]).isRequired
}

或

static propTypes = {
    children: PropTypes.node.isRequired,
}

Answer 2

对我来说，这取决于组件。如果您知道需要填充什么，那么您应该尝试使用以下方式指定独占或多种类型：

PropTypes.oneOfType 

如果你想引用一个 React 组件，那么你会寻找

PropTypes.element

虽然，

PropTypes.node

描述了可以渲染的任何东西——字符串、数字、元素或这些东西的数组。如果这适合你，那么这就是方式。

使用 非常 通用组件，可以有多种类型的子组件，您也可以使用以下内容 - 尽管请记住 eslint 和 ts 可能不满意这种缺乏特异性：

PropTypes.any

Answer 3

The PropTypes documentation 有以下内容

// Anything that can be rendered: numbers, strings, elements or an array
// (or fragment) containing these types.
optionalNode: PropTypes.node,

所以，您可以使用PropTypes.node 来检查对象或对象数组

static propTypes = {
   children: PropTypes.node.isRequired,
}

Answer 4

这里的答案似乎并没有完全涵盖检查孩子。 node 和 object 过于宽松，我想检查确切的元素。这是我最终使用的：

• 使用oneOfType([]) 允许单个或一组孩子
• 将shape 和arrayOf(shape({})) 分别用于单个子对象和一组子对象
• 对子元素本身使用oneOf

最后是这样的：

import PropTypes from 'prop-types'
import MyComponent from './MyComponent'

children: PropTypes.oneOfType([
  PropTypes.shape({
    type: PropTypes.oneOf([MyComponent]),
  }),
  PropTypes.arrayOf(
    PropTypes.shape({
      type: PropTypes.oneOf([MyComponent]),
    })
  ),
]).isRequired

这个问题帮助我更清楚地解决了这个问题：https://github.com/facebook/react/issues/2979

Answer 5

如果你想完全匹配一个组件类型，检查这个

MenuPrimary.propTypes = {
  children: PropTypes.oneOfType([
    PropTypes.arrayOf(MenuPrimaryItem),
    PropTypes.objectOf(MenuPrimaryItem)
  ])
}

如果您想完全匹配某些组件类型，请检查此

const HeaderTypes = [
  PropTypes.objectOf(MenuPrimary),
  PropTypes.objectOf(UserInfo)
]

Header.propTypes = {
  children: PropTypes.oneOfType([
    PropTypes.arrayOf(PropTypes.oneOfType([...HeaderTypes])),
    ...HeaderTypes
  ])
}

Answer 6

如果你想包含渲染道具组件：

  children: PropTypes.oneOfType([
    PropTypes.arrayOf(PropTypes.node),
    PropTypes.node,
    PropTypes.func
  ])

Answer 7

尝试自定义 propTypes ：

 const  childrenPropTypeLogic = (props, propName, componentName) => {
          const prop = props[propName];
          return React.Children
                   .toArray(prop)
                   .find(child => child.type !== 'div') && new Error(`${componentName} only accepts "div" elements`);
 };


static propTypes = {

   children : childrenPropTypeLogic

}

Fiddle

const {Component, PropTypes} = React;

 const  childrenPropTypeLogic = (props, propName, componentName) => {
             var error;
          var prop = props[propName];
    
          React.Children.forEach(prop, function (child) {
            if (child.type !== 'div') {
              error = new Error(
                '`' + componentName + '` only accepts children of type `div`.'
              );
            }
          });
    
          return error;
    };
    
  

class ContainerComponent extends Component {
  static propTypes = {
    children: childrenPropTypeLogic,
  }

  render() {
    return (
      <div>
        {this.props.children}
      </div>
    );
  }
}



class App extends Component {
   render(){
    return (
    <ContainerComponent>
        <div>1</div>
        <div>2</div>
      </ContainerComponent>
    )
   }
}

ReactDOM.render(<App /> , document.querySelector('section'))

<script src="https://cdnjs.cloudflare.com/ajax/libs/react/15.1.0/react.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/react/15.1.0/react-dom.min.js"></script>

<section />

Answer 8

例子：

import React from 'react';
import PropTypes from 'prop-types';

class MenuItem extends React.Component {
    render() {
        return (
            <li>
                <a href={this.props.href}>{this.props.children}</a>
            </li>
        );
    }
}

MenuItem.defaultProps = {
    href: "/",
    children: "Main page"
};

MenuItem.propTypes = {
    href: PropTypes.string.isRequired,
    children: PropTypes.string.isRequired
};

export default MenuItem;

图片：如果预期类型不同，则会在控制台中显示错误