Reviewing files that changed from the base of the PR and between ebc6ded and 2753003.

• .github/workflows/ci.yml
• omnidoc/commentSimilarityExceptions.ts
• omnidoc/componentsWithInconsistentCommentsInApiDoc.ts
• omnidoc/generateApiDoc.spec.ts
• omnidoc/generateApiDoc.ts
• omnidoc/omnidoc.spec.ts
• src/cartesian/Brush.tsx
• src/cartesian/Funnel.tsx
• src/chart/AreaChart.tsx
• src/chart/BarChart.tsx
• src/chart/ComposedChart.tsx
• src/chart/FunnelChart.tsx
• src/chart/LineChart.tsx
• src/chart/PieChart.tsx
• src/chart/RadarChart.tsx
• src/chart/RadialBarChart.tsx
• src/chart/Sankey.tsx
• src/chart/ScatterChart.tsx
• src/chart/SunburstChart.tsx
• src/chart/Treemap.tsx
• src/component/DefaultLegendContent.tsx
• src/component/Label.tsx
• src/component/LabelList.tsx
• src/component/Legend.tsx
• src/component/ResponsiveContainer.tsx
• src/component/Tooltip.tsx
• src/shape/Sector.tsx
• src/shape/Trapezoid.tsx
• test/cartesian/Funnel.spec.tsx
• www/src/docs/api/BrushAPI.tsx
• www/src/docs/api/FunnelAPI.tsx
• www/src/docs/api/LabelAPI.tsx
• www/src/docs/api/LabelListAPI.tsx
• www/src/docs/api/LegendAPI.tsx
• www/src/docs/api/PieChartAPI.tsx
• www/src/docs/api/RadarChartAPI.tsx
• www/src/docs/api/RadialBarChartAPI.tsx
• www/src/docs/api/ResponsiveContainerAPI.tsx
• www/src/docs/api/SankeyAPI.tsx
• www/src/docs/api/Sector.ts
• www/src/docs/api/SectorAPI.tsx
• www/src/docs/api/Tooltip.ts
• www/src/docs/api/TooltipAPI.tsx
• www/src/docs/api/Trapezoid.ts
• www/src/docs/api/TrapezoidAPI.tsx
• www/src/docs/api/Treemap.ts
• www/src/docs/api/TreemapAPI.tsx
• www/src/docs/api/index.ts
• www/src/docs/exampleComponents/ComposedChart/BandedChart.tsx

• www/src/docs/api/Tooltip.ts
• www/src/docs/api/Trapezoid.ts
• www/src/docs/api/Treemap.ts
• omnidoc/componentsWithInconsistentCommentsInApiDoc.ts
• www/src/docs/api/Sector.ts

• GitHub Check: Build, Test, Pack

.github/workflows/ci.yml (1)

341-343: LGTM! Good visibility improvement.

These echo statements provide helpful visibility of the deployment URLs directly in the CI logs. The URL construction is correct and consistent with the PR comment logic below.

www/src/docs/api/LabelAPI.tsx (3)

1-1: LGTM! Import added for documentation linking.

The Link import from 'react-router' is correctly added to support cross-referencing the Text API documentation in the formatter description.

---

65-69: Excellent documentation improvement!

This clarification helps developers understand that formatter should return primitive values (string/number) suitable for the Text component, and directs them to the content prop for custom React components. The cross-reference to the Text API documentation is helpful.

---

106-106: Good type fix - aligns with default value.

Adding "middle" to the position type union is correct, as it aligns the type definition with the default value specified on line 115. This ensures type safety for the default position value.

www/src/docs/api/SankeyAPI.tsx (1)

278-278: LGTM! Documentation metadata addition.

The parentComponents field clearly documents that Sankey can be used within ResponsiveContainer, improving API discoverability.

test/cartesian/Funnel.spec.tsx (2)

3-3: LGTM! Correct usage of the public API.

The import of FunnelTrapezoidItem from the public API entry point aligns with coding guidelines and the expanded public API surface in this PR.

---

77-77: LGTM! Improved type safety for activeShape callback.

The callback is now correctly typed with FunnelTrapezoidItem, which provides better type information for accessing trapezoid-specific properties like x, y, height, upperWidth, etc.

src/component/Label.tsx (1)

86-90: LGTM! Clear documentation enhancement.

The expanded documentation clarifies the expected return type of formatter and guides users to use the content prop for custom components. This will help prevent misuse of the formatter prop.

src/cartesian/Funnel.tsx (1)

196-196: LGTM! Improved type safety.

Narrowing FunnelSvgProps to use SVGPathElement instead of the more generic SVGElement provides better type safety for event handlers and refs, since Funnel components render <path> elements.

www/src/docs/api/LabelListAPI.tsx (3)

1-1: LGTM! Enables internal documentation linking.

Adding the Link import from react-router enables cross-referencing the Text API in the formatter prop documentation, improving documentation navigation.

---

87-91: LGTM! Consistent documentation improvement.

The expanded formatter documentation aligns with the changes in Label.tsx and provides clear guidance about expected return types and alternatives for custom components.

---

125-125: LGTM! Position type includes "middle".

The position type union now explicitly includes "middle" as an allowed value, matching the actual implementation and default value.

www/src/docs/api/FunnelAPI.tsx (1)

298-299: LGTM! Documentation cleanup.

Removing deprecated metadata from onKeyPress and onKeyPressCapture props aligns the documentation with the current API state.

src/shape/Sector.tsx (1)

192-267: LGTM! Excellent API documentation expansion.

Refactoring SectorProps from an implicit extension to an explicit interface with comprehensive JSDoc documentation significantly improves the public API surface. Key benefits:

• All properties now have clear descriptions and default values
• Event handlers are explicitly typed for SVGPathElement
• Better IDE autocomplete and documentation
• Maintains backward compatibility through Partial<SectorProps> in the exported Props type

The documentation aligns with Storybook definitions, ensuring consistency across the codebase.

src/chart/LineChart.tsx (1)

10-10: LGTM! Documentation improvement.

Adding the @consumes ResponsiveContainerContext JSDoc tag documents the component's context dependencies, improving code clarity and maintainability. This aligns with similar documentation additions across other chart components in this PR.

src/chart/BarChart.tsx (1)

10-10: LGTM! Documentation annotation is consistent with the broader pattern.

The @consumes ResponsiveContainerContext annotation correctly documents that BarChart consumes the context provided by ResponsiveContainer. This aligns with the coordinated documentation updates across all chart components in this PR.

src/component/ResponsiveContainer.tsx (1)

248-249: LGTM! Correctly documents context provision.

The @provides ResponsiveContainerContext annotation accurately documents that this component provides the context consumed by chart components. This complements the @consumes annotations added throughout the codebase.

src/chart/RadarChart.tsx (1)

39-39: LGTM! Consistent documentation annotation.

The @consumes ResponsiveContainerContext annotation aligns with the pattern applied across all chart components in this PR.

omnidoc/generateApiDoc.spec.ts (1)

100-107: LGTM! Well-structured test for inline link conversion in prop descriptions.

This test appropriately verifies that inline {@link ComponentName} tags within prop descriptions are converted to React Router <Link> elements. It complements the existing test for component-level descriptions and follows the established testing patterns.

src/chart/FunnelChart.tsx (1)

10-10: LGTM! Consistent documentation annotation.

The @consumes ResponsiveContainerContext annotation aligns with the coordinated documentation updates across chart components.

src/chart/PieChart.tsx (1)

18-18: LGTM! Consistent documentation annotation.

The @consumes ResponsiveContainerContext annotation follows the established pattern for documenting context consumption in chart components.

www/src/docs/exampleComponents/ComposedChart/BandedChart.tsx (1)

55-55: LGTM! Correctly adapts to DefaultLegendContentProps API change.

The removal of the content parameter from the function signature aligns with the removal of this prop from DefaultLegendContentProps. The explicit type annotation improves type safety, and the function body continues to work correctly as it never used the content parameter.

www/src/docs/api/BrushAPI.tsx (2)

177-180: LGTM! Helpful documentation addition about synchronization behavior.

The new paragraph clearly explains that the Brush component synchronizes zooming and panning across charts that share the same syncId. This is valuable information for users implementing synchronized charts.

---

184-187: LGTM! Enhanced example links provide better coverage.

The expanded links array now includes both a basic Brush example and a synchronized Brush example, helping users discover and understand both use cases.

src/chart/Sankey.tsx (1)

1219-1219: LGTM: Documentation enhancement

The added JSDoc annotation clarifies that Sankey consumes ResponsiveContainerContext, which is consistent with similar documentation improvements across other chart components in this PR.

www/src/docs/api/PieChartAPI.tsx (1)

403-403: LGTM: API documentation metadata

Adding parentComponents: ['ResponsiveContainer'] documents the hierarchical relationship between PieChart and ResponsiveContainer, which will improve navigation and API documentation structure.

src/chart/AreaChart.tsx (1)

10-10: LGTM: Consistent documentation pattern

The JSDoc annotation documents ResponsiveContainerContext consumption, maintaining consistency with other chart components.

src/chart/ScatterChart.tsx (1)

10-10: LGTM: Documentation enhancement

Consistent with the pattern of documenting ResponsiveContainerContext consumption across chart components.

www/src/docs/api/RadarChartAPI.tsx (1)

403-403: LGTM: API documentation metadata

Documents the hierarchical relationship with ResponsiveContainer, consistent with similar API documentation enhancements.

src/chart/RadialBarChart.tsx (1)

18-18: LGTM: Documentation enhancement

Consistent documentation of ResponsiveContainerContext consumption across chart components.

omnidoc/omnidoc.spec.ts (2)

53-59: Good addition: Navigation mapping validation

This new test ensures that every component with autogenerated API docs has a corresponding entry in apiCates, preventing broken navigation links. This is a valuable validation that will catch documentation inconsistencies early.

---

46-51: Note: Skipped test

This test is skipped, which means autogenerated API docs coverage is not currently validated for all exported components. While this doesn't block the current PR, it might be worth addressing in a future iteration to ensure comprehensive API documentation coverage.

src/component/LabelList.tsx (1)

109-112: LGTM: Helpful documentation clarification

The added documentation clearly explains what the formatter function should return and provides guidance on when to use the content prop instead. This will help users understand the proper usage of this prop.

src/chart/ComposedChart.tsx (1)

10-10: LGTM! Clear documentation of context consumption.

The @consumes ResponsiveContainerContext annotation accurately documents that this chart component consumes the ResponsiveContainer context, which helps API documentation consumers understand the component's dependencies.

www/src/docs/api/ResponsiveContainerAPI.tsx (1)

190-203: LGTM! Comprehensive children components list.

The childrenComponents array properly documents all chart types that can be wrapped by ResponsiveContainer, enhancing the API documentation's discoverability.

www/src/docs/api/RadialBarChartAPI.tsx (1)

403-403: LGTM! Proper parent component documentation.

The parentComponents metadata correctly documents that RadialBarChart can be wrapped by ResponsiveContainer, improving API documentation completeness.

src/cartesian/Brush.tsx (1)

1052-1056: LGTM! Enhanced documentation with synchronization details.

The updated documentation clearly explains that the Brush synchronizes zooming and panning when charts use syncId, and provides helpful example links for users.

www/src/docs/api/SectorAPI.tsx (1)

1-209: LGTM! Well-structured API documentation for Sector.

The SectorAPI documentation is comprehensive, covering all geometric properties (cx, cy, innerRadius, outerRadius, angles, corners) and event handlers with clear descriptions and appropriate default values.

src/chart/SunburstChart.tsx (1)

381-383: LGTM! Context consumption documented.

The @consumes ResponsiveContainerContext annotation properly documents that SunburstChart consumes ResponsiveContainer context, maintaining consistency with other chart components in this PR.

www/src/docs/api/TrapezoidAPI.tsx (1)

1-190: LGTM! Complete API documentation for Trapezoid.

The TrapezoidAPI documentation thoroughly covers all properties including geometric dimensions (x, y, height, upperWidth, lowerWidth), animation settings, and mouse event handlers with clear descriptions and sensible defaults.

src/component/DefaultLegendContent.tsx (1)

89-92: No breaking usage found from the removal of the content prop from DefaultLegendContentProps.

Verification confirms the content prop was successfully removed from the DefaultLegendContentProps interface. Search results show no code references a content prop on DefaultLegendContent. The content prop is now properly located on the Legend component itself (Legend.tsx line 45), where it calls React.createElement(props.content as any, contentProps). The API change is complete and consistent with no orphaned references.

www/src/docs/api/TooltipAPI.tsx (1)

1-421: Comprehensive Tooltip API documentation.

The documentation is thorough with well-structured prop definitions, appropriate use of Link for internal navigation (e.g., line 95 linking to DefaultTooltipContent), and correct parent component associations including the newly supported Treemap.

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

1-112: Clean API index refactor.

The import and mapping updates are consistent with the new API documentation structure. Removing explicit .tsx extensions and using the canonical *API naming convention improves maintainability.

omnidoc/generateApiDoc.ts (2)

55-59: New components added to automated API docs generation.

The additions of Sector, Tooltip, Trapezoid, and Treemap to OMNIDOC_AUTOMATED_API_DOCS_COMPONENTS align with the PR objectives. The alphabetical ordering is maintained.

---

564-572: Improved link detection logic.

Splitting the link detection into hasLinkInDesc and hasLinkInProps makes the logic clearer and correctly handles the case where Link components can appear in either component descriptions or individual prop descriptions.

www/src/docs/api/TreemapAPI.tsx (1)

1-235: Comprehensive Treemap API documentation.

The documentation covers all relevant props including animation settings, data configuration, and event handlers. The parent/child component relationships correctly indicate that Treemap consumes ResponsiveContainer context and can contain a Tooltip.

www/src/docs/api/LegendAPI.tsx (2)

1-1: Enhanced content prop documentation with Link.

The addition of the Link import and the updated content prop description clearly explains the rendering behavior and appropriately links to DefaultLegendContent for users seeking the default implementation.

Also applies to: 41-53

---

80-83: Improved dimension prop documentation.

The updated descriptions for height and width now clearly explain that both CSS string values (like 100% or fit-content) and numeric values are accepted.

Also applies to: 210-213

src/shape/Trapezoid.tsx (1)

29-95: Well-documented prop interface.

The JSDoc additions for position props (x, y), dimension props (upperWidth, lowerWidth, height), animation prop (isUpdateAnimationActive), and all mouse event handlers provide clear documentation with appropriate @default tags. This enables the omnidoc tool to generate accurate API documentation.

omnidoc/commentSimilarityExceptions.ts (1)

161-191: Comprehensive Tooltip exception groups.

The new exception groups for Tooltip correctly distinguish its unique behaviors from other components: HTML content vs SVG, array-returning formatters, different itemSorter defaults, and unique position semantics.

src/chart/Treemap.tsx (2)

1023-1028: Component-level JSDoc with context annotations.

The @consumes ResponsiveContainerContext and @provides TooltipEntrySettings annotations enable the omnidoc tool to automatically determine parent/child component relationships, which is reflected in the generated TreemapAPI documentation.

---

383-396: Pre-existing any type usage in DataKey.

The DataKey<any> type annotations follow the existing pattern from src/util/types.ts, where the type is intentionally parameterized with any as a known exception while proper typing is being developed. This is a widespread pattern in the codebase (90+ instances) and should not be flagged. The documentation additions are correct.

src/component/Legend.tsx (2)

6-11: LGTM: Excellent documentation and type improvements.

The addition of the content prop with comprehensive documentation and the import of ContentType from DefaultLegendContent improves type safety and API clarity. The documentation clearly explains the three usage modes (default, React element, or function).

Also applies to: 98-109

---

115-123: LGTM: Width and height now support CSS string values.

Broadening width and height to accept number | string enables CSS values like "100%" or "fit-content", which improves flexibility. The corresponding logic change in getWidthOrHeight (line 181) from isNumber(height) to height != null correctly handles both types.

Also applies to: 177-181

src/component/Tooltip.tsx (1)

78-91: LGTM: Comprehensive documentation improvements.

The extensive documentation additions across all Tooltip props significantly improve API discoverability and usability. The explicit type signatures for formatter, itemSorter, labelFormatter, and style props make the API clearer and more maintainable.

Also applies to: 104-236, 263-268

Reviewing files that changed from the base of the PR and between 2753003 and 21daa28.

• src/chart/Treemap.tsx
• src/component/Tooltip.tsx
• www/src/docs/api/TooltipAPI.tsx
• www/src/docs/api/TreemapAPI.tsx

• www/src/docs/api/TreemapAPI.tsx
• src/chart/Treemap.tsx

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

src/component/Tooltip.tsx (4)

104-115: LGTM: Clear documentation for content prop.

The JSDoc clearly explains the three ways to use the content prop (default component, React element, or function) and includes a proper example link using HTTPS.

---

117-236: LGTM: Well-typed and documented prop additions.

The expanded prop definitions include proper TypeScript types with explicit function signatures and clear JSDoc comments. All types are properly specified without relying on any or type inference, following the coding guidelines.

---

259-259: LGTM: Consistent default value for wrapperStyle.

The addition of wrapperStyle: {} to the defaults is consistent with other style props (contentStyle, itemStyle, labelStyle) and matches the documented default value.

---

78-91: LGTM: Clear JSDoc additions for animation props.

The added documentation for allowEscapeViewBox, animationDuration, and animationEasing is clear and includes correct default values.