Skip to content

CHANGELOG.md

Latest commit

 

History

History
121 lines (88 loc) · 7.99 KB

CHANGELOG.md

File metadata and controls

121 lines (88 loc) · 7.99 KB
Raw

Changelog

v5.2.0

Highcharts React v5.2.0 introduces full support for highcharts v13.0.0.

  • Capped the Highcharts peer dependency at v13 (^13.0.0).
  • Introduced DataTable and Palette option components.
  • Fixed Chart component's direct props and options merging.
  • Fixed Chart component's option resolution order so child components (e.g. <Title>) take precedence over direct props and options.
  • Fixed missing SeriesType export and improved generic typing for the Series component's type-specific fields.
  • Fixed Tooltip component incorrectly serializing a single data-hc-option child to tooltip.format instead of binding it to its named sub-option (e.g. pointFormat).
  • Surfaced the changelog in a few more places for better visibility.
  • Adjusted the Tooltip component docs to mention the useHTML default.

v5.1.0

v5.0.0

Highcharts React v5.0.0 introduces breaking changes to module import paths, ESM bundling, Vite compatibility, and type naming. See the v5 migration guide for quick migration steps.

Features

Bug fixes

  • Fixed missing TypeScript type definitions for several component options.
  • Removed incorrectly referenced source maps (closes highcharts/highcharts-react#568).
  • Fixed series updates to keep custom series props and avoid extra chart updates.
  • Fixed nested series options to correctly merge parent and child option objects.
  • Removed the type prop from dedicated series components (for example, LineSeries and ColumnSeries).
  • Fixed Highcharts.setOptions() to apply chart options globally.
  • Fixed mapped props generation to avoid injecting undefined values into options, preserving Highcharts defaults when props are omitted.
  • Fixed array types (closes highcharts/highcharts-react#559).
  • Fixed CSS-related types and doclet state generation (closes highcharts/highcharts-react#567).

v4.2.1

  • Fixed README.md elements alignment.

v4.2.0

v4.1.0

  • Official release of v4!
  • Removed indicators from /series directory
  • We have published a migration guide from v3
  • Please open issues and let us know where you would like us to take this next.

v4.0.0-beta.6

  • Added support for providing options as arrays. Closes highcharts/highcharts-react#532.
  • Replaced internal ref access with forwardRef to avoid React v18 warnings. Closes highcharts/highcharts-react#529.
  • Used Highcharts.merge to merge in new options when updating components
  • Call chart.update with oneToOne option set to true
  • Changed naming of files and exports in /series/ to have consistent casing with Highcharts.
  • Stock indicators have been moved from /series/ to /indicators/

v4.0.0-beta.5

  • Fixed issues with series components relying on bundles such as highcharts-more

v4.0.0-beta.4

  • Changed the container property for the passed ref to be the container element and not the internal ref
  • Added back containerProps prop from previous versions

v4.0.0-beta.3

  • Changed the type of the ref prop to React.ref
  • Removed debug logging by default. Logging can be enabled using the Logger object exported from i.e. Highcharts.jsx

v4.0.0-beta.2

  • Added the ref prop to the Chart components, which will be assigned to the chart instance and container element as in previous versions. Example:

    import { Chart } from '@highcharts/react';

function RefExample() {
  const ref = useRef();

  useEffect(() => {
    if (ref.current.chart) {
      // Do something with the chart instance
    }
  }, []);

  return <Chart ref={ref} />;
}

v4.0.0-beta.1

Initial beta of the reworked Highcharts React integration.