🗺 Vue components for mapbox-gl
🗺 Vue 3 Mapbox GL
A small components library to use Mapbox GL in Vue 3 app.
Installation & usage
Have a look at the small guide for information on how to setup a simple map.
Components
The following components are available:
| Component | Description | Doc. |
|---|---|---|
| MapboxMap | Display a map with the given style. | ✅ |
| MapboxMarker | Display a simple or custom marker. | ✅ |
| MapboxCluster | Display a GeoJSON as clusters. | ✅ |
| MapboxGeocoder | Display a geocoder search input with the @mapbox/mapbox-gl-geocoder plugin. | ✅ |
| MapboxImage | Load an image to be used on the map. | ✅ |
| MapboxImages | Load multiple images to be used on the map. | ✅ |
| MapboxLayer | Display a layer on the map. | ❌ |
| MapboxNavigationControl | Display the map’s navigation controls | ✅ |
| MapboxPopup | Display a popup on the map | ✅ |
| MapboxSource | Load a source of data to be used on the map | ❌ |
Contributing
Installation
# Clone the project
git clone [email protected]:studiometa/vue-mapbox-gl.git
# Cd in the repository
cd vue-mapbox-gl
# Install dependencies
npm i
Useful commands
# Build for deployment
npm run build
# Test before deployment
npm run test
# Lint files
npm run lint
# Fix linting errors
npm run fix
Note
This project is a rewrite of a fork of openearth/vue2mapbox-gl and is published under the GNU GPL 3 license.