update type definition for ListItem.

[amarjeetalien]

The current type definition show error when using LitsItem and not passing the button flag. Which is very obvious from the below line:

declare const ListItem: OverridableComponent<ListItemTypeMap<{ button?: false }, 'li'>> &
  ExtendButtonBase<ListItemTypeMap<{ button: true }, 'div'>>;

• I have followed (at least) the PR section of the contributing guide.

button as false

Not passisng it

[mui-pr-bot]

No bundle size changes comparing f32d82e...67b0ae9

Generated by 🚫 dangerJS against 67b0ae9

[eps1lon]

Could you include the code that is failing please? The overloads are intended to not have any overlap so it's not obvious that this needs to be changed.

[amarjeetalien]

@eps1lon

Could you include the code that is failing please? The overloads are intended to not have any overlap so it's not obvious that this needs to be changed.

Code sample is as below:

const LegendButton = (legendColor: string) =>
  withStyles({
    root: {
      color: legendColor,
    },
    gutters: {
      paddingLeft: spaces[1],
      paddingRight: spaces[1],
    },
  })(ListItem);

const MyLegend: FC<{ legendColor: string }> = ({ legendColor}) => {
  const Legend = LegendButton(legendColor);

  return (
    <Legend> // build fails at this line with TSLint reporting error as shown in above screenshots
      <IconButton>
        <DotIcon />
      </IconButton>
      <ListItemText primary={legendName} />
    </Legend>
  );
};

It works only if I pass button.

<Legend button>

I tried something like below, but this also reports the error:

const isButton = false;
<Legend button={isButton}>

[eps1lon]

That is an issue with higher-order components and some of our typings. Essentially a duplicate of #15759. The underlying issue is microsoft/TypeScript#26591.

I recommend using withStyles(styles)(SomeMuiComponent) as SomeMuiComponent.