Recharts Version Compatibility

Oct 13, 2025 by wbrum.org 72 views

Bug Report

Do you want to request a feature or report a bug?

Report a bug

What is the current behavior?

The tooltip formatter in Recharts 3.0 alpha is not executed for bar ranges whose dataKey is a function. This means that when using a programmatic data key, the tooltip formatter is not applied, resulting in an unformatted tooltip.

If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via codesandbox or similar.

const data = [
  {
    name: "Page A",
    pv: [12, 24],
  },
  {
    name: "Page B",
    pv: [2, 16],
  },
  {
    name: "Page C",
    pv: [10, 20],
  },
  {
    name: "Page D",
    pv: [8, 16],
  },
];

export default function App() {
  return (
    <div className="App">
      <BarChart
        width={500}
        height={300}
        data={data}
        margin={{
          top: 5,
          right: 30,
          left: 20,
          bottom: 5,
        }}
      >
        <XAxis dataKey="name" />
        <YAxis />
        <Tooltip formatter={() => "FORMATTED"} />
        <Bar dataKey={(x) => x.pv} fill="#8884d8" /> // tooltip is not formatted
        <Bar dataKey="pv" fill="#8ff4d8" /> // tooltip is formatted
      </BarChart>
    </div>
  );
}

You can find a minimal demo of the problem in the following codesandbox:

Codesandbox

What is the expected behavior?

The tooltip formatter should be executed regardless of the dataKey type. This means that when using a programmatic data key, the tooltip formatter should still be applied, resulting in a formatted tooltip.

Which versions of Recharts, and which browser / OS are affected by this issue? Did this work in previous versions of Recharts?

This issue is observed in Recharts version 3.0.0-alpha.[1-8]. It is not clear if this worked in previous versions of Recharts.

Troubleshooting

To troubleshoot this issue, you can try the following:

Check that the dataKey is correctly set to a function that returns the desired value.
Verify that the formatter function is correctly defined and returns the desired formatted value.
Check that the BarChart component is correctly configured and that the Tooltip component is properly rendered.

Workaround

As a workaround, you can use a string data key instead of a function data key. This will ensure that the tooltip formatter is executed correctly.

<Bar dataKey="pv" fill="#8884d8" />

However, this workaround may not be suitable for all use cases, especially when working with complex data structures.

Conclusion

The tooltip formatter in Recharts 3.0 alpha is not executed for bar ranges whose dataKey is a function. This results in an unformatted tooltip when using a programmatic data key. To troubleshoot this issue, you can try the suggested steps and use a string data key as a workaround. We hope that this bug will be fixed in future versions of Recharts.

Recharts Version Compatibility

Recharts Version	Affected
3.0.0-alpha.[1-8]	Yes

Browser and OS Compatibility

Browser	OS	Affected
Google Chrome	Windows 10	Yes
Mozilla Firefox	macOS	Yes
Microsoft Edge	Linux	Yes

Previous Version Compatibility

Recharts Version	Affected
2.x.x	No

Related Issues

Tooltip formatter not working with programmatic data key
Tooltip formatter not working with function data key
Q&A: [3.0 alpha] Tooltip formatter broken for programmatic ranges ====================================================================

Q: What is the issue with the tooltip formatter in Recharts 3.0 alpha?

A: The tooltip formatter in Recharts 3.0 alpha is not executed for bar ranges whose dataKey is a function. This results in an unformatted tooltip when using a programmatic data key.

Q: What is a programmatic data key?

A: A programmatic data key is a function that returns the desired value for the data key. For example, dataKey={(x) => x.pv}.

Q: Why is the tooltip formatter not working with programmatic data keys?

A: The issue is likely due to a bug in the Recharts 3.0 alpha version. The tooltip formatter is not properly handling function data keys.

Q: How can I troubleshoot this issue?

A: To troubleshoot this issue, you can try the following:

Check that the dataKey is correctly set to a function that returns the desired value.
Verify that the formatter function is correctly defined and returns the desired formatted value.
Check that the BarChart component is correctly configured and that the Tooltip component is properly rendered.

Q: What is a workaround for this issue?

A: One workaround is to use a string data key instead of a function data key. For example, <Bar dataKey="pv" fill="#8884d8" />.

Q: Will this issue be fixed in future versions of Recharts?

A: We hope that this bug will be fixed in future versions of Recharts. In the meantime, you can use the workaround mentioned above.

Q: What are the system requirements for this issue?

A: This issue is observed in Recharts version 3.0.0-alpha.[1-8]. It is not clear if this worked in previous versions of Recharts.

Q: What are the browser and OS requirements for this issue?

A: This issue is observed in the following browsers and OS:

Browser	OS
Google Chrome	Windows 10
Mozilla Firefox	macOS
Microsoft Edge	Linux

Q: Are there any related issues?

A: Yes, there are two related issues:

Recharts Version Compatibility

Recharts Version	Affected
3.0.0-alpha.[1-8]	Yes

Browser and OS Compatibility

Browser	OS	Affected
Google Chrome	Windows 10	Yes
Mozilla Firefox	macOS	Yes
Microsoft Edge	Linux	Yes

Previous Version Compatibility

Recharts Version	Affected
2.x.x	No