jsx-eslint/eslint-plugin-react

Rule proposal: disallow string interpolation for className

Aperta

#460 aperta il 22 feb 2016

 (1 commento) (4 reazioni) (0 assegnatari)JavaScript (2731 fork)batch import
help wantednew rule

Metriche repository

Star
 (9293 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Using string interpolation in classNames can make it difficult to determine whether some CSS is actually used in your project. To make this easier, some folks might want to enforce preventing string interpolation in classNames.

Bad:

function MyComponent({ someProp }) {
  const classNames = `my-component my-component-${someProp}`;

  return (
    <div className={classNames}>
      Hi mom
    </div>
  )
}

Bad:

function MyComponent({ someProp }) {
  const classNames = 'my-component my-component-' + someProp;

  return (
    <div className={classNames}>
      Hi mom
    </div>
  )
}

Bad:

function MyComponent({ someProp }) {
  const classNames = ['my-component'];
  classNames.push('my-component-' + someProp);

  return (
    <div className={classNames.join(' ')}>
      Hi mom
    </div>
  )
}

Good:

function MyComponent({ someProp }) {
  const classNames = ['my-component'];
  if (someProp === 'some-value') {
    classNames.push('my-component-some-value');
  } else if (someProp === 'another-value') {
    classNames.push('my-component-another-value');
  }

  return (
    <div className={classNames.join(' ')}>
      Hi mom
    </div>
  )
}

Of course, the classnames package can be useful here.

I don't know yet, but this may be useful for other props, so perhaps it could be configured for a list of props.

Guida contributor