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

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @open-pioneer/search
 
+## 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
+
 ## 0.9.0
 
 ### Minor Changes

package/README.md

@@ -8,24 +8,27 @@ defined by the implementation of the search source.
 
 ## Usage
 
-To use the search in your app, insert the following snippet and reference a map ID and `sources` (sources to be searched on):
+To use the search in your app, insert the following snippet (and reference a map) and `sources` (sources to be searched on):
 
 ```tsx
-<Search mapId={MAP_ID} sources={searchsources} />
+<Search
+    map={map}
+    sources={searchsources}
+/> /* instead of passing the map, the `DefaultMapProvider` can alternatively be used */
 ```
 
 To change the typing delay, add the optional property `searchTypingDelay` (in ms).
 The default value is 200ms.
 
 ```tsx
-<Search mapId={MAP_ID} sources={searchsources} searchTypingDelay={500} />
+<Search map={map} sources={searchsources} searchTypingDelay={500} />
 ```
 
 To limit the maximum number of search results to be displayed per search source (group), configure the optional property `maxResultsPerGroup`.
 The default value is 5.
 
 ```tsx
-<Search mapId={MAP_ID} sources={searchsources} maxResultsPerGroup={10} />
+<Search map={map} sources={searchsources} maxResultsPerGroup={10} />
 ```
 
 To change the placeholder text of the search field, use the optional property `placeholder`:
@@ -44,7 +47,7 @@ from the parameter `SelectSearchEvent`.
 import { Search, SearchSelectEvent } from "@open-pioneer/search";
 // ...
 <Search
-    mapId={MAP_ID}
+    map={map}
     sources={datasources}
     onSelect={(event: SearchSelectEvent) => {
         // do something
@@ -104,7 +107,7 @@ class MySearchSource implements SearchSource {
 const searchsources: SearchSource[] = [new MySearchSource()];
 
 // In your JSX template:
-<Search mapId={MAP_ID} sources={searchsources} />;
+<Search map={map} sources={searchsources} />;
 ```
 
 The configured maximum number of `maxResultsPerGroup` is passed as `maxResults` inside the option parameter

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@open-pioneer/search",
-  "version": "0.9.0",
+  "version": "0.10.0-dev.20250324141112",
   "description": "This package provides a UI component to perform a search on given search sources.",
   "keywords": [
     "open-pioneer-trails"
@@ -23,7 +23,7 @@
     "classnames": "^2.3.2",
     "ol": "^10.4.0",
     "react": "^19.0.0",
-    "@open-pioneer/map": "^0.9.0"
+    "@open-pioneer/map": "^0.10.0-dev.20250324141112"
   },
   "exports": {
     "./package.json": "./package.json",