@symfony/ux-leaflet-map 2.23.0 → 2.25.0

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2024-present Fabien Potencier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,24 @@
+# @symfony/ux-leaflet-map
+
+JavaScript assets of the [symfony/ux-leaflet-map](https://packagist.org/packages/symfony/ux-leaflet-map) PHP package.
+
+## Installation
+
+This npm package is **reserved for advanced users** who want to decouple their JavaScript dependencies from their PHP dependencies (e.g., when building Docker images, running JavaScript-only pipelines, etc.).
+
+We **strongly recommend not installing this package directly**, but instead  install the PHP package [symfony/ux-leaflet-map](https://packagist.org/packages/symfony/ux-leaflet-map) in your Symfony application with [Flex](https://github.com/symfony/flex) enabled.
+
+If you still want to install this package directly, please make sure its version exactly matches [symfony/ux-leaflet-map](https://packagist.org/packages/symfony/ux-leaflet-map) PHP package version:
+```shell
+composer require symfony/ux-leaflet-map:2.23.0
+npm add @symfony/ux-leaflet-map@2.23.0
+```
+
+**Tip:** Your `package.json` file will be automatically modified by [Flex](https://github.com/symfony/flex) when installing or upgrading a PHP package. To prevent this behavior, ensure to **use at least Flex 1.22.0 or 2.5.0**, and run `composer config extra.symfony.flex.synchronize_package_json false`.
+
+## Resources
+
+-   [Documentation](https://github.com/symfony/ux/tree/2.x/src/Map/src/Bridge/Google)
+-   [Report issues](https://github.com/symfony/ux/issues) and
+    [send Pull Requests](https://github.com/symfony/ux/pulls)
+    in the [main Symfony UX repository](https://github.com/symfony/ux)

package/dist/map_controller.d.ts

@@ -1,5 +1,5 @@
 import AbstractMapController from '@symfony/ux-map';
-import type { InfoWindowWithoutPositionDefinition, MarkerDefinition, Point, PolygonDefinition, PolylineDefinition } from '@symfony/ux-map';
+import type { Icon, InfoWindowWithoutPositionDefinition, MarkerDefinition, Point, PolygonDefinition, PolylineDefinition } from '@symfony/ux-map';
 import 'leaflet/dist/leaflet.min.css';
 import * as L from 'leaflet';
 import type { MapOptions as LeafletMapOptions, MarkerOptions, PolylineOptions as PolygonOptions, PolylineOptions, PopupOptions } from 'leaflet';
@@ -37,6 +37,10 @@ export default class extends AbstractMapController<MapOptions, L.Map, MarkerOpti
         definition: InfoWindowWithoutPositionDefinition<PopupOptions>;
         element: L.Marker | L.Polygon | L.Polyline;
     }): L.Popup;
+    protected doCreateIcon({ definition, element, }: {
+        definition: Icon;
+        element: L.Marker;
+    }): void;
     protected doFitBoundsToMarkers(): void;
 }
 export {};

package/dist/map_controller.js

@@ -2,6 +2,11 @@ import { Controller } from '@hotwired/stimulus';
 import 'leaflet/dist/leaflet.min.css';
 import * as L from 'leaflet';
 
+const IconTypes = {
+    Url: 'url',
+    Svg: 'svg',
+    UxIcon: 'ux-icon',
+};
 class default_1 extends Controller {
     constructor() {
         super(...arguments);
@@ -147,11 +152,14 @@ class map_controller extends default_1 {
         return map;
     }
     doCreateMarker({ definition }) {
-        const { '@id': _id, position, title, infoWindow, extra, rawOptions = {}, ...otherOptions } = definition;
+        const { '@id': _id, position, title, infoWindow, icon, extra, rawOptions = {}, ...otherOptions } = definition;
         const marker = L.marker(position, { title: title || undefined, ...otherOptions, ...rawOptions }).addTo(this.map);
         if (infoWindow) {
             this.createInfoWindow({ definition: infoWindow, element: marker });
         }
+        if (icon) {
+            this.doCreateIcon({ definition: icon, element: marker });
+        }
         return marker;
     }
     doRemoveMarker(marker) {
@@ -197,6 +205,35 @@ class map_controller extends default_1 {
         }
         return popup;
     }
+    doCreateIcon({ definition, element, }) {
+        const { type, width, height } = definition;
+        let icon;
+        if (type === IconTypes.Svg) {
+            icon = L.divIcon({
+                html: definition.html,
+                iconSize: [width, height],
+                className: '',
+            });
+        }
+        else if (type === IconTypes.UxIcon) {
+            icon = L.divIcon({
+                html: definition._generated_html,
+                iconSize: [width, height],
+                className: '',
+            });
+        }
+        else if (type === IconTypes.Url) {
+            icon = L.icon({
+                iconUrl: definition.url,
+                iconSize: [width, height],
+                className: '',
+            });
+        }
+        else {
+            throw new Error(`Unsupported icon type: ${type}.`);
+        }
+        element.setIcon(icon);
+    }
     doFitBoundsToMarkers() {
         if (this.markers.size === 0) {
             return;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@symfony/ux-leaflet-map",
   "description": "Leaflet bridge for Symfony UX Map, integrate interactive maps in your Symfony applications",
   "license": "MIT",
-  "version": "2.23.0",
+  "version": "2.25.0",
   "keywords": [
     "symfony-ux",
     "leaflet",
@@ -49,7 +49,7 @@
   },
   "devDependencies": {
     "@hotwired/stimulus": "^3.0.0",
-    "@symfony/ux-map": "2.23.0",
+    "@symfony/ux-map": "2.25.0",
     "@types/leaflet": "^1.9.12",
     "leaflet": "^1.9.4"
   }