Remove documented but not available props by PavelVanecek · Pull Request #6584 · recharts/recharts

PavelVanecek · 2025-11-08T08:52:37Z

Description

Some of these we removed in 3.0 and some I don't know.

Related Issue

#6069

#6582

Summary by CodeRabbit

Documentation
- Removed internal, deprecated, and unused props from component API docs and clarified several descriptions to simplify public-facing docs.
Chores
- Streamlined Storybook stories to expose only public props by removing internal/deprecated story args and prop entries.
Tests
- Updated snapshot expectations to align with the reduced public prop surface across docs and stories.

coderabbitai · 2025-11-08T08:52:49Z

Walkthrough

Removed internal, deprecated, and unused Storybook argTypes and website API doc props across story files, props definitions, docs, and tests; fixed a wording and renamed xAxisId → yAxisId in YAxisProps.

Changes

Cohort / File(s)	Change Summary
Reference component stories `storybook/stories/API/cartesian/ReferenceDot.stories.tsx`, `storybook/stories/API/cartesian/ReferenceLine.stories.tsx`	Removed imports and default `argTypes` spreads for internal arg groups (`ReferenceComponentInternalArgs`, `InternalProps`) and adjusted story arg-type annotations.
Chart & shape stories `storybook/stories/API/chart/PieChart.stories.tsx`, `storybook/stories/API/polar/Pie.stories.tsx`, `storybook/stories/API/shapes/Sector.stories.tsx`	Removed `activeIndex` (Pie/PieChart) and removed animation/internal props and deprecated `dangerouslySetInnerHTML` from story `argTypes`.
Storybook props definitions `storybook/stories/API/props/ChartProps.ts`, `.../ReferenceComponentShared.ts`, `.../Styles.ts`, `.../TextProps.ts`, `.../TooltipProps.tsx`, `.../YAxisProps.ts`	Deleted several exported Storybook arg entries (e.g., `defaultShowTooltip`, `ReferenceComponentInternalArgs`, RadialBar `activeIndex`, `content` in TextProps, `viewBox`/`coordinate`/`payload`/`label` in TooltipProps); renamed `xAxisId` → `yAxisId` and updated description.
Website API docs `www/src/docs/api/...` (`Area.ts`, `Bar.ts`, `Brush.ts`, `Funnel.ts`, `LabelList.ts`, `Line.ts`, `Pie.ts`, `RadarChart.ts`, `ReferenceArea.ts`, `ReferenceDot.ts`, `ReferenceLine.ts`, `Scatter.ts`, `Tooltip.ts`)	Removed numerous deprecated/unused props from component API docs (examples: `points`, `data`, `layout`, `trapezoids`, `valueKey`, `clockWise`, `alwaysShow`, `xAxis`, `yAxis`, `isFront`, `viewBox`, `coordinate`, `payload`, `label`) and fixed minor description wording.
Tests / omnidoc snapshots `omnidoc/readApiDoc.spec.ts`, `omnidoc/readStorybookDoc.spec.ts`, `omnidoc/omnidoc.spec.ts`	Updated inline snapshots and expected prop lists to remove keys corresponding to deleted story/API props and adjusted missing-props snapshots accordingly.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Many files across stories, props, docs, and tests but edits are mostly deletions/renames.
Review attention recommended for:
- Consistency between story argTypes and website API docs for Reference* and Tooltip.
- The xAxisId → yAxisId rename and any downstream references.
- Updated omnidoc/test snapshots to ensure no missing expectations.

Possibly related PRs

omnidoc checks for non-existing but documented props #6582 — overlapping omnidoc snapshot and API surface removals.
OmniDoc #6552 — related Storybook argTypes and omnidoc reader changes.
zIndex #6479 — related Reference* internal prop removals/renames.

Suggested labels

enhancement

Suggested reviewers

ckifer

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	The description is minimal but incomplete. It lacks required sections like Motivation and Context, How Has This Been Tested, and checklist items.	Expand the description with detailed motivation/context explaining why these props need removal, testing approach, and check appropriate boxes in the types/checklist sections.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: removing documented but not available props from the codebase.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ 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 removing-outdated-props

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0328681 and 0b4dee4.

📒 Files selected for processing (27)

omnidoc/omnidoc.spec.ts (0 hunks)
omnidoc/readApiDoc.spec.ts (0 hunks)
omnidoc/readStorybookDoc.spec.ts (0 hunks)
storybook/stories/API/cartesian/ReferenceDot.stories.tsx (1 hunks)
storybook/stories/API/cartesian/ReferenceLine.stories.tsx (3 hunks)
storybook/stories/API/chart/PieChart.stories.tsx (0 hunks)
storybook/stories/API/polar/Pie.stories.tsx (0 hunks)
storybook/stories/API/props/ChartProps.ts (0 hunks)
storybook/stories/API/props/ReferenceComponentShared.ts (0 hunks)
storybook/stories/API/props/Styles.ts (0 hunks)
storybook/stories/API/props/TextProps.ts (0 hunks)
storybook/stories/API/props/TooltipProps.tsx (0 hunks)
storybook/stories/API/props/YAxisProps.ts (1 hunks)
storybook/stories/API/shapes/Sector.stories.tsx (0 hunks)
www/src/docs/api/Area.ts (1 hunks)
www/src/docs/api/Bar.ts (0 hunks)
www/src/docs/api/Brush.ts (0 hunks)
www/src/docs/api/Funnel.ts (0 hunks)
www/src/docs/api/LabelList.ts (0 hunks)
www/src/docs/api/Line.ts (0 hunks)
www/src/docs/api/Pie.ts (0 hunks)
www/src/docs/api/RadarChart.ts (0 hunks)
www/src/docs/api/ReferenceArea.ts (0 hunks)
www/src/docs/api/ReferenceDot.ts (0 hunks)
www/src/docs/api/ReferenceLine.ts (0 hunks)
www/src/docs/api/Scatter.ts (0 hunks)
www/src/docs/api/Tooltip.ts (1 hunks)

💤 Files with no reviewable changes (22)

www/src/docs/api/Line.ts
www/src/docs/api/Brush.ts
www/src/docs/api/Scatter.ts
omnidoc/readStorybookDoc.spec.ts
storybook/stories/API/props/ReferenceComponentShared.ts
storybook/stories/API/props/TooltipProps.tsx
storybook/stories/API/polar/Pie.stories.tsx
www/src/docs/api/Funnel.ts
www/src/docs/api/ReferenceDot.ts
www/src/docs/api/LabelList.ts
omnidoc/omnidoc.spec.ts
www/src/docs/api/Pie.ts
www/src/docs/api/Bar.ts
omnidoc/readApiDoc.spec.ts
storybook/stories/API/props/TextProps.ts
storybook/stories/API/props/Styles.ts
www/src/docs/api/ReferenceArea.ts
storybook/stories/API/props/ChartProps.ts
www/src/docs/api/ReferenceLine.ts
storybook/stories/API/chart/PieChart.stories.tsx
www/src/docs/api/RadarChart.ts
storybook/stories/API/shapes/Sector.stories.tsx

🚧 Files skipped from review as they are similar to previous changes (3)

storybook/stories/API/props/YAxisProps.ts
www/src/docs/api/Area.ts
www/src/docs/api/Tooltip.ts

🧰 Additional context used

🧬 Code graph analysis (1)

storybook/stories/API/cartesian/ReferenceLine.stories.tsx (1)

storybook/StorybookArgs.ts (1)

StorybookArgs (59-61)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

GitHub Check: Build, Test, Pack
GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (3)

storybook/stories/API/cartesian/ReferenceDot.stories.tsx (1)

9-9: LGTM! Clean removal of internal args.

The removal of ReferenceComponentInternalArgs from the import correctly reduces the Storybook API surface by removing internal props that were documented but not actually available to users.

storybook/stories/API/cartesian/ReferenceLine.stories.tsx (2)

7-7: LGTM! Properly removes internal props.

The removal of ReferenceComponentInternalArgs and InternalProps from the import correctly aligns with the PR objective to clean up undocumented props from the Storybook API surface.

9-9: Good refinement with more specific types.

The introduction of StorybookArgs type (which extends Args) for the prop definitions provides better type safety and is more semantically correct for Storybook arg type definitions.

Also applies to: 11-11, 31-31, 48-48

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 · 2025-11-08T12:17:03Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.53%. Comparing base (28760ce) to head (0b4dee4).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6584      +/-   ##
==========================================
- Coverage   94.56%   94.53%   -0.04%     
==========================================
  Files         491      491              
  Lines       41045    40760     -285     
  Branches     4752     4752              
==========================================
- Hits        38816    38531     -285     
  Misses       2224     2224              
  Partials        5        5

☔ 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 · 2025-11-08T12:17:26Z

Bundle Report

Bundle size has no change ✅

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)

storybook/stories/API/props/YAxisProps.ts (1)
50-50: Fix description to reference y-axis.

The padding description references "x-axis" but this is in YAxisProps and should say "y-axis" for consistency. This appears to be another copy-paste error similar to the one fixed in lines 6-7.

Apply this diff to fix the description:
-    description: 'Specify the padding of x-axis.',
+    description: 'Specify the padding of y-axis.',

🧹 Nitpick comments (1)

www/src/docs/api/Tooltip.ts (1)
141-141: Consider clarifying the active prop description.

The new wording "displayed even after onMouseLeave" is somewhat ambiguous. Consider rephrasing for better clarity and parallelism:
-          'If set true, the tooltip is displayed even after onMouseLeave. If set false, the tooltip is always hidden.',
+          'If set true, the tooltip is displayed (manual control). If set false, the tooltip is hidden.',
Or, if the intent is to emphasize mouse leave behavior:
-          'If set true, the tooltip is displayed even after onMouseLeave. If set false, the tooltip is always hidden.',
+          'If set true, the tooltip remains visible even after mouse leave. If set false, the tooltip is hidden.',

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c53c3db and 0328681.

📒 Files selected for processing (27)

omnidoc/omnidoc.spec.ts (0 hunks)
omnidoc/readApiDoc.spec.ts (0 hunks)
omnidoc/readStorybookDoc.spec.ts (0 hunks)
storybook/stories/API/cartesian/ReferenceDot.stories.tsx (1 hunks)
storybook/stories/API/cartesian/ReferenceLine.stories.tsx (3 hunks)
storybook/stories/API/chart/PieChart.stories.tsx (0 hunks)
storybook/stories/API/polar/Pie.stories.tsx (0 hunks)
storybook/stories/API/props/ChartProps.ts (0 hunks)
storybook/stories/API/props/ReferenceComponentShared.ts (0 hunks)
storybook/stories/API/props/Styles.ts (0 hunks)
storybook/stories/API/props/TextProps.ts (0 hunks)
storybook/stories/API/props/TooltipProps.tsx (0 hunks)
storybook/stories/API/props/YAxisProps.ts (1 hunks)
storybook/stories/API/shapes/Sector.stories.tsx (0 hunks)
www/src/docs/api/Area.ts (1 hunks)
www/src/docs/api/Bar.ts (0 hunks)
www/src/docs/api/Brush.ts (0 hunks)
www/src/docs/api/Funnel.ts (0 hunks)
www/src/docs/api/LabelList.ts (0 hunks)
www/src/docs/api/Line.ts (0 hunks)
www/src/docs/api/Pie.ts (0 hunks)
www/src/docs/api/RadarChart.ts (0 hunks)
www/src/docs/api/ReferenceArea.ts (0 hunks)
www/src/docs/api/ReferenceDot.ts (0 hunks)
www/src/docs/api/ReferenceLine.ts (0 hunks)
www/src/docs/api/Scatter.ts (0 hunks)
www/src/docs/api/Tooltip.ts (1 hunks)

💤 Files with no reviewable changes (22)

www/src/docs/api/Pie.ts
storybook/stories/API/props/ReferenceComponentShared.ts
www/src/docs/api/Scatter.ts
storybook/stories/API/props/TextProps.ts
www/src/docs/api/LabelList.ts
www/src/docs/api/ReferenceLine.ts
omnidoc/readApiDoc.spec.ts
www/src/docs/api/Funnel.ts
www/src/docs/api/Bar.ts
www/src/docs/api/ReferenceArea.ts
www/src/docs/api/RadarChart.ts
storybook/stories/API/props/ChartProps.ts
storybook/stories/API/polar/Pie.stories.tsx
storybook/stories/API/props/Styles.ts
storybook/stories/API/props/TooltipProps.tsx
omnidoc/readStorybookDoc.spec.ts
storybook/stories/API/chart/PieChart.stories.tsx
www/src/docs/api/Brush.ts
omnidoc/omnidoc.spec.ts
www/src/docs/api/ReferenceDot.ts
www/src/docs/api/Line.ts
storybook/stories/API/shapes/Sector.stories.tsx

🚧 Files skipped from review as they are similar to previous changes (3)

storybook/stories/API/cartesian/ReferenceLine.stories.tsx
www/src/docs/api/Area.ts
storybook/stories/API/cartesian/ReferenceDot.stories.tsx

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

GitHub Check: Build, Test, Pack
GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (2)

storybook/stories/API/props/YAxisProps.ts (1)

6-7: LGTM! Correct fix for copy-paste error.

The rename from xAxisId to yAxisId correctly fixes the property name for the YAxis component. This was clearly a copy-paste error where the XAxis property name was incorrectly used.

www/src/docs/api/Tooltip.ts (1)

1-254: No issues found—documentation change is accurate.

The verification confirms that viewBox, coordinate, payload, and label are intentionally excluded from the public TooltipProps API. The Tooltip component uses Omit<DefaultTooltipContentProps, PropertiesReadFromContext> (line 67) to explicitly remove these properties, which are instead managed internally via context and Redux state selectors. The documentation removal is correct and reflects the actual component API.

ckifer

🧹

ckifer · 2025-11-08T16:13:13Z

Oops conflicts

PavelVanecek force-pushed the removing-outdated-props branch from c53c3db to 0328681 Compare November 8, 2025 14:09

coderabbitai bot reviewed Nov 8, 2025

View reviewed changes

ckifer approved these changes Nov 8, 2025

View reviewed changes

Remove documented but not available props

0b4dee4

PavelVanecek force-pushed the removing-outdated-props branch from 0328681 to 0b4dee4 Compare November 9, 2025 00:24

PavelVanecek merged commit 3dbc8bb into main Nov 9, 2025
29 checks passed

PavelVanecek deleted the removing-outdated-props branch November 9, 2025 01:13

This was referenced Nov 9, 2025

Add margin support to Sankey and remove the doc from sunburst #6589

Merged

Remove more non-existent props from documentation #6590

Merged

Remove and rename all remaining documented but not existing props #6594

Merged

coderabbitai bot mentioned this pull request Nov 16, 2025

Omnidoc: Fix default props docs for Bar, Brush, ReferenceLine, Text, Treemap #6640

Merged

coderabbitai bot mentioned this pull request Nov 23, 2025

Omnidoc: fixing default values #6673

Merged

This was referenced Dec 28, 2025

[Omnidoc] Autogenerated docs for Rectangle, RadialBarChart, and Reference components #6831

Merged

[Omnidoc] Docs for Sector, Tooltip, Trapezoid, Treemap #6837

Merged

This was referenced Jan 13, 2026

Export useIsTooltipActive and useActiveTooltipCoordinate hooks hooks #6880

Merged

ChartData and DataProvider types have generics #6896

Merged

coderabbitai bot mentioned this pull request Feb 7, 2026

feat: add animationMatchBy prop for identity-based animation #6973

Open

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Remove documented but not available props#6584

Remove documented but not available props#6584
PavelVanecek merged 1 commit intomainfrom
removing-outdated-props

PavelVanecek commented Nov 8, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Nov 8, 2025 •

edited

Loading

Uh oh!

codecov bot commented Nov 8, 2025 •

edited

Loading

Uh oh!

codecov bot commented Nov 8, 2025

Uh oh!

coderabbitai bot left a comment

Uh oh!

ckifer left a comment

Uh oh!

ckifer commented Nov 8, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

PavelVanecek commented Nov 8, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issue

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Nov 8, 2025 • 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

Pre-merge checks and finishing touches

Uh oh!

codecov bot commented Nov 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

codecov bot commented Nov 8, 2025

Bundle Report

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

ckifer left a comment

Choose a reason for hiding this comment

Uh oh!

ckifer commented Nov 8, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

PavelVanecek commented Nov 8, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 8, 2025 •

edited

Loading

codecov bot commented Nov 8, 2025 •

edited

Loading