@teipublisher/pb-components 2.15.3 → 2.17.0

package/pb-elements.json

@@ -5436,7 +5436,7 @@
     {
       "name": "pb-leaflet-map",
       "path": "./src/pb-leaflet-map.js",
-      "description": "A wrapper component for [leaflet](https://leafletjs.com/) displaying a map.\r\n\r\nThe map layers displayed can be configured via nested `pb-map-layer` (see docs) elements,\r\nicons via `pb-map-icon`.",
+      "description": "A wrapper component for [leaflet](https://leafletjs.com/) displaying a map.\n\nThe map layers displayed can be configured via nested `pb-map-layer` (see docs) elements,\nicons via `pb-map-icon`.",
       "attributes": [
         {
           "name": "latitude",
@@ -5475,7 +5475,7 @@
         },
         {
           "name": "toggle",
-          "description": "If enabled, the map will remain invisible until an event is received from `pb-geolocation`.\r\nIn this case the map also offers a close button to hide it again.",
+          "description": "If enabled, the map will remain invisible until an event is received from `pb-geolocation`.\nIn this case the map also offers a close button to hide it again.",
           "type": "boolean",
           "default": "false"
         },
@@ -5487,7 +5487,7 @@
         },
         {
           "name": "cluster",
-          "description": "If set, combine markers into clusters if they are located too close together\r\nto display as single markers",
+          "description": "If set, combine markers into clusters if they are located too close together\nto display as single markers",
           "type": "boolean",
           "default": "false"
         },
@@ -5499,9 +5499,15 @@
         },
         {
           "name": "disable-clustering-at",
-          "description": "Limits up to which zoom level markers are arranged into clusters.\r\nUsing a higher zoom level here will result in more markers to be shown.\r\n\r\nRequires `cluster` option to be enabled.",
+          "description": "Limits up to which zoom level markers are arranged into clusters.\nUsing a higher zoom level here will result in more markers to be shown.\n\nRequires `cluster` option to be enabled.",
           "type": "number"
         },
+        {
+          "name": "geo-coding",
+          "description": "Enables geocoding: an additional control will allow users to search for a place.\nReverse geocoding is also possible: single clicking on the map will request information\nabout the current location.\n\nIn both cases, a `pb-geocode` event will be emitted containing additional information\nabout the place in the event details (see demo).\n\nFor lookups the free OSM/Nominatim service is used.",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "subscribe",
           "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
@@ -5537,7 +5543,7 @@
       "properties": [
         {
           "name": "map",
-          "description": "The underlying leafletjs map. Can be used for custom scripts.\r\n\r\nWill be null until the component is fully loaded. Listen to `pb-ready` on the component to\r\nbe sure it has initialized."
+          "description": "The underlying leafletjs map. Can be used for custom scripts.\n\nWill be null until the component is fully loaded. Listen to `pb-ready` on the component to\nbe sure it has initialized."
         },
         {
           "name": "latitude",
@@ -5584,7 +5590,7 @@
         {
           "name": "toggle",
           "attribute": "toggle",
-          "description": "If enabled, the map will remain invisible until an event is received from `pb-geolocation`.\r\nIn this case the map also offers a close button to hide it again.",
+          "description": "If enabled, the map will remain invisible until an event is received from `pb-geolocation`.\nIn this case the map also offers a close button to hide it again.",
           "type": "boolean",
           "default": "false"
         },
@@ -5598,7 +5604,7 @@
         {
           "name": "cluster",
           "attribute": "cluster",
-          "description": "If set, combine markers into clusters if they are located too close together\r\nto display as single markers",
+          "description": "If set, combine markers into clusters if they are located too close together\nto display as single markers",
           "type": "boolean",
           "default": "false"
         },
@@ -5612,9 +5618,16 @@
         {
           "name": "disableClusteringAt",
           "attribute": "disable-clustering-at",
-          "description": "Limits up to which zoom level markers are arranged into clusters.\r\nUsing a higher zoom level here will result in more markers to be shown.\r\n\r\nRequires `cluster` option to be enabled.",
+          "description": "Limits up to which zoom level markers are arranged into clusters.\nUsing a higher zoom level here will result in more markers to be shown.\n\nRequires `cluster` option to be enabled.",
           "type": "number"
         },
+        {
+          "name": "geoCoding",
+          "attribute": "geo-coding",
+          "description": "Enables geocoding: an additional control will allow users to search for a place.\nReverse geocoding is also possible: single clicking on the map will request information\nabout the current location.\n\nIn both cases, a `pb-geocode` event will be emitted containing additional information\nabout the place in the event details (see demo).\n\nFor lookups the free OSM/Nominatim service is used.",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "subscribe",
           "attribute": "subscribe",
@@ -5660,7 +5673,7 @@
         },
         {
           "name": "pb-update-map",
-          "description": "When received, redraws the map to fit markers passed in with the event.\rEvent details should include an array of locations, see `pb-geolocation` event below."
+          "description": "When received, redraws the map to fit markers passed in with the event.\nEvent details should include an array of locations, see `pb-geolocation` event below."
         },
         {
           "name": "pb-update",
@@ -5668,7 +5681,11 @@
         },
         {
           "name": "pb-geolocation",
-          "description": "When received, focuses the map on the geocoordinates passed in with the event.\rThe event details should include an object:\r```\r{\rcoordinates: {\r latitude: Number,\r longitude: Number\r},\rlabel: string - the label to show on mouseover,\rzoom: Number - fixed zoom level to zoom to,\rfitBounds: Boolean - if true, recompute current zoom level to show all markers\r}\r```"
+          "description": "When received, focuses the map on the geocoordinates passed in with the event.\nThe event details should include an object:\n```\n{\ncoordinates: {\n latitude: Number,\n longitude: Number\n},\nlabel: string - the label to show on mouseover,\nzoom: Number - fixed zoom level to zoom to,\nfitBounds: Boolean - if true, recompute current zoom level to show all markers\n}\n```"
+        },
+        {
+          "name": "pb-geocode",
+          "description": "emitted if geocoding is enabled and the user searches or selects a location from the map"
         }
       ],
       "slots": [

package/src/pb-events.js

@@ -78,6 +78,44 @@ export class PbEvents {
         });
         document.dispatchEvent(ev);
     }
+
+    /**
+     * Wait for one or more TEI Publisher web components to become ready (by waiting for their `pb-ready` event).
+     * 
+     * @param {HTMLElement|HTMLElement[]} targets element or array of elements to check for ready state
+     * @returns Promise which resolves when all components are ready
+     */
+    static ifReady(targets) {
+        if (!Array.isArray(targets)) {
+            targets = [targets];
+        }
+        // const targets = Array.from(document.querySelectorAll(selector));
+        return new Promise((resolve) => {
+            const targetCount = targets.length;
+            if (targetCount === 0) {
+                // selector did not return any targets
+                resolve();
+                return;
+            }
+            let count = targetCount;
+            targets.forEach((target) => {
+                if (target._isReady) {
+                    count -= 1;
+                    if (count === 0) {
+                        resolve();
+                    }
+                    return;
+                }
+                const handler = target.addEventListener('pb-ready', () => {
+                    count -= 1;
+                    if (count === 0) {
+                        target.removeEventListener('pb-ready', handler);
+                        resolve();
+                    }
+                });
+            });
+        });
+    }
 }
 
 if (!window.pbEvents) {