@open-pioneer/geolocation 0.9.0 → 0.10.0-dev.20250324141112

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @open-pioneer/geolocation
 
+## 0.10.0-dev.20250324141112
+
+### Minor Changes
+
+- 193068a: Deprecate the `mapId` property on React components.
+  Use the `MapModel` directly instead to pass a reference to the map.
+
+    Example:
+
+    ```tsx
+    // Default map for entire component tree
+    <DefaultMapProvider map={mapModel}>
+        <Toc />
+    </DefaultMapProvider>
+
+    // Map for specific component
+    <Toc map={mapModel} />
+    ```
+
+### Patch Changes
+
+- Updated dependencies [193068a]
+    - @open-pioneer/map@0.10.0-dev.20250324141112
+    - @open-pioneer/map-ui-components@0.10.0-dev.20250324141112
+
 ## 0.9.0
 
 ### Minor Changes

package/README.md

@@ -4,10 +4,12 @@ This package provides a geolocation component based on [OpenLayers](https://open
 
 ## Usage
 
-To add the component to your app, insert the following snippet with a reference to a map ID:
+To add the component to your app, insert the following snippet (with a reference to a map):
 
 ```jsx
-<Geolocation mapId="map_id" />
+<Geolocation
+    map={map}
+/> /* instead of passing the map, the `DefaultMapProvider` can alternatively be used */
 ```
 
 If the localization was successful, the map is centered on the user's position and zoomed to the accuracy of the localization.
@@ -18,13 +20,13 @@ Once a user zooms or moves the map, the map is no longer centered on new positio
 To adjust the maximum zoom level, add the optional property `maxZoom`.
 
 ```jsx
-<Geolocation mapId="map_id" maxZoom={20} />
+<Geolocation map={map} maxZoom={20} />
 ```
 
 To configure the style of the user's position and accuracy, add the optional properties `positionFeatureStyle` or `accuracyFeatureStyle`:
 
 ```tsx
-<Geolocation mapId="map_id" positionFeatureStyle={...} accuracyFeatureStyle={...} />
+<Geolocation map={map} positionFeatureStyle={...} accuracyFeatureStyle={...} />
 ```
 
 Both properties support arbitrary OpenLayers [`StyleLike`](https://openlayers.org/en/latest/apidoc/module-ol_style_Style.html#~StyleLike) values: you can configure either a single [Style](https://openlayers.org/en/latest/apidoc/module-ol_style_Style.html) instance, an array of them or a function computing such values.
@@ -60,7 +62,7 @@ function AppUI() {
     return (
         // ...
         <Geolocation
-            mapId={MAP_ID}
+            mad={map}
             positionFeatureStyle={POSITION_STYLE}
             accuracyFeatureStyle={ACCURACY_STYLE}
         />
@@ -72,7 +74,7 @@ To use custom position options from the [Geolocation API](https://www.w3.org/TR/
 
 ```jsx
 <Geolocation
-    mapId="map_id"
+    map={map}
     trackingOptions={{
         enableHighAccuracy: true,
         timeout: 60000,

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@open-pioneer/geolocation",
-  "version": "0.9.0",
+  "version": "0.10.0-dev.20250324141112",
   "description": "This package provides a component to locate a user's position.",
   "keywords": [
     "open-pioneer-trails"
@@ -24,8 +24,8 @@
     "ol": "^10.4.0",
     "react": "^19.0.0",
     "react-icons": "^5.3.0",
-    "@open-pioneer/map": "^0.9.0",
-    "@open-pioneer/map-ui-components": "^0.9.0"
+    "@open-pioneer/map": "^0.10.0-dev.20250324141112",
+    "@open-pioneer/map-ui-components": "^0.10.0-dev.20250324141112"
   },
   "exports": {
     "./package.json": "./package.json",