Merge branch 'release/2.3.0'

CHANGELOG.md

@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file. The format
 
 ## [Unreleased]
 
+## [v2.3.0](https://github.com/studiometa/vue-mapbox-gl/compare/2.2.0...2.3.0) (2024-01-11)
+- Add `filterItemsCallback` props to `StoreLocator` component, that allow to filter the order of the items list.
+
 ## [v2.2.0](https://github.com/studiometa/vue-mapbox-gl/compare/2.1.1...2.2.0) (2023-09-15)
 
 ### Added

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@studiometa/vue-mapbox-gl-workspace",
   "private": true,
-  "version": "2.2.0",
+  "version": "2.3.0",
   "workspaces": [
     "packages/*"
   ],

packages/docs/components/StoreLocator/index.md

@@ -212,6 +212,13 @@ interface StoreLocatorClassesProp {
 }
 ```
 
+### `filterItemsCallback`
+
+- Type `Function|Boolean`
+- Default `false`
+
+Props to add a custom filtering on the `items` props. That is triggered on `onMapCreated` `onMapMoveend` event.
+
 ## Events
 
 ### `map-created`

packages/vue-mapbox-gl/components/StoreLocator/StoreLocator.vue

@@ -102,6 +102,15 @@
         };
       },
     },
+
+    /**
+     * Filter items callback function
+     * @type {Function}
+     */
+    filterItemsCallback: {
+      type: [Function, Boolean],
+      default: false,
+    },
   });
   const emit = defineEmits();
 
@@ -164,6 +173,10 @@
         return 0;
       });
 
+    if (props.filterItemsCallback && typeof props.filterItemsCallback === 'function') {
+      filteredItems.value = await props.filterItemsCallback(filteredItems.value, map.value);
+    }
+
     await nextTick();
     listIsLoading.value = false;
   }