Description

This updates the public API surface to include chart layout introspection hooks and their return types, and ensures they are documented/validated by omnidoc.
useChartLayout, useCartesianChartLayout, and usePolarChartLayout are exported from recharts, and now the related layout types are exported too: LayoutType, CartesianLayout, and PolarLayout.

• Public API exports

  • Added exports in src/index.ts for:
    • useChartLayout
    • useCartesianChartLayout
    • usePolarChartLayout
  • Added type exports in src/index.ts for:
    • LayoutType
    • CartesianLayout
    • PolarLayout

• Hook documentation source

  • Added/expanded JSDoc in src/context/chartLayoutContext.tsx for all three hooks so omnidoc can generate API pages with return semantics.

• Tests

  • Extended test/context/chartLayoutContext.spec.tsx with focused coverage for:
    • outside-chart behavior (undefined)
    • cartesian chart layout behavior
    • polar chart layout behavior
  • Tests import hooks from ../../src to validate public export usage.

• Docs wiring

  • Added the three hooks to API category mapping in www/src/docs/apiCates.ts.
  • Added API examples mapping entries in www/src/docs/apiExamples/index.tsx for:
    • useChartLayout, useCartesianChartLayout, usePolarChartLayout
    • LayoutType, CartesianLayout, PolarLayout
  • This satisfies omnidoc/example coverage and sitemap expectations.

// src/index.ts
export {
  useChartHeight,
  useChartWidth,
  useMargin,
  useChartLayout,
  useCartesianChartLayout,
  usePolarChartLayout,
} from './context/chartLayoutContext';

export type {
  CartesianLayout,
  PolarLayout,
  LayoutType,
  // ...
} from './util/types';

Related Issue

Export & document layout hooks:

• useChartLayout
• useCartesianChartLayout
• usePolarChartLayout

Motivation and Context

These hooks already existed internally but were not part of the package entrypoint/docs surface. Once the hooks became public, their return types also needed to be publicly exported to keep the API complete and type-safe for consumers. This change makes both hooks and their related layout types first-class public API.

How Has This Been Tested?

• Added targeted unit tests in test/context/chartLayoutContext.spec.tsx for public hook behavior across chart contexts.
• Ran focused omnidoc/website validation paths impacted by new exports and docs mappings.
• Ran:
  • npm run omnidoc
  • npm run test-omnidoc
  • npm run check-types-lib

Screenshots (if appropriate):

N/A (API/docs surface change)

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 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 VR test, or extended an existing story or VR test to show my changes