Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: missing index on LabelProps type #3939

Merged
merged 1 commit into from Nov 7, 2023
Merged

Conversation

ckifer
Copy link
Member

@ckifer ckifer commented Nov 7, 2023

Description

index is a valid property on Label although it is only used to reference which label is which in a LabelList

Related Issue

#3938

Motivation and Context

  • Removes a cast to any
  • Narrows type of LabelList correctly (anything that wasn't a property that could be used on SVGTextElement wasn't being used properly anyways. If this change breaks people they can mitigate by removing incorrectly used properties.

How Has This Been Tested?

  • Tests continue to pass
  • Imported type contains index property

Screenshots (if appropriate):

N/A

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • I have added a storybook story or extended an existing story to show my changes
  • All new and existing tests passed.

@@ -54,15 +54,15 @@ export function LabelList<T extends Data>({ valueAccessor = defaultAccessor, ...

return (
<Label
{...(filterProps(entry, true) as any)}
{...filterProps(entry, true)}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

Copy link
Contributor

@nikolasrieble nikolasrieble left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice and clean! 🚀

@nikolasrieble nikolasrieble merged commit 4d3c700 into recharts:master Nov 7, 2023
5 checks passed
@ckifer
Copy link
Member Author

ckifer commented Nov 7, 2023

Actually wild that the cast at the top caused no errors for the rest of the properties underneath

GMer78 pushed a commit to GMer78/recharts-1 that referenced this pull request Nov 24, 2023
<!--- Provide a general summary of your changes in the Title above -->

## Description

<!--- Describe your changes in detail -->
`index` is a valid property on `Label` although it is only used to
reference which label is which in a `LabelList`

## Related Issue

<!--- This project only accepts pull requests related to open issues -->
<!--- If suggesting a new feature or change, please discuss it in an
issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps
to reproduce -->
<!--- Please link to the issue here: -->
recharts#3938

## Motivation and Context

<!--- Why is this change required? What problem does it solve? -->
- Removes a cast to `any`
- Narrows type of `LabelList` correctly (anything that wasn't a property
that could be used on `SVGTextElement` wasn't being used properly
anyways. If this change breaks people they can mitigate by removing
incorrectly used properties.

## How Has This Been Tested?

<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran
to -->
<!--- see how your change affects other areas of the code, etc. -->
- Tests continue to pass
- Imported type contains `index` property
- 

## Screenshots (if appropriate):
N/A

## Types of changes

<!--- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->

- [X] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)

## Checklist:

<!--- Go over all the following points, and put an `x` in all the boxes
that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->

- [X] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have added tests to cover my changes.
- [ ] I have added a storybook story or extended an existing story to
show my changes
- [X] All new and existing tests passed.

Co-authored-by: Coltin Kifer <ckifer@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants