README.md
June 7, 2024 Β· View on GitHub
Flutter MapLibre GL
Interactive, vector-tile, fully styleable maps for Flutter on Android, iOS and Web, powered by the open source MapLibre engines.
Vendor-neutral: host your own tiles or mix providers, no proprietary token required.
β¨ New: try the package live in your browser and browse the full docs, no setup or API keys required.
β¨ Quick start
flutter pub add maplibre_gl
import 'package:maplibre_gl/maplibre_gl.dart';
MapLibreMap(
initialCameraPosition: const CameraPosition(target: LatLng(0, 0), zoom: 2),
styleString: 'https://demotiles.maplibre.org/style.json',
);
Then head to the getting started guide for platform setup (iOS/Android permissions, the web <script> tag) and to learn how to add markers, layers, offline tiles and more.
Migrating from flutter-mapbox-gl? See the migration guide.
πΊοΈ Feature support
Engines: maplibre-native (Android/iOS), maplibre-gl-js (Web). Only a subset of native SDK APIs is exposed, PRs to extend coverage are welcome.
| Feature | Android | iOS | Web |
|---|---|---|---|
| Style, Camera, Gesture | β | β | β |
| User Location | β | β | β |
| Symbol / Circle / Line / Fill | β | β | β |
| Fill Extrusion | β | β | β |
| Heatmap Layer | β | β | β |
See the full feature matrix for details.
π€ Contributing
dart pub global activate melos
melos bootstrap
This is a melos workspace (maplibre_gl, maplibre_gl_web, maplibre_gl_platform_interface). Layer/source helpers are generated, don't edit them directly; run melos run generate && melos format-all. See CONTRIBUTING.md before opening a PR, and the architecture docs for an overview.
This project is a fork of flutter-mapbox-gl. β€οΈ
π Links
Example app Β· API reference Β· Changelog Β· Discussions Β· Issues Β· Slack
π Contributors
A huge thanks to everyone who has contributed to this project!
License
See LICENSE.