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 strict strict-typescript strict-type-checked

Rule Details

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

Examples

Enforcing a single child

Using Children.only to assert that a component receives exactly one child is fragile. If you need to restrict children, consider documenting the prop type or using a different API design.

For example, if your component needs exactly one child element, you can type the prop as a single ReactElement instead of React.ReactNode:

// Recommended: type the children prop to enforce a single child at compile time
import { type ReactElement } from "react";

interface MyComponentProps {
  children: ReactElement;
}

function MyComponent({ children }: MyComponentProps) {
  return <div>{children}</div>;
}

// Problem: Using Children.only to enforce a single child
import React, { Children } from "react";

interface MyComponentProps {
  children: React.ReactNode;
}

function MyComponent({ children }: MyComponentProps) {
  const element = Children.only(children);
  // ...
}

Using a dedicated prop instead of children

If your component is designed to work with a single element, consider accepting it as a regular prop instead of children. This makes the API clearer and avoids runtime checks.

// Recommended: accept the single element as a named prop
import { type ReactElement } from "react";

interface ModalProps {
  content: ReactElement;
}

function Modal({ content }: ModalProps) {
  return <div className="modal">{content}</div>;
}

function App() {
  return <Modal content={<p>Hello, world!</p>} />;
}

Versions

Resources

• Rule Source
• Test Source
• Rule Changelog

Further Reading

• Legacy React APIs: Children

See Also

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