no-underscore-react-props

Reports JSX props whose names start with _.

Rule details Problem

This rule reports any JSX attribute whose name begins with _.

Props are part of the public API

A leading _ reads like an internal field name. In JSX, that usually makes the call site harder to read.

Examples

Incorrect

<InventoryItemTooltip
  key="inventory-tooltip"
  _tooltipGradient={tooltipGradient}
/>

Correct

<InventoryItemTooltip
  key="inventory-tooltip"
  tooltipGradient={tooltipGradient}
/>

Related rules

require-react-component-keysRequires key props in JSX iteration contexts

prefer-read-only-propsKeeps React prop types read-only