@teipublisher/pb-components 1.36.1 → 1.37.0

package/dist/pb-elements.json

@@ -2285,6 +2285,161 @@
         }
       ]
     },
+    {
+      "name": "pb-combo-box",
+      "path": "./src/pb-combo-box.js",
+      "description": "Provides a combo box, i.e. a combination of an input with a dropdown.\nItems to select from may be obtained from a remote data source.\n\nThe form control to be used (either a select or input) should be passed \nin the content of the element. If no control is provided, a simple `<input>`\nwill be created.",
+      "attributes": [
+        {
+          "name": "source",
+          "description": "A remote data source to use. The component will pass the text entered by the user\nin parameter `query`. It expects a JSON array of objects with each object describing\none item:\n\n```json\n{\n  \"text\": \"Text to show as label\",\n  \"value\": \"value-to-use\"\n}\n```",
+          "type": "string"
+        },
+        {
+          "name": "close-after-select",
+          "description": "Automatically close the dropdown once the user made a selection",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "preload",
+          "description": "Preload all items from the remote data source at startup",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "on-blur",
+          "description": "Name of the event to be emitted when the user leaves the form control",
+          "type": "string",
+          "default": "\"pb-combo-box-blur\""
+        },
+        {
+          "name": "on-change",
+          "description": "Name of the event to be emitted when the value of the form control has changed",
+          "type": "string",
+          "default": "\"pb-combo-box-change\""
+        },
+        {
+          "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": "renderItem",
+          "description": "Set a javascript function to be called whenever an item\nneeds to be rendered. The function will be passed the data\nobject of the current item as argument.",
+          "type": "Function"
+        },
+        {
+          "name": "theme",
+          "type": "string",
+          "default": "\"default\""
+        },
+        {
+          "name": "source",
+          "attribute": "source",
+          "description": "A remote data source to use. The component will pass the text entered by the user\nin parameter `query`. It expects a JSON array of objects with each object describing\none item:\n\n```json\n{\n  \"text\": \"Text to show as label\",\n  \"value\": \"value-to-use\"\n}\n```",
+          "type": "string"
+        },
+        {
+          "name": "closeAfterSelect",
+          "attribute": "close-after-select",
+          "description": "Automatically close the dropdown once the user made a selection",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "preload",
+          "attribute": "preload",
+          "description": "Preload all items from the remote data source at startup",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "renderFunction",
+          "type": "object",
+          "default": "\"renderDefault\""
+        },
+        {
+          "name": "onBlur",
+          "attribute": "on-blur",
+          "description": "Name of the event to be emitted when the user leaves the form control",
+          "type": "string",
+          "default": "\"pb-combo-box-blur\""
+        },
+        {
+          "name": "onChange",
+          "attribute": "on-change",
+          "description": "Name of the event to be emitted when the value of the form control has changed",
+          "type": "string",
+          "default": "\"pb-combo-box-change\""
+        },
+        {
+          "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"
+        }
+      ]
+    },
     {
       "name": "pb-custom-form",
       "path": "./src/pb-custom-form.js",
@@ -3487,6 +3642,18 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "reference-strip",
+          "description": "If set, thumbnails of all images are shown in a reference strip at the\nbottom of the viewer.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "reference-strip-size-ratio",
+          "description": "Size ratio for the reference strip thumbnails. 0.2 by default.",
+          "type": "number",
+          "default": "0.2"
+        },
         {
           "name": "src",
           "type": "string",
@@ -3610,6 +3777,20 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "referenceStrip",
+          "attribute": "reference-strip",
+          "description": "If set, thumbnails of all images are shown in a reference strip at the\nbottom of the viewer.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "referenceStripSizeRatio",
+          "attribute": "reference-strip-size-ratio",
+          "description": "Size ratio for the reference strip thumbnails. 0.2 by default.",
+          "type": "number",
+          "default": "0.2"
+        },
         {
           "name": "src",
           "attribute": "src",
@@ -7364,6 +7545,9 @@
         {
           "name": "pb-toggle",
           "description": "when received, dispatch state changes to the elements on the page (see `pb-toggle-feature`, `pb-select-feature`)"
+        },
+        {
+          "name": "pb-page-loaded"
         }
       ],
       "slots": [
@@ -7747,7 +7931,8 @@
         },
         {
           "name": "popup-class",
-          "type": "string"
+          "description": "Additional class names which will be added to the popup element.\nUse this to apply a specific style to certain popovers, but not others.",
+          "type": "String"
         },
         {
           "name": "subscribe",
@@ -7782,11 +7967,6 @@
         }
       ],
       "properties": [
-        {
-          "name": "poupClass",
-          "description": "Additional class names which will be added to the popup element.\nUse this to apply a specific style to certain popovers, but not others.",
-          "type": "String"
-        },
         {
           "name": "remote",
           "attribute": "remote",
@@ -7837,7 +8017,8 @@
         {
           "name": "popupClass",
           "attribute": "popup-class",
-          "type": "string"
+          "description": "Additional class names which will be added to the popup element.\nUse this to apply a specific style to certain popovers, but not others.",
+          "type": "String"
         },
         {
           "name": "subscribe",
@@ -9550,6 +9731,11 @@
           "type": "array",
           "default": "[\"D\",\"W\",\"M\",\"Y\",\"5Y\",\"10Y\"]"
         },
+        {
+          "name": "max-interval",
+          "type": "number",
+          "default": "60"
+        },
         {
           "name": "url",
           "description": "Endpoint to load timeline data from. Expects response to be an\nobject with key value pairs for (date, hits).\n\nWill be reloaded whenever 'start-date' or 'end-date' attributes change.",
@@ -9646,6 +9832,12 @@
           "type": "array",
           "default": "[\"D\",\"W\",\"M\",\"Y\",\"5Y\",\"10Y\"]"
         },
+        {
+          "name": "maxInterval",
+          "attribute": "max-interval",
+          "type": "number",
+          "default": "60"
+        },
         {
           "name": "url",
           "attribute": "url",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teipublisher/pb-components",
-  "version": "1.36.1",
+  "version": "1.37.0",
   "description": "Collection of webcomponents underlying TEI Publisher",
   "repository": "https://github.com/eeditiones/tei-publisher-components.git",
   "main": "index.html",
@@ -83,6 +83,7 @@
     "openseadragon": "^2.4.2",
     "prismjs": "^1.21.0",
     "tippy.js": "^6.2.7",
+    "tom-select": "^2.0.2",
     "uniqolor": "^1.0.1",
     "web-animations-js": "^2.3.2"
   },

package/pb-elements.json

@@ -2285,6 +2285,161 @@
         }
       ]
     },
+    {
+      "name": "pb-combo-box",
+      "path": "./src/pb-combo-box.js",
+      "description": "Provides a combo box, i.e. a combination of an input with a dropdown.\nItems to select from may be obtained from a remote data source.\n\nThe form control to be used (either a select or input) should be passed \nin the content of the element. If no control is provided, a simple `<input>`\nwill be created.",
+      "attributes": [
+        {
+          "name": "source",
+          "description": "A remote data source to use. The component will pass the text entered by the user\nin parameter `query`. It expects a JSON array of objects with each object describing\none item:\n\n```json\n{\n  \"text\": \"Text to show as label\",\n  \"value\": \"value-to-use\"\n}\n```",
+          "type": "string"
+        },
+        {
+          "name": "close-after-select",
+          "description": "Automatically close the dropdown once the user made a selection",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "preload",
+          "description": "Preload all items from the remote data source at startup",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "on-blur",
+          "description": "Name of the event to be emitted when the user leaves the form control",
+          "type": "string",
+          "default": "\"pb-combo-box-blur\""
+        },
+        {
+          "name": "on-change",
+          "description": "Name of the event to be emitted when the value of the form control has changed",
+          "type": "string",
+          "default": "\"pb-combo-box-change\""
+        },
+        {
+          "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": "renderItem",
+          "description": "Set a javascript function to be called whenever an item\nneeds to be rendered. The function will be passed the data\nobject of the current item as argument.",
+          "type": "Function"
+        },
+        {
+          "name": "theme",
+          "type": "string",
+          "default": "\"default\""
+        },
+        {
+          "name": "source",
+          "attribute": "source",
+          "description": "A remote data source to use. The component will pass the text entered by the user\nin parameter `query`. It expects a JSON array of objects with each object describing\none item:\n\n```json\n{\n  \"text\": \"Text to show as label\",\n  \"value\": \"value-to-use\"\n}\n```",
+          "type": "string"
+        },
+        {
+          "name": "closeAfterSelect",
+          "attribute": "close-after-select",
+          "description": "Automatically close the dropdown once the user made a selection",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "preload",
+          "attribute": "preload",
+          "description": "Preload all items from the remote data source at startup",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "renderFunction",
+          "type": "object",
+          "default": "\"renderDefault\""
+        },
+        {
+          "name": "onBlur",
+          "attribute": "on-blur",
+          "description": "Name of the event to be emitted when the user leaves the form control",
+          "type": "string",
+          "default": "\"pb-combo-box-blur\""
+        },
+        {
+          "name": "onChange",
+          "attribute": "on-change",
+          "description": "Name of the event to be emitted when the value of the form control has changed",
+          "type": "string",
+          "default": "\"pb-combo-box-change\""
+        },
+        {
+          "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"
+        }
+      ]
+    },
     {
       "name": "pb-custom-form",
       "path": "./src/pb-custom-form.js",
@@ -3487,6 +3642,18 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "reference-strip",
+          "description": "If set, thumbnails of all images are shown in a reference strip at the\nbottom of the viewer.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "reference-strip-size-ratio",
+          "description": "Size ratio for the reference strip thumbnails. 0.2 by default.",
+          "type": "number",
+          "default": "0.2"
+        },
         {
           "name": "src",
           "type": "string",
@@ -3610,6 +3777,20 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "referenceStrip",
+          "attribute": "reference-strip",
+          "description": "If set, thumbnails of all images are shown in a reference strip at the\nbottom of the viewer.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "referenceStripSizeRatio",
+          "attribute": "reference-strip-size-ratio",
+          "description": "Size ratio for the reference strip thumbnails. 0.2 by default.",
+          "type": "number",
+          "default": "0.2"
+        },
         {
           "name": "src",
           "attribute": "src",
@@ -7364,6 +7545,9 @@
         {
           "name": "pb-toggle",
           "description": "when received, dispatch state changes to the elements on the page (see `pb-toggle-feature`, `pb-select-feature`)"
+        },
+        {
+          "name": "pb-page-loaded"
         }
       ],
       "slots": [
@@ -7747,7 +7931,8 @@
         },
         {
           "name": "popup-class",
-          "type": "string"
+          "description": "Additional class names which will be added to the popup element.\nUse this to apply a specific style to certain popovers, but not others.",
+          "type": "String"
         },
         {
           "name": "subscribe",
@@ -7782,11 +7967,6 @@
         }
       ],
       "properties": [
-        {
-          "name": "poupClass",
-          "description": "Additional class names which will be added to the popup element.\nUse this to apply a specific style to certain popovers, but not others.",
-          "type": "String"
-        },
         {
           "name": "remote",
           "attribute": "remote",
@@ -7837,7 +8017,8 @@
         {
           "name": "popupClass",
           "attribute": "popup-class",
-          "type": "string"
+          "description": "Additional class names which will be added to the popup element.\nUse this to apply a specific style to certain popovers, but not others.",
+          "type": "String"
         },
         {
           "name": "subscribe",
@@ -9550,6 +9731,11 @@
           "type": "array",
           "default": "[\"D\",\"W\",\"M\",\"Y\",\"5Y\",\"10Y\"]"
         },
+        {
+          "name": "max-interval",
+          "type": "number",
+          "default": "60"
+        },
         {
           "name": "url",
           "description": "Endpoint to load timeline data from. Expects response to be an\nobject with key value pairs for (date, hits).\n\nWill be reloaded whenever 'start-date' or 'end-date' attributes change.",
@@ -9646,6 +9832,12 @@
           "type": "array",
           "default": "[\"D\",\"W\",\"M\",\"Y\",\"5Y\",\"10Y\"]"
         },
+        {
+          "name": "maxInterval",
+          "attribute": "max-interval",
+          "type": "number",
+          "default": "60"
+        },
         {
           "name": "url",
           "attribute": "url",