feat: export DefaultZIndexes and ZIndexLayer by ckifer · Pull Request #6599 · recharts/recharts

ckifer · 2025-11-10T07:38:29Z

Description

The first part of #6546 so we can merge that.

export DefaultZIndexes and ZIndexLayer

Related Issue

Motivation and Context

useful exports for z index

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

Summary by CodeRabbit

New Features
- Two new Z-index related exports are now publicly available for use.
Chores
- Version bumped to 3.4.1.

coderabbitai · 2025-11-10T07:38:41Z

Walkthrough

This pull request adds two new public exports (ZIndexLayer and DefaultZIndexes) to the main entry point, bumps the package version from 3.4.0 to 3.4.1, and updates test snapshots to reflect the expanded public API surface.

Changes

Cohort / File(s)	Summary
Public API exports `src/index.ts`	Added two new re-exports: `ZIndexLayer` from `./zIndex/ZIndexLayer` and `DefaultZIndexes` from `./zIndex/DefaultZIndexes`
Version update `package.json`	Bumped version from 3.4.0 to 3.4.1
Test snapshot `omnidoc/readProject.spec.ts`	Updated snapshot to include `DefaultZIndexes` and `ZIndexLayer` in the list of exported public symbols

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

The export additions are straightforward re-exports with no logic modifications
Version bump follows expected semver convention for new exports
Test snapshot updates are generated/expected changes reflecting the new public API
No control-flow, error-handling, or behavioral changes

Possibly related PRs

Add zIndex to bar background #6536: Main PR that initially exposed DefaultZIndexes and ZIndexLayer from the public API; this PR completes the public API exposure by adding the re-exports to the main entry point.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the main change: exporting two new public symbols (DefaultZIndexes and ZIndexLayer) from the module.
Description check	✅ Passed	The description covers most required sections: it describes the changes, explains motivation, and marks the correct change type. However, the Related Issue section lacks a direct link to the referenced PR, and testing/documentation sections are left empty without explanation.
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 z-index-exports

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.}

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ca65afb and 6c62ae2.

⛔ Files ignored due to path filters (1)

package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (3)

omnidoc/readProject.spec.ts (3 hunks)
package.json (1 hunks)
src/index.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

src/**/*.{js,jsx,ts,tsx}

📄 CodeRabbit inference engine (AGENTS.md)

Do not hardcode any user-facing strings or formatting choices in the library code; leave internationalization to library users

Files:

src/index.ts

🧠 Learnings (2)

📚 Learning: 2025-10-25T07:35:46.188Z

Learnt from: CR
Repo: recharts/recharts PR: 0
File: test/README.md:0-0
Timestamp: 2025-10-25T07:35:46.188Z
Learning: Applies to test/**/*.test.{ts,tsx} : Mock getBoundingClientRect using test/helper/MockGetBoundingClientRect.ts when rendering Recharts components (e.g., Tooltip, Legend, charts)

Applied to files:

src/index.ts

📚 Learning: 2025-10-25T07:36:02.229Z

Learnt from: CR
Repo: recharts/recharts PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-25T07:36:02.229Z
Learning: Recharts aims for simple, declarative, and composable charts; prioritize consistency, usability, performance, and accessibility

Applied to files:

src/index.ts
package.json

⏰ 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). (1)

GitHub Check: Build, Test, Pack

🔇 Additional comments (2)

src/index.ts (1)

113-115: LGTM!

The new exports follow the existing pattern and are correctly formatted. The placement maintains logical grouping within the file.

omnidoc/readProject.spec.ts (1)

36-36: LGTM! Test snapshots correctly updated.

The test snapshots properly reflect the new public API surface. Both DefaultZIndexes and ZIndexLayer appear in the full symbol list, while only DefaultZIndexes appears in the Variable-filtered list. This difference suggests ZIndexLayer may be a different symbol type (e.g., a type alias, interface, or function) rather than a variable, which is acceptable.

Also applies to: 130-130, 150-150

coderabbitai · 2025-11-10T07:53:27Z

package.json

 {
  "name": "recharts",
-  "version": "3.4.0",
+  "version": "3.4.1",


⚠️ Potential issue | 🟡 Minor

Semver: Use minor version bump (3.5.0) for new feature exports.

Adding new public exports (ZIndexLayer and DefaultZIndexes) is a backwards-compatible feature addition. Per semantic versioning conventions, this should increment the minor version (3.5.0) rather than the patch version (3.4.1), which is typically reserved for bug fixes.

Apply this diff:

- "version": "3.4.1", + "version": "3.5.0",

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

"version": "3.4.1",

"version": "3.5.0",

🤖 Prompt for AI Agents

In package.json around line 3, the version is set to "3.4.1" but the PR adds new public exports and should use a minor version bump; update the version string to "3.5.0" to reflect a backwards-compatible feature addition per semver conventions.

codecov · 2025-11-10T08:00:10Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.57%. Comparing base (ca65afb) to head (6c62ae2).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6599   +/-   ##
=======================================
  Coverage   94.57%   94.57%           
=======================================
  Files         491      491           
  Lines       40697    40699    +2     
  Branches     4772     4771    -1     
=======================================
+ Hits        38491    38493    +2     
  Misses       2201     2201           
  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-10T08:00:33Z

Bundle Report

Changes will increase total bundle size by 553 bytes (0.02%) ⬆️. This is within the configured threshold ✅

Detailed changes

Bundle name	Size	Change
recharts/bundle-cjs	1.12MB	398 bytes (0.04%) ⬆️
recharts/bundle-es6	966.7kB	113 bytes (0.01%) ⬆️
recharts/bundle-umd	509.37kB	42 bytes (0.01%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: recharts/bundle-es6

Assets Changed:

Asset Name	Size Change	Total Size	Change (%)
`index.js`	113 bytes	3.29kB	3.56%

view changes for bundle: recharts/bundle-umd

Assets Changed:

Asset Name	Size Change	Total Size	Change (%)
`Recharts.js`	42 bytes	509.37kB	0.01%

view changes for bundle: recharts/bundle-cjs

Assets Changed:

Asset Name	Size Change	Total Size	Change (%)
`index.js`	398 bytes	11.7kB	3.52%

feat: export DefaultZIndexes and ZIndexLayer

7c34ae3

ckifer requested a review from PavelVanecek November 10, 2025 07:38

3.4.1

4b85de5

PavelVanecek approved these changes Nov 10, 2025

View reviewed changes

fix: onmidoc snapshots

6c62ae2

coderabbitai bot reviewed Nov 10, 2025

View reviewed changes

ckifer merged commit 6d96b11 into main Nov 10, 2025
11 of 13 checks passed

ckifer deleted the z-index-exports branch November 10, 2025 08:01

coderabbitai bot mentioned this pull request Dec 29, 2025

Bars with different zIndexes render side by side #6832

Open

coderabbitai bot mentioned this pull request Jan 11, 2026

[Omnidoc] Generate the remaining docs #6869

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: export DefaultZIndexes and ZIndexLayer#6599

feat: export DefaultZIndexes and ZIndexLayer#6599
ckifer merged 3 commits intomainfrom
z-index-exports

ckifer commented Nov 10, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Nov 10, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot Nov 10, 2025

Uh oh!

codecov bot commented Nov 10, 2025 •

edited

Loading

Uh oh!

codecov bot commented Nov 10, 2025

Assets Changed:

Assets Changed:

Assets Changed:

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

ckifer commented Nov 10, 2025 • 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

Types of changes

Checklist:

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Nov 10, 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

Pre-merge checks and finishing touches

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Nov 10, 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 10, 2025

Bundle Report

Affected Assets, Files, and Routes:

Assets Changed:

Assets Changed:

Assets Changed:

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ckifer commented Nov 10, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 10, 2025 •

edited

Loading

codecov bot commented Nov 10, 2025 •

edited

Loading