This update brings major breaking changes for all users.
We apologise for any difficulty this may cause and time you may spend migrating.
However, this update is a part of our aim to simplify this library, and should improve stability, readability, and performance for you in the long term. In addition, this will make the library much easier to maintain and add new functionality to through plugins and future features.
For a full list of changes, please see the full CHANGELOG, and make use of the old and new API reference.
Application Migration
Please refer to the sections below for information on how to migrate your application. This will contain the changes that most users may need to make, but not all changes.
This version requires a minimum of Flutter 3.3.0. Use flutter upgrade to update to this version.
Removed layers in favour of children
The layers (and nonRotatedLayers) properties on the FlutterMap widget have been removed without deprecation.
To migrate, replace layers
Removed LayerWidgets & LayerOptions in favour of Layers
All existing LayerWidgets & LayerOptions have been removed without deprecation.
To migrate, replace LayerOptions
Replaced onMapCreated with onMapReady inside MapOptions
The onMapCreated property inside the MapOptions object has been removed without deprecation.
To migrate, replace onMapCreated
Removed MapController().onReady
See . If this was necessary to await in your project (particularly in initState), you will need to migrate to using .
Plugin Migration
Unfortunately, migrating plugins that implement custom layers is more difficult than just renaming in many cases. In good news, the new system requires no complex registration, and will simplify your code.
Previously, state was updated through a StreamBuilder. Since v3, state is updated using setState. This means your tile layer is now just a widget, for all intents and purposes, and anything you put in build will automatically be rebuilt when the map state changes.
For more information, see .
To migrate, place any StreamBuilder implementation with the below code snippet, and the latest map state will automatically get passed down.
Your plugin may also now be able to be a StatelessWidget, which may increase performance and simplify your code!
In addition to that change:
Replaced MapState with FlutterMapState
The MapState class has been removed without deprecation.
To migrate, replace MapState with FlutterMapState. This is a name change due to internal reorganization of state management.
Replaced getPixelOrigin with pixelOrigin inside FlutterMapState
The getPixelOrigin method has been removed without deprecation.
To migrate, replace getPixelOrigin with pixelOrigin
with
children
, and also see
.
with
Layer
. Additionally, if you are currently using
children
, remove all
LayerWidget
wrappers.
with
onMapReady
. Note that the current
MapController
is no longer passed into the callback.
This method should only be used in particular circumstances, and avoided otherwise. See .
. This is a name change aimed to improve internal consistency.
@override
Widget build(BuildContext context) {
final mapState = FlutterMapState.maybeOf(context)!;
// Use `mapState` as necessary, for example `mapState.zoom`
}