@geoql/v-maplibre 1.8.0 → 1.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -22,37 +22,63 @@
22
22
 
23
23
  ## Installation
24
24
 
25
+ The library has **two required dependencies**. Everything else is opt-in per feature.
26
+
25
27
  ```bash
26
28
  # pnpm (recommended)
27
- pnpm add @geoql/v-maplibre maplibre-gl @deck.gl/core @deck.gl/layers @deck.gl/mapbox @deck.gl/aggregation-layers @deck.gl/geo-layers @deck.gl/mesh-layers maplibre-gl-wind
29
+ pnpm add @geoql/v-maplibre maplibre-gl
28
30
 
29
31
  # npm
30
- npm install @geoql/v-maplibre maplibre-gl @deck.gl/core @deck.gl/layers @deck.gl/mapbox @deck.gl/aggregation-layers @deck.gl/geo-layers @deck.gl/mesh-layers maplibre-gl-wind
32
+ npm install @geoql/v-maplibre maplibre-gl
31
33
 
32
34
  # yarn
33
- yarn add @geoql/v-maplibre maplibre-gl @deck.gl/core @deck.gl/layers @deck.gl/mapbox @deck.gl/aggregation-layers @deck.gl/geo-layers @deck.gl/mesh-layers maplibre-gl-wind
35
+ yarn add @geoql/v-maplibre maplibre-gl
34
36
  ```
35
37
 
36
- > **Note:** All packages listed above are required peer dependencies. Without them, your build will fail with missing export errors.
38
+ That covers `VMap`, `VMarker`, `VPopup`, all controls (`VControl*`), and every MapLibre-native layer (`VLayerMaplibre*`).
37
39
 
38
- ### Additional Optional Dependencies
40
+ ### Optional peer dependencies
39
41
 
40
- Install these packages based on the features you need:
42
+ Add these **only** for the layers you actually use — picking what you need keeps your bundle lean:
41
43
 
42
44
  ```bash
43
- # Raster/COG layers (Cloud-Optimized GeoTIFF) requires deck.gl-raster ^0.6.0
44
- pnpm add @developmentseed/deck.gl-raster @developmentseed/deck.gl-geotiff @developmentseed/geotiff
45
+ # deck.gl baseVLayerDeckgl, VLayerDeckglScatterplot, VLayerDeckglArc,
46
+ # VLayerDeckglLine, VLayerDeckglPath, VLayerDeckglPolygon, VLayerDeckglSolidPolygon,
47
+ # VLayerDeckglGeojson, VLayerDeckglIcon, VLayerDeckglText, VLayerDeckglColumn,
48
+ # VLayerDeckglBitmap, VLayerDeckglPointCloud
49
+ pnpm add @deck.gl/core @deck.gl/layers @deck.gl/mapbox
45
50
 
46
- # COG Mosaic layers (client-side mosaicking of multiple COGs)
47
- pnpm add @developmentseed/deck.gl-raster @developmentseed/deck.gl-geotiff @developmentseed/geotiff
51
+ # Aggregation VLayerDeckglHeatmap, VLayerDeckglHexagon, VLayerDeckglGrid,
52
+ # VLayerDeckglGridCell, VLayerDeckglContour, VLayerDeckglScreenGrid
53
+ pnpm add @deck.gl/aggregation-layers
48
54
 
49
- # LiDAR viewer control
50
- pnpm add maplibre-gl-lidar
55
+ # Geo / tiles — VLayerDeckglTrips, VLayerDeckglMVT, VLayerDeckglTile,
56
+ # VLayerDeckglTile3D, VLayerDeckglTerrain, VLayerDeckglH3Hexagon,
57
+ # VLayerDeckglH3Cluster, VLayerDeckglS2, VLayerDeckglGeohash,
58
+ # VLayerDeckglQuadkey, VLayerDeckglGreatCircle, VLayerDeckglWMS
59
+ pnpm add @deck.gl/geo-layers
60
+
61
+ # 3D mesh — VLayerDeckglSimpleMesh, VLayerDeckglScenegraph
62
+ pnpm add @deck.gl/mesh-layers
63
+
64
+ # Cloud-Optimized GeoTIFF — VLayerDeckglCOG, VLayerDeckglMultiCOG, VLayerDeckglMosaic
65
+ pnpm add @developmentseed/deck.gl-geotiff @developmentseed/deck.gl-raster @developmentseed/geotiff @developmentseed/proj
66
+
67
+ # Zarr — VLayerDeckglZarr
68
+ pnpm add @developmentseed/deck.gl-zarr zarrita
51
69
 
52
- # Wind particle visualization
70
+ # Wind particles — VLayerDeckglWindParticle
53
71
  pnpm add maplibre-gl-wind
72
+
73
+ # LiDAR point cloud viewer — VControlLidar
74
+ pnpm add maplibre-gl-lidar
75
+
76
+ # Three.js starfield skybox for globe projections — VLayerMaplibreStarfield
77
+ pnpm add @geoql/maplibre-gl-starfield three
54
78
  ```
55
79
 
80
+ If you import a layer without its peer deps installed, your bundler will surface a `Cannot find module '...'` error — install the missing package(s) from the table above to resolve it.
81
+
56
82
  ## Quick Start
57
83
 
58
84
  ```vue