diff --git a/docs/upgrade-guide.md b/docs/upgrade-guide.md index 29810229f..934ed0600 100644 --- a/docs/upgrade-guide.md +++ b/docs/upgrade-guide.md @@ -5,6 +5,7 @@ - All imports from `react-map-gl` should be replaced with one of the following endpoints: + If using with `mapbox-gl@>=3.5.0`: import from `react-map-gl/mapbox` + If using with `mapbox-gl@<3.5.0`: import from `react-map-gl/mapbox-legacy` +- `maplibre-gl@<=3` is no longer supported. - Some TypeScript types have been renamed to align with the official types from the base map libraries: | Old name | New name | diff --git a/docs/whats-new.md b/docs/whats-new.md index 9690e30bd..48732daad 100644 --- a/docs/whats-new.md +++ b/docs/whats-new.md @@ -1,5 +1,19 @@ # What's new +## react-map-gl v8.0 + +Release date: Jan 2025 + +- First version to support Mapbox GL JS' official types and MapLibre GL JS v5. + This version fully separates the code that support each compatible map library: + + `react-map-gl/mapbox`: for use with `mapbox-gl>=3.5.0` + + `react-map-gl/maplibre`: for use with `maplibre-gl>=4` + + `react-map-gl/mapbox-legacy`: for use with `mapbox-gl` v1.x and v2.x and `@types/mapbox-gl` +- As a result, each endpoint now have slightly smaller bundle size and more precise types. +- Maplibre wrapper is expected to have better functionality and performance than v7 by utilizing an [upstream API](https://github.com/maplibre/maplibre-gl-js/issues/1545) for the React use case. + +For a full list of breaking changes, please visit the [upgrade guide](./upgrade-guide.md#upgrading-to-v80). + ## react-map-gl v7.1 Release date: June 2023