Issues with typing Legend props

[isabelleli]

Issues with typing Legend props

[ckifer]

Might be related to #4382

As mentioned in the other issues, these types aren't in the best state right now.

This seems applicable: https://stackoverflow.com/a/65533906/8050147

This is probably an artifact of recharts still being on react v16 types, where you are on react 18 types.
React types will be upgraded in v3, but for now I'm not quite sure what you would do. See the other issue for what we did there, but I'm not sure that this is the same exact problem yet.

Just FYI LegendProps is to Legend and DefaultLegendContentProps is to DefaultLegendContent, so when you're using content DefaultLegendContent should be what is returned (rather than Legend)

And LegendProps should be used when spreading onto Legend

[ckifer]

Legend is the Legend component, its what is documented and expected to be used for a legend.

content in Legend is for rendering custom Legend content using what Legend calculates internally as input

DefaultLegendContent is what is returned normally, by default, by recharts. So

content={props => <DefaultLegendContent {...props} />} should result in the same result as not specifying content at all. Its mostly useful if you want to transform the data that DefaultLegendContent receives, but not really the display (or maybe you want to wrap the default content, etc.).

The names of the types are confusing, apologies for that. This has been around for a while

[ckifer]

Can you give a code example of where exactly you're trying to use the type (the usage matters)?

[isabelleli]

@ckifer Thanks for responding so quickly! Here's a sandbox demonstrating the error.

[ckifer]

  config: {
    legendProps?: Omit<LegendProps, "ref">;
    lines: Array<{
      key: string;
      legendValue: string;
    }>;
  };

This fixes your issue for now (you shouldn't need the ref)

[isabelleli]

@ckifer Ah gotcha, thanks for the suggested fix! Just out of curiosity, what is the difference and the intended use-cases between DefaultLegendContent and Legend?

[isabelleli]

Gotcha, thank you for explaining! I'll go ahead and close out this issue.