Skip to content

v8.0 what's new #2478

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Pessimistress merged 1 commit into from
Jan 28, 2025
Merged

v8.0 what's new #2478

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/upgrade-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
14 changes: 14 additions & 0 deletions docs/whats-new.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`
Copy link
Contributor

@chrisgervang chrisgervang Jan 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What will the old endpoint "react-map-gl" point to? If it's removed, should we note what to change it to?

Copy link
Collaborator Author

@Pessimistress Pessimistress Jan 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

react-map-gl no longer has any default export. This is noted in the upgrade guide.

- 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
Expand Down
Loading