react/jsx-sort-props

📝 Enforce props alphabetical sorting.

🔧 This rule is automatically fixable by the --fix CLI option.

Some developers prefer to sort props names alphabetically to be able to find necessary props easier at the later time. Others feel that it adds complexity and becomes burden to maintain.

Rule Details

This rule checks all JSX components and verifies that all props are sorted alphabetically. A spread attribute resets the verification. The default configuration of the rule is case-sensitive.

Examples of incorrect code for this rule:

<Hello lastName="Smith" firstName="John" />

Examples of correct code for this rule:

<Hello firstName="John" lastName="Smith" />;
<Hello tel={5555555} {...this.props} firstName="John" lastName="Smith" />;

Rule Options

...
"react/jsx-sort-props": [<enabled>, {
  "callbacksLast": <boolean>,
  "shorthandFirst": <boolean>,
  "shorthandLast": <boolean>,
  "multiline": "ignore" | "first" | "last",
  "ignoreCase": <boolean>,
  "noSortAlphabetically": <boolean>,
  "reservedFirst": <boolean>|<array<string>>,
  "sortFirst": <array<string>>,
  "locale": "auto" | "any valid locale"
}]
...

ignoreCase

When true the rule ignores the case-sensitivity of the props order.

Examples of correct code for this rule

<Hello name="John" Number="2" />

callbacksLast

When true, callbacks must be listed after all other props, even if shorthandLast is set :

<Hello tel={5555555} onClick={this._handleClick} />

shorthandFirst

When true, short hand props must be listed before all other props, but still respecting the alphabetical order:

<Hello active validate name="John" tel={5555555} />

shorthandLast

When true, short hand props must be listed after all other props (unless callbacksLast is set), but still respecting the alphabetical order:

<Hello name="John" tel={5555555} active validate />

multiline

Enforced sorting for multiline props

• ignore: Multiline props will not be taken in consideration for sorting.

• first: Multiline props must be listed before all other props (unless shorthandFirst is set), but still respecting the alphabetical order.

• last: Multiline props must be listed after all other props (unless either callbacksLast or shorthandLast are set), but still respecting the alphabetical order.

Defaults to ignore.

// 'jsx-sort-props': [1, { multiline: 'first' }]
<Hello
  classes={{
    greetings: classes.greetings,
  }}
  active
  validate
  name="John"
  tel={5555555}
/>

// 'jsx-sort-props': [1, { multiline: 'last' }]
<Hello
  active
  validate
  name="John"
  tel={5555555}
  classes={{
    greetings: classes.greetings,
  }}
/>

noSortAlphabetically

When true, alphabetical order is not enforced:

<Hello tel={5555555} name="John" />

reservedFirst

This can be a boolean or an array option.

When reservedFirst is defined, React reserved props (children, dangerouslySetInnerHTML - only for DOM components, key, and ref) must be listed before all other props, but still respecting the alphabetical order:

<Hello key={0} ref={johnRef} name="John">
  <div dangerouslySetInnerHTML={{__html: 'ESLint Plugin React!'}} ref={dangerDivRef} />
</Hello>

If given as an array, the array's values will override the default list of reserved props. Note: the values in the array may only be a subset of React reserved props.

With reservedFirst: ["key"], the following will not warn:

<Hello key={'uuid'} name="John" ref={johnRef} />

sortFirst

When sortFirst is defined as an array of prop names, those props must be listed before all other props, maintaining the exact order specified in the array. This option has the highest priority and takes precedence over all other sorting options (including reservedFirst, shorthandFirst, callbacksLast, and multiline).

The prop names in the array are matched case-sensitively by default, but respect the ignoreCase option when enabled.

Examples of incorrect code for this rule:

// 'jsx-sort-props': [1, { sortFirst: ['className'] }]
<Hello name="John" className="test" />

Examples of correct code for this rule:

// 'jsx-sort-props': [1, { sortFirst: ['className'] }]
<Hello className="test" name="John" />

// 'jsx-sort-props': [1, { sortFirst: ['className', 'id'] }]
<Hello className="test" id="test" name="John" />

// 'jsx-sort-props': [1, { sortFirst: ['className'], ignoreCase: true }]
<Hello classname="test" name="John" />

locale

Defaults to "auto", meaning, the locale of the current environment.

Any other string provided here may be passed to String.prototype.localeCompare - note that an unknown or invalid locale may throw an exception and crash.

When Not To Use It

This rule is a formatting preference and not following it won't negatively affect the quality of your code. If alphabetizing props isn't a part of your coding standards, then you can leave this rule off.