DocumentationRulesno-children-only

no-children-only

Rule category

Restriction.

What it does

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

Why is this bad?

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

Examples

Failing

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

Further reading