no-children-only

Full Name in eslint-plugin-react-x

react-x/no-children-only

Full Name in @eslint-react/eslint-plugin

@eslint-react/no-children-only

Presets

• x
• recommended
• recommended-typescript
• recommended-type-checked

Description

Disallow the use of Children.only from the react package.

Using Children is uncommon and can lead to fragile code. See common alternatives.

Examples

Failing

import React, { Children } from "react";
 
interface MyComponentProps {
  children: React.ReactNode;
}
 
function MyComponent({ children }: MyComponentProps) {
  const element = Children.only(children);
  // ...
}

Implementation

• Rule source
• Test source

Further Reading

• React: Legacy React APIs Children

See Also

• no-children-count
  Prevents the use of Children.count from the react package.
• no-children-for-each
  Prevents the use of Children.forEach from the react package.
• no-children-map
  Prevents the use of Children.map from the react package.
• no-children-to-array
  Prevents the use of Children.toArray from the react package.