[TypeScript] Add DataConsumer type, and DataKey generics by PavelVanecek · Pull Request #6943 · recharts/recharts

PavelVanecek · 2026-02-01T06:29:41Z

Description

Put the dataKey prop in a shared interface, then reuse the interface. Adds generics, though for now they are all just any, any.

Related Issue

#6645

Motivation and Context

Breaking down #6867 into smaller, manageable chunks.

Summary by CodeRabbit

Refactor
- Updated TypeScript public types across many chart and axis components to add generic data/value parameters and a unified data consumer pattern, refining public props for Area, Bar, Line, Scatter, Pie, Radar, Treemap and axes.
Documentation
- Adjusted comment handling to exempt Treemap's one-dimensional prop from a two-dimensional comment.
Chores
- Simplified LineChart test setup and updated pre-push checks (replaced build step with type checking).

coderabbitai · 2026-02-01T06:29:57Z

Walkthrough

Generalizes chart data typing by introducing DataProvider/DataConsumer generics and migrating component-level dataKey typings into the new consumer/provider contracts; many public prop interfaces across cartesian, polar, and chart components were updated to include DataPointType/DataValueType generics.

Changes

Cohort / File(s)	Summary
Core types `src/util/types.ts`	Added `DataProvider<DataPointType>` and `DataConsumer<DataPointType, DataValueType>`; replaced `DataKey<T>` with `DataKey<DataPointType, DataValueType>`; made `BaseAxisProps`/`RenderableAxisProps` generic and tie them to `DataConsumer`.
Cartesian components `src/cartesian/Area.tsx`, `src/cartesian/Bar.tsx`, `src/cartesian/Brush.tsx`, `src/cartesian/Funnel.tsx`, `src/cartesian/Line.tsx`, `src/cartesian/Scatter.tsx`	Public props gained `DataPointType, DataValueType` generics and now extend or require `DataConsumer<..., ...>`; removed `dataKey` from public prop interfaces; added `DataConsumer` imports.
Axes `src/cartesian/XAxis.tsx`, `src/cartesian/YAxis.tsx`, `src/cartesian/ZAxis.tsx`, `src/polar/PolarAngleAxis.tsx`, `src/polar/PolarRadiusAxis.tsx`	Axis prop interfaces made generic (`DataPointType, DataValueType`) and now extend generic axis base types (`RenderableAxisProps`/`BaseAxisProps`).
Polar components `src/polar/Pie.tsx`, `src/polar/Radar.tsx`, `src/polar/RadialBar.tsx`	Added `DataConsumer` to public/internal prop types; removed public `dataKey` where applicable; introduced generics for data/value types.
Chart components `src/chart/Treemap.tsx`	`Props` and `computeNode` made generic; `data`, `dataKey`, and `nameKey` types updated to use `DataPointType, DataValueType`; `DataConsumer` added to props.
Utilities & tests `src/util/ChartUtils.ts`, `test/chart/LineChart.spec.tsx`	Replaced `RenderableAxisProps['type']` with `AxisDomainTypeInput` in ChartUtils; test updated to remove `Customized` wrapper.
Docs exceptions & hooks `omnidoc/commentSimilarityExceptions.ts`, `.husky/pre-push`	Added Treemap comment-similarity exception; pre-push hook replaced `build` with `check-types`.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Possibly related PRs

ChartData and DataProvider types have generics #6896 — Large, related change introducing the same core data-model generics and updating component signatures.
Tooltip positions are now a function instead of array #6844 — Related Treemap typing/generic updates touching Props and computeNode signatures.
Reducing storybooks #6681 — Related RadialBar typing changes intersecting InternalRadialBarProps modifications.

Suggested labels

typescript

Suggested reviewers

ckifer

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely summarizes the main changes: introducing a DataConsumer type and adding generics to DataKey across the codebase.
Description check	✅ Passed	The description is complete with all required template sections: Description (explains the core change), Related Issue (linked to `#6645`), Motivation and Context (references breaking down PR `#6867`), and key implementation details.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch DataConsumer

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

codecov · 2026-02-01T06:42:09Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.37%. Comparing base (866f061) to head (e72fc5f).
⚠️ Report is 8 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6943   +/-   ##
=======================================
  Coverage   91.37%   91.37%           
=======================================
  Files         505      505           
  Lines       37754    37754           
  Branches     5271     5271           
=======================================
  Hits        34497    34497           
  Misses       3248     3248           
  Partials        9        9

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov · 2026-02-01T06:44:08Z

Bundle Report

Changes will increase total bundle size by 2.15kB (0.08%) ⬆️. This is within the configured threshold ✅

Detailed changes

Bundle name	Size	Change
recharts/bundle-cjs	1.23MB	1.07kB (0.09%) ⬆️
recharts/bundle-es6	1.06MB	1.07kB (0.1%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: recharts/bundle-cjs

Assets Changed:

Asset Name	Size Change	Total Size	Change (%)
`util/types.js`	1.07kB	9.23kB	13.18% ⚠️

view changes for bundle: recharts/bundle-es6

Assets Changed:

Asset Name	Size Change	Total Size	Change (%)
`util/types.js`	1.07kB	8.82kB	13.89% ⚠️

github-actions · 2026-02-01T07:06:42Z

Staging Deployment Details

These deployments will remain available for 30 days.

To update snapshots: Comment /update-snapshots on this PR to automatically update the baseline screenshots.

coderabbitai

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

src/util/types.ts (1)

1354-1402: ⚠️ Potential issue | 🟡 Minor

Export DataConsumer and DataProvider from the public API entry point.

The DataProvider and DataConsumer interfaces have comprehensive JSDoc comments and clearly separate concerns between components that accept data arrays and those that extract values via dataKey. However, they are not exported from src/index.ts, yet they are extended by many exported components (Pie, Bar, Area, Line, Scatter, RadialBar, Radar, Brush, Treemap, ZAxis, and others).

Since users extending or typing these components would need to import from internal paths (recharts/util/types), this violates the guideline that all imports must use the public API entry point. Add these interfaces to the public API exports in src/index.ts to ensure proper API completeness.

github-actions · 2026-02-02T13:07:13Z

Staging Deployment Details

These deployments will remain available for 30 days.

To update snapshots: Comment /update-snapshots on this PR to automatically update the baseline screenshots.

PavelVanecek added 2 commits February 2, 2026 21:20

Add DataConsumer type, and DataKey generics

f6def39

chore: reorder pre-push script to run tests after build

e72fc5f

PavelVanecek force-pushed the DataConsumer branch from c484133 to e72fc5f Compare February 2, 2026 12:30

coderabbitai Bot reviewed Feb 2, 2026

View reviewed changes

PavelVanecek assigned ckifer Feb 4, 2026

ckifer approved these changes Feb 5, 2026

View reviewed changes

ckifer merged commit f4dc8d5 into main Feb 5, 2026
48 checks passed

PavelVanecek deleted the DataConsumer branch February 5, 2026 06:30

This was referenced Feb 16, 2026

Add generics to Bar #7015

Merged

Add optional explicit generics to graphical items and charts #7035

Merged

develra mentioned this pull request Jul 2, 2026

tsc memory + time regression in 3.9.0: 18× more type instantiations, 2.6× more memory #7523

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[TypeScript] Add DataConsumer type, and DataKey generics#6943

[TypeScript] Add DataConsumer type, and DataKey generics#6943
ckifer merged 2 commits into
mainfrom
DataConsumer

PavelVanecek commented Feb 1, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Feb 1, 2026 •

edited

Loading

Uh oh!

codecov Bot commented Feb 1, 2026 •

edited

Loading

Uh oh!

codecov Bot commented Feb 1, 2026 •

edited

Loading

Assets Changed:

Assets Changed:

Uh oh!

github-actions Bot commented Feb 1, 2026

Uh oh!

coderabbitai Bot left a comment

Uh oh!

github-actions Bot commented Feb 2, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Uh oh!

Conversation

PavelVanecek commented Feb 1, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issue

Motivation and Context

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Feb 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Uh oh!

codecov Bot commented Feb 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

codecov Bot commented Feb 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bundle Report

Affected Assets, Files, and Routes:

Assets Changed:

Assets Changed:

Uh oh!

github-actions Bot commented Feb 1, 2026

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Feb 2, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

PavelVanecek commented Feb 1, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Feb 1, 2026 •

edited

Loading

codecov Bot commented Feb 1, 2026 •

edited

Loading

codecov Bot commented Feb 1, 2026 •

edited

Loading