@teipublisher/pb-components 1.30.4 → 1.32.2

package/dist/pb-elements.json

@@ -2249,8 +2249,13 @@
     {
       "name": "pb-custom-form",
       "path": "./src/pb-custom-form.js",
-      "description": "A custom form element which loads the actual form from a server-side script using AJAX.\nEmits a `pb-search-resubmit` event when the form is submitted, signalling `pb-search` that\na search should be redone using the parameters passed.\n\nThe component is currently used to implement the additional search facets on the start page and\nsearch result page.",
+      "description": "A custom form element which loads the actual form from a server-side script using AJAX.\nEmits `pb-search-resubmit` and `pb-submit` events, signalling the receiver that it should\nrefresh.\n\nThe component is currently used to implement the additional search facets on the start and\nsearch result page. It can also be combined with `pb-split-list` to contain an additional form\nwith options.",
       "attributes": [
+        {
+          "name": "auto-submit",
+          "description": "Register event handlers on all inputs and submit the form\nautomatically if any of those changes. For button-like controls,\na submit is triggered on click, for text input on keyUp, and for\nall other form components on change.",
+          "type": "string"
+        },
         {
           "name": "url",
           "description": "The URL for the AJAX request. If a relative URL is passed, it will be resolved\nagainst the current API endpoint.",
@@ -2345,6 +2350,12 @@
         }
       ],
       "properties": [
+        {
+          "name": "autoSubmit",
+          "attribute": "auto-submit",
+          "description": "Register event handlers on all inputs and submit the form\nautomatically if any of those changes. For button-like controls,\na submit is triggered on click, for text input on keyUp, and for\nall other form components on change.",
+          "type": "string"
+        },
         {
           "name": "url",
           "attribute": "url",
@@ -2466,7 +2477,16 @@
       ],
       "events": [
         {
-          "name": "pb-custom-form-loaded"
+          "name": "pb-custom-form-loaded",
+          "description": "Fired before the element updates its content"
+        },
+        {
+          "name": "pb-search-resubmit",
+          "description": "Fired when the form is submitted"
+        },
+        {
+          "name": "pb-submit",
+          "description": "Fired when the form is submitted"
         },
         {
           "name": "pb-start-update",
@@ -3735,14 +3755,21 @@
         },
         {
           "name": "event",
+          "description": "Name of the event which triggers a pb-geolocation event, e.g. 'click'.\nDefault is 'mouseover'.",
           "type": "string",
           "default": "\"mouseover\""
         },
         {
           "name": "auto",
+          "description": "If set, add location to a map automatically upon load by\nemitting an event. If not set, locations are only added when\nthe configured event is triggered.",
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "zoom",
+          "description": "Zoom level to use for the map if it centers on the location.",
+          "type": "number"
+        },
         {
           "name": "key",
           "description": "The key to which this element is connected.",
@@ -3821,15 +3848,23 @@
         {
           "name": "event",
           "attribute": "event",
+          "description": "Name of the event which triggers a pb-geolocation event, e.g. 'click'.\nDefault is 'mouseover'.",
           "type": "string",
           "default": "\"mouseover\""
         },
         {
           "name": "auto",
           "attribute": "auto",
+          "description": "If set, add location to a map automatically upon load by\nemitting an event. If not set, locations are only added when\nthe configured event is triggered.",
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "zoom",
+          "attribute": "zoom",
+          "description": "Zoom level to use for the map if it centers on the location.",
+          "type": "number"
+        },
         {
           "name": "key",
           "attribute": "key",
@@ -4558,6 +4593,23 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "cluster",
+          "description": "If set, combine markers into clusters if they are located too close together\nto display as single markers",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "fit-markers",
+          "description": "If set, the map will automatically zoom so it can fit all the markers",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "disable-clustering-at",
+          "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": "subscribe",
           "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
@@ -4647,6 +4699,26 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "cluster",
+          "attribute": "cluster",
+          "description": "If set, combine markers into clusters if they are located too close together\nto display as single markers",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "fitMarkers",
+          "attribute": "fit-markers",
+          "description": "If set, the map will automatically zoom so it can fit all the markers",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "disableClusteringAt",
+          "attribute": "disable-clustering-at",
+          "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": "subscribe",
           "attribute": "subscribe",
@@ -4692,15 +4764,15 @@
         },
         {
           "name": "pb-update-map",
-          "description": "When received, redraws the map to fit markers passed in with the event"
+          "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",
-          "description": "When received, redraws the map to show markers for all pb-geolocation elements"
+          "description": "When received, redraws the map to show markers for all pb-geolocation elements found in the content of the pb-view"
         },
         {
           "name": "pb-geolocation",
-          "description": "When received, focuses the map on the geocoordinates passed in with the event"
+          "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```"
         }
       ],
       "slots": [
@@ -8852,6 +8924,136 @@
         }
       ]
     },
+    {
+      "name": "pb-split-list",
+      "path": "./src/pb-split-list.js",
+      "description": "Implements a list which is split into different categories \n(e.g. letters of the alphabet, countries ...).\nOnly one category is shown at a time unless the server reports\nno categories (e.g. if the number of items to display goes below\na defined threshold).\n\nThe server-side API endpoint should return a JSON object with two\nproperties:\n\n+ `categories`: an array of category descriptions: each item should \n  be an object with two properties: `category` - containing the name of the category\n  and `count` - containing a count of items available under this category.\n+ `items`: an array with the items to be shown for the currently selected\n  category. Those may contain HTML markup.",
+      "attributes": [
+        {
+          "name": "url",
+          "description": "Server-side API endpoint to retrieve items from",
+          "type": "string"
+        },
+        {
+          "name": "selected",
+          "description": "The initially selected category",
+          "type": "string"
+        },
+        {
+          "name": "subforms",
+          "description": "A CSS selector pointing to one or more `pb-custom-form`\ninstances. The element will collect additional parameters\nfrom those forms and includes them in the request to the server",
+          "type": "string"
+        },
+        {
+          "name": "subscribe",
+          "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
+          "type": "string"
+        },
+        {
+          "name": "subscribe-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to listen to.",
+          "type": "object"
+        },
+        {
+          "name": "emit",
+          "description": "The name of the channel to send events to.",
+          "type": "string"
+        },
+        {
+          "name": "emit-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to be dispatched.",
+          "type": "object"
+        },
+        {
+          "name": "wait-for",
+          "description": "A selector pointing to other components this component depends on.\nWhen method `wait` is called, it will wait until all referenced\ncomponents signal with a `pb-ready` event that they are ready and listening\nto events.",
+          "type": "string"
+        },
+        {
+          "name": "disabled",
+          "description": "Common property to disable the functionality associated with a component.\n`pb-highlight` and `pb-popover` react to this.",
+          "type": "boolean",
+          "default": "false"
+        }
+      ],
+      "properties": [
+        {
+          "name": "url",
+          "attribute": "url",
+          "description": "Server-side API endpoint to retrieve items from",
+          "type": "string"
+        },
+        {
+          "name": "selected",
+          "attribute": "selected",
+          "description": "The initially selected category",
+          "type": "string"
+        },
+        {
+          "name": "subforms",
+          "attribute": "subforms",
+          "description": "A CSS selector pointing to one or more `pb-custom-form`\ninstances. The element will collect additional parameters\nfrom those forms and includes them in the request to the server",
+          "type": "string"
+        },
+        {
+          "name": "subscribe",
+          "attribute": "subscribe",
+          "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
+          "type": "string"
+        },
+        {
+          "name": "subscribeConfig",
+          "attribute": "subscribe-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to listen to.",
+          "type": "object"
+        },
+        {
+          "name": "emit",
+          "attribute": "emit",
+          "description": "The name of the channel to send events to.",
+          "type": "string"
+        },
+        {
+          "name": "emitConfig",
+          "attribute": "emit-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to be dispatched.",
+          "type": "object"
+        },
+        {
+          "name": "waitFor",
+          "attribute": "wait-for",
+          "description": "A selector pointing to other components this component depends on.\nWhen method `wait` is called, it will wait until all referenced\ncomponents signal with a `pb-ready` event that they are ready and listening\nto events.",
+          "type": "string"
+        },
+        {
+          "name": "disabled",
+          "attribute": "disabled",
+          "description": "Common property to disable the functionality associated with a component.\n`pb-highlight` and `pb-popover` react to this.",
+          "type": "boolean",
+          "default": "false"
+        }
+      ],
+      "events": [
+        {
+          "name": "pb-submit",
+          "description": "when received, submit a request to the server and refresh"
+        },
+        {
+          "name": "pb-start-update",
+          "description": "sent before the element sends the request to the server"
+        },
+        {
+          "name": "pb-end-update",
+          "description": "sent after new content has been received"
+        }
+      ],
+      "cssProperties": [
+        {
+          "name": "--pb-categorized-list-columns",
+          "description": "the number of columns to display (default: 2)"
+        }
+      ]
+    },
     {
       "name": "pb-svg",
       "path": "./src/pb-svg.js",