noChildrenProp

Diagnostic Category: lint/correctness/noChildrenProp

JSX and TSX

Since: v1.0.0

Sources:

Same as: react/no-children-prop

Description

Prevent passing of children as props.

When using JSX, the children should be nested between the opening and closing tags. When not using JSX, the children should be passed as additional arguments to React.createElement.

Examples

Invalid

<FirstComponent children={'foo'} />

code-block.jsx:1:17 lint/correctness/noChildrenProp ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ Avoid passing children using a prop
  
  > 1 │ <FirstComponent children={‘foo’} />
      │                 ^^^^^^^^
    2 │ 
  
  ℹ The canonical way to pass children in React is to use JSX elements

React.createElement('div', { children: 'foo' });

code-block.js:1:30 lint/correctness/noChildrenProp ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ Avoid passing children using a prop
  
  > 1 │ React.createElement(‘div’, { children: ‘foo’ });
      │                              ^^^^^^^^
    2 │ 
  
  ℹ The canonical way to pass children in React is to use additional arguments to React.createElement

How to configure

{
  "linter": {
    "rules": {
      "correctness": {
        "noChildrenProp": "error"
      }
    }
  }
}