@teipublisher/pb-components 2.6.1 → 2.8.0

package/dist/pb-elements.json

@@ -5624,7 +5624,7 @@
     {
       "name": "pb-link",
       "path": "./src/pb-link.js",
-      "description": "Create an internal link: clicking it will cause connected views to\nupdate and load the corresponding document fragment defined by the\nproperties.",
+      "description": "Create an internal link: clicking it will emit a `pb-refresh`event, \ncausing connected views to update and load the corresponding document fragment defined by the\nproperties.",
       "attributes": [
         {
           "name": "xml-id",
@@ -5657,10 +5657,15 @@
         },
         {
           "name": "history",
-          "description": "Modify browser history: if set, clicking this\nelement will generate a new history entry in the browser's history.\nOnly use this on one element on the page.",
+          "description": "Modify browser history: if set, clicking this\nelement will generate a new history entry in the browser's history.",
           "type": "boolean",
           "default": "true"
         },
+        {
+          "name": "params",
+          "description": "Additional parameters to be passed in the event details.\nShould be specified as a JSON object.",
+          "type": "object"
+        },
         {
           "name": "subscribe",
           "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
@@ -5732,10 +5737,16 @@
         {
           "name": "history",
           "attribute": "history",
-          "description": "Modify browser history: if set, clicking this\nelement will generate a new history entry in the browser's history.\nOnly use this on one element on the page.",
+          "description": "Modify browser history: if set, clicking this\nelement will generate a new history entry in the browser's history.",
           "type": "boolean",
           "default": "true"
         },
+        {
+          "name": "params",
+          "attribute": "params",
+          "description": "Additional parameters to be passed in the event details.\nShould be specified as a JSON object.",
+          "type": "object"
+        },
         {
           "name": "subscribe",
           "attribute": "subscribe",
@@ -8160,6 +8171,16 @@
           "type": "string",
           "default": "\".\""
         },
+        {
+          "name": "url-template",
+          "description": "Can be used to define parameters which should be serialized in the\nURL path rather than as query parameters. Expects a url pattern\nrelative to the application root\n(supported patterns are documented in the \n[path-to-regexp](https://www.npmjs.com/package/path-to-regexp) library documentation).\n\nFor example, a pattern `:lang/texts/:path/:id?` would support URLs like \n`en/texts/text1/chapter1`. Whenever components change state – e.g. due to a navigation\nevent – the standard parameters `path`, `lang` and `id` would be serialized into the\nURL path pattern rather than query parameters.",
+          "type": "string"
+        },
+        {
+          "name": "url-ignore",
+          "description": "A comma-separated list of parameter names which should not be reflected on the browser URL.\nUse this to exclude e.g. the default `odd` parameter of a pb-view to be shown in the\nbrowser URL.",
+          "type": "string"
+        },
         {
           "name": "url-path",
           "description": "Is the resource path part of the URL or should it be\nencoded as a parameter? TEI Publisher uses the\nURL path, but the webcomponent demos need to encode the resource path\nin a query parameter.",
@@ -8279,6 +8300,18 @@
           "type": "string",
           "default": "\".\""
         },
+        {
+          "name": "urlTemplate",
+          "attribute": "url-template",
+          "description": "Can be used to define parameters which should be serialized in the\nURL path rather than as query parameters. Expects a url pattern\nrelative to the application root\n(supported patterns are documented in the \n[path-to-regexp](https://www.npmjs.com/package/path-to-regexp) library documentation).\n\nFor example, a pattern `:lang/texts/:path/:id?` would support URLs like \n`en/texts/text1/chapter1`. Whenever components change state – e.g. due to a navigation\nevent – the standard parameters `path`, `lang` and `id` would be serialized into the\nURL path pattern rather than query parameters.",
+          "type": "string"
+        },
+        {
+          "name": "urlIgnore",
+          "attribute": "url-ignore",
+          "description": "A comma-separated list of parameter names which should not be reflected on the browser URL.\nUse this to exclude e.g. the default `odd` parameter of a pb-view to be shown in the\nbrowser URL.",
+          "type": "string"
+        },
         {
           "name": "urlPath",
           "attribute": "url-path",
@@ -8734,27 +8767,27 @@
     {
       "name": "pb-popover",
       "path": "./src/pb-popover.js",
-      "description": "Show a popover. It may either \r\n\r\n1. be attached to another element on the page which serves as a trigger. For this the\r\n`for` property must be specified and should contain the ID of the trigger element. \r\nThe whole content of the `pb-popover` element will be shown in the popup.\r\n\r\n2. if no `for` property is specified, the `pb-popover` acts itself as the trigger. The trigger\r\ntext is either taken from a slot named `default` - or the default slot (i.e. the content of the element).\r\nThe content to show in the popup should be supplied in a slot named `alternate`. It is recommended to use an\r\nHTML `template` to specify the alternate, so it is ignored by the browser:\r\n\r\n```html\r\n<pb-popover theme=\"material\">\r\n      <span slot=\"default\">ipsum dolor sit amet</span>\r\n      <template slot=\"alternate\">\r\n          <p>At vero eos et <strong>accusam</strong> et justo duo dolores<br>\r\n          et ea rebum.</p>\r\n      </template>\r\n</pb-popover>\r\n```\r\n\r\nIf you would like popovers to contain nested popovers, choose approach 1 above and use `for`.\r\n\r\nIf property `persistent` is true, the popover will be shown\r\non click. Otherwise display a tooltip on mouseover.\r\n\r\n`pb-popover` uses the tippy.js library for the popup.\r\n\r\n## Styling\r\n\r\nWhen showing the popup, the popup content will either be added to the parent shadow DOM - if the `pb-popover`\r\nis located inside the shadow DOM of another element like `pb-view`; or the document body. This has an\r\neffect on where CSS styles can be defined: within a `pb-view`, only the styles specified inside the\r\nCSS attached to the ODD are applied.",
+      "description": "Show a popover. It may either \n\n1. be attached to another element on the page which serves as a trigger. For this the\n`for` property must be specified and should contain the ID of the trigger element. \nThe whole content of the `pb-popover` element will be shown in the popup.\n\n2. if no `for` property is specified, the `pb-popover` acts itself as the trigger. The trigger\ntext is either taken from a slot named `default` - or the default slot (i.e. the content of the element).\nThe content to show in the popup should be supplied in a slot named `alternate`. It is recommended to use an\nHTML `template` to specify the alternate, so it is ignored by the browser:\n\n```html\n<pb-popover theme=\"material\">\n      <span slot=\"default\">ipsum dolor sit amet</span>\n      <template slot=\"alternate\">\n          <p>At vero eos et <strong>accusam</strong> et justo duo dolores<br>\n          et ea rebum.</p>\n      </template>\n</pb-popover>\n```\n\nIf you would like popovers to contain nested popovers, choose approach 1 above and use `for`.\n\nIf property `persistent` is true, the popover will be shown\non click. Otherwise display a tooltip on mouseover.\n\n`pb-popover` uses the tippy.js library for the popup.\n\n## Styling\n\nWhen showing the popup, the popup content will either be added to the parent shadow DOM - if the `pb-popover`\nis located inside the shadow DOM of another element like `pb-view`; or the document body. This has an\neffect on where CSS styles can be defined: within a `pb-view`, only the styles specified inside the\nCSS attached to the ODD are applied.",
       "attributes": [
         {
           "name": "remote",
-          "description": "An optional URL to asynchronously load the popover's content from. Content will\rbe loaded after the popover is displayed. The downloaded HTML content will replace the text set via the alternate slot.",
+          "description": "An optional URL to asynchronously load the popover's content from. Content will\nbe loaded after the popover is displayed. The downloaded HTML content will replace the text set via the alternate slot.",
           "type": "String"
         },
         {
           "name": "persistent",
-          "description": "If true, show the 'hand' cursor when hovering over the link; `trigger` will be set to 'click'\runless defined otherwise; clicking anywhere on the page will close the popup.",
+          "description": "If true, show the 'hand' cursor when hovering over the link; `trigger` will be set to 'click'\nunless defined otherwise; clicking anywhere on the page will close the popup.",
           "type": "Boolean",
           "default": "false"
         },
         {
           "name": "trigger",
-          "description": "Defines one or more actions (space separated) which should cause\rthe popover to show. If property `persistent` is set, `trigger` will by default be set to `click`.",
+          "description": "Defines one or more actions (space separated) which should cause\nthe popover to show. If property `persistent` is set, `trigger` will by default be set to `click`.",
           "type": "\"click\" | \"mouseenter\" | \"focus\" | \"focusin\""
         },
         {
           "name": "for",
-          "description": "The id of a trigger element (e.g. a link) to which the popover will\rbe attached. If not set, the trigger is the pb-popover itself.",
+          "description": "The id of a trigger element (e.g. a link) to which the popover will\nbe attached. If not set, the trigger is the pb-popover itself.",
           "type": "String"
         },
         {
@@ -8764,22 +8797,26 @@
         },
         {
           "name": "placement",
-          "description": "Preferred placement of the popup.\rDefault is 'auto'.",
+          "description": "Preferred placement of the popup.\nDefault is 'auto'.",
           "type": "\"auto\" | \"top\" | \"bottom\" | \"left\" | \"right\""
         },
+        {
+          "name": "touch",
+          "type": "string"
+        },
         {
           "name": "fallback-placement",
-          "description": "Fallback placement if there is more space on another side.\rAccepts same values as `placement`. Separate by space if more than one.",
+          "description": "Fallback placement if there is more space on another side.\nAccepts same values as `placement`. Separate by space if more than one.",
           "type": "String"
         },
         {
           "name": "popup-class",
-          "description": "Additional class names which will be added to the popup element.\rUse this to apply a specific style to certain popovers, but not others.",
+          "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": "stop-propagation",
-          "description": "If you have nested pb-popover, set this property to\ronly show the innermost popover when triggered",
+          "description": "If you have nested pb-popover, set this property to\nonly show the innermost popover when triggered",
           "type": "Boolean",
           "default": "false"
         },
@@ -8819,30 +8856,30 @@
         {
           "name": "remote",
           "attribute": "remote",
-          "description": "An optional URL to asynchronously load the popover's content from. Content will\rbe loaded after the popover is displayed. The downloaded HTML content will replace the text set via the alternate slot.",
+          "description": "An optional URL to asynchronously load the popover's content from. Content will\nbe loaded after the popover is displayed. The downloaded HTML content will replace the text set via the alternate slot.",
           "type": "String"
         },
         {
           "name": "alternate",
-          "description": "Returns the root element of the alternate content currently shown in the popover.\r\nThis will be initialized from either the default slot or the slot with name 'alternate' (if present).\r\nThe returned element is always a `div` and can be modified."
+          "description": "Returns the root element of the alternate content currently shown in the popover.\nThis will be initialized from either the default slot or the slot with name 'alternate' (if present).\nThe returned element is always a `div` and can be modified."
         },
         {
           "name": "persistent",
           "attribute": "persistent",
-          "description": "If true, show the 'hand' cursor when hovering over the link; `trigger` will be set to 'click'\runless defined otherwise; clicking anywhere on the page will close the popup.",
+          "description": "If true, show the 'hand' cursor when hovering over the link; `trigger` will be set to 'click'\nunless defined otherwise; clicking anywhere on the page will close the popup.",
           "type": "Boolean",
           "default": "false"
         },
         {
           "name": "trigger",
           "attribute": "trigger",
-          "description": "Defines one or more actions (space separated) which should cause\rthe popover to show. If property `persistent` is set, `trigger` will by default be set to `click`.",
+          "description": "Defines one or more actions (space separated) which should cause\nthe popover to show. If property `persistent` is set, `trigger` will by default be set to `click`.",
           "type": "\"click\" | \"mouseenter\" | \"focus\" | \"focusin\""
         },
         {
           "name": "for",
           "attribute": "for",
-          "description": "The id of a trigger element (e.g. a link) to which the popover will\rbe attached. If not set, the trigger is the pb-popover itself.",
+          "description": "The id of a trigger element (e.g. a link) to which the popover will\nbe attached. If not set, the trigger is the pb-popover itself.",
           "type": "String"
         },
         {
@@ -8854,25 +8891,30 @@
         {
           "name": "placement",
           "attribute": "placement",
-          "description": "Preferred placement of the popup.\rDefault is 'auto'.",
+          "description": "Preferred placement of the popup.\nDefault is 'auto'.",
           "type": "\"auto\" | \"top\" | \"bottom\" | \"left\" | \"right\""
         },
+        {
+          "name": "touch",
+          "attribute": "touch",
+          "type": "string"
+        },
         {
           "name": "fallbackPlacement",
           "attribute": "fallback-placement",
-          "description": "Fallback placement if there is more space on another side.\rAccepts same values as `placement`. Separate by space if more than one.",
+          "description": "Fallback placement if there is more space on another side.\nAccepts same values as `placement`. Separate by space if more than one.",
           "type": "String"
         },
         {
           "name": "popupClass",
           "attribute": "popup-class",
-          "description": "Additional class names which will be added to the popup element.\rUse this to apply a specific style to certain popovers, but not others.",
+          "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": "stopPropagation",
           "attribute": "stop-propagation",
-          "description": "If you have nested pb-popover, set this property to\ronly show the innermost popover when triggered",
+          "description": "If you have nested pb-popover, set this property to\nonly show the innermost popover when triggered",
           "type": "Boolean",
           "default": "false"
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teipublisher/pb-components",
-  "version": "2.6.1",
+  "version": "2.8.0",
   "description": "Collection of webcomponents underlying TEI Publisher",
   "repository": "https://github.com/eeditiones/tei-publisher-components.git",
   "main": "index.html",
@@ -83,6 +83,7 @@
     "lit-html": "^1.3.0",
     "marked": "^1.2.0",
     "pagedjs": "^0.4.0",
+    "path-to-regexp": "^6.2.1",
     "prismjs": "^1.21.0",
     "tippy.js": "^6.2.7",
     "tom-select": "^2.0.2",

package/pb-elements.json

@@ -5624,7 +5624,7 @@
     {
       "name": "pb-link",
       "path": "./src/pb-link.js",
-      "description": "Create an internal link: clicking it will cause connected views to\nupdate and load the corresponding document fragment defined by the\nproperties.",
+      "description": "Create an internal link: clicking it will emit a `pb-refresh`event, \ncausing connected views to update and load the corresponding document fragment defined by the\nproperties.",
       "attributes": [
         {
           "name": "xml-id",
@@ -5657,10 +5657,15 @@
         },
         {
           "name": "history",
-          "description": "Modify browser history: if set, clicking this\nelement will generate a new history entry in the browser's history.\nOnly use this on one element on the page.",
+          "description": "Modify browser history: if set, clicking this\nelement will generate a new history entry in the browser's history.",
           "type": "boolean",
           "default": "true"
         },
+        {
+          "name": "params",
+          "description": "Additional parameters to be passed in the event details.\nShould be specified as a JSON object.",
+          "type": "object"
+        },
         {
           "name": "subscribe",
           "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
@@ -5732,10 +5737,16 @@
         {
           "name": "history",
           "attribute": "history",
-          "description": "Modify browser history: if set, clicking this\nelement will generate a new history entry in the browser's history.\nOnly use this on one element on the page.",
+          "description": "Modify browser history: if set, clicking this\nelement will generate a new history entry in the browser's history.",
           "type": "boolean",
           "default": "true"
         },
+        {
+          "name": "params",
+          "attribute": "params",
+          "description": "Additional parameters to be passed in the event details.\nShould be specified as a JSON object.",
+          "type": "object"
+        },
         {
           "name": "subscribe",
           "attribute": "subscribe",
@@ -8160,6 +8171,16 @@
           "type": "string",
           "default": "\".\""
         },
+        {
+          "name": "url-template",
+          "description": "Can be used to define parameters which should be serialized in the\nURL path rather than as query parameters. Expects a url pattern\nrelative to the application root\n(supported patterns are documented in the \n[path-to-regexp](https://www.npmjs.com/package/path-to-regexp) library documentation).\n\nFor example, a pattern `:lang/texts/:path/:id?` would support URLs like \n`en/texts/text1/chapter1`. Whenever components change state – e.g. due to a navigation\nevent – the standard parameters `path`, `lang` and `id` would be serialized into the\nURL path pattern rather than query parameters.",
+          "type": "string"
+        },
+        {
+          "name": "url-ignore",
+          "description": "A comma-separated list of parameter names which should not be reflected on the browser URL.\nUse this to exclude e.g. the default `odd` parameter of a pb-view to be shown in the\nbrowser URL.",
+          "type": "string"
+        },
         {
           "name": "url-path",
           "description": "Is the resource path part of the URL or should it be\nencoded as a parameter? TEI Publisher uses the\nURL path, but the webcomponent demos need to encode the resource path\nin a query parameter.",
@@ -8279,6 +8300,18 @@
           "type": "string",
           "default": "\".\""
         },
+        {
+          "name": "urlTemplate",
+          "attribute": "url-template",
+          "description": "Can be used to define parameters which should be serialized in the\nURL path rather than as query parameters. Expects a url pattern\nrelative to the application root\n(supported patterns are documented in the \n[path-to-regexp](https://www.npmjs.com/package/path-to-regexp) library documentation).\n\nFor example, a pattern `:lang/texts/:path/:id?` would support URLs like \n`en/texts/text1/chapter1`. Whenever components change state – e.g. due to a navigation\nevent – the standard parameters `path`, `lang` and `id` would be serialized into the\nURL path pattern rather than query parameters.",
+          "type": "string"
+        },
+        {
+          "name": "urlIgnore",
+          "attribute": "url-ignore",
+          "description": "A comma-separated list of parameter names which should not be reflected on the browser URL.\nUse this to exclude e.g. the default `odd` parameter of a pb-view to be shown in the\nbrowser URL.",
+          "type": "string"
+        },
         {
           "name": "urlPath",
           "attribute": "url-path",
@@ -8734,27 +8767,27 @@
     {
       "name": "pb-popover",
       "path": "./src/pb-popover.js",
-      "description": "Show a popover. It may either \r\n\r\n1. be attached to another element on the page which serves as a trigger. For this the\r\n`for` property must be specified and should contain the ID of the trigger element. \r\nThe whole content of the `pb-popover` element will be shown in the popup.\r\n\r\n2. if no `for` property is specified, the `pb-popover` acts itself as the trigger. The trigger\r\ntext is either taken from a slot named `default` - or the default slot (i.e. the content of the element).\r\nThe content to show in the popup should be supplied in a slot named `alternate`. It is recommended to use an\r\nHTML `template` to specify the alternate, so it is ignored by the browser:\r\n\r\n```html\r\n<pb-popover theme=\"material\">\r\n      <span slot=\"default\">ipsum dolor sit amet</span>\r\n      <template slot=\"alternate\">\r\n          <p>At vero eos et <strong>accusam</strong> et justo duo dolores<br>\r\n          et ea rebum.</p>\r\n      </template>\r\n</pb-popover>\r\n```\r\n\r\nIf you would like popovers to contain nested popovers, choose approach 1 above and use `for`.\r\n\r\nIf property `persistent` is true, the popover will be shown\r\non click. Otherwise display a tooltip on mouseover.\r\n\r\n`pb-popover` uses the tippy.js library for the popup.\r\n\r\n## Styling\r\n\r\nWhen showing the popup, the popup content will either be added to the parent shadow DOM - if the `pb-popover`\r\nis located inside the shadow DOM of another element like `pb-view`; or the document body. This has an\r\neffect on where CSS styles can be defined: within a `pb-view`, only the styles specified inside the\r\nCSS attached to the ODD are applied.",
+      "description": "Show a popover. It may either \n\n1. be attached to another element on the page which serves as a trigger. For this the\n`for` property must be specified and should contain the ID of the trigger element. \nThe whole content of the `pb-popover` element will be shown in the popup.\n\n2. if no `for` property is specified, the `pb-popover` acts itself as the trigger. The trigger\ntext is either taken from a slot named `default` - or the default slot (i.e. the content of the element).\nThe content to show in the popup should be supplied in a slot named `alternate`. It is recommended to use an\nHTML `template` to specify the alternate, so it is ignored by the browser:\n\n```html\n<pb-popover theme=\"material\">\n      <span slot=\"default\">ipsum dolor sit amet</span>\n      <template slot=\"alternate\">\n          <p>At vero eos et <strong>accusam</strong> et justo duo dolores<br>\n          et ea rebum.</p>\n      </template>\n</pb-popover>\n```\n\nIf you would like popovers to contain nested popovers, choose approach 1 above and use `for`.\n\nIf property `persistent` is true, the popover will be shown\non click. Otherwise display a tooltip on mouseover.\n\n`pb-popover` uses the tippy.js library for the popup.\n\n## Styling\n\nWhen showing the popup, the popup content will either be added to the parent shadow DOM - if the `pb-popover`\nis located inside the shadow DOM of another element like `pb-view`; or the document body. This has an\neffect on where CSS styles can be defined: within a `pb-view`, only the styles specified inside the\nCSS attached to the ODD are applied.",
       "attributes": [
         {
           "name": "remote",
-          "description": "An optional URL to asynchronously load the popover's content from. Content will\rbe loaded after the popover is displayed. The downloaded HTML content will replace the text set via the alternate slot.",
+          "description": "An optional URL to asynchronously load the popover's content from. Content will\nbe loaded after the popover is displayed. The downloaded HTML content will replace the text set via the alternate slot.",
           "type": "String"
         },
         {
           "name": "persistent",
-          "description": "If true, show the 'hand' cursor when hovering over the link; `trigger` will be set to 'click'\runless defined otherwise; clicking anywhere on the page will close the popup.",
+          "description": "If true, show the 'hand' cursor when hovering over the link; `trigger` will be set to 'click'\nunless defined otherwise; clicking anywhere on the page will close the popup.",
           "type": "Boolean",
           "default": "false"
         },
         {
           "name": "trigger",
-          "description": "Defines one or more actions (space separated) which should cause\rthe popover to show. If property `persistent` is set, `trigger` will by default be set to `click`.",
+          "description": "Defines one or more actions (space separated) which should cause\nthe popover to show. If property `persistent` is set, `trigger` will by default be set to `click`.",
           "type": "\"click\" | \"mouseenter\" | \"focus\" | \"focusin\""
         },
         {
           "name": "for",
-          "description": "The id of a trigger element (e.g. a link) to which the popover will\rbe attached. If not set, the trigger is the pb-popover itself.",
+          "description": "The id of a trigger element (e.g. a link) to which the popover will\nbe attached. If not set, the trigger is the pb-popover itself.",
           "type": "String"
         },
         {
@@ -8764,22 +8797,26 @@
         },
         {
           "name": "placement",
-          "description": "Preferred placement of the popup.\rDefault is 'auto'.",
+          "description": "Preferred placement of the popup.\nDefault is 'auto'.",
           "type": "\"auto\" | \"top\" | \"bottom\" | \"left\" | \"right\""
         },
+        {
+          "name": "touch",
+          "type": "string"
+        },
         {
           "name": "fallback-placement",
-          "description": "Fallback placement if there is more space on another side.\rAccepts same values as `placement`. Separate by space if more than one.",
+          "description": "Fallback placement if there is more space on another side.\nAccepts same values as `placement`. Separate by space if more than one.",
           "type": "String"
         },
         {
           "name": "popup-class",
-          "description": "Additional class names which will be added to the popup element.\rUse this to apply a specific style to certain popovers, but not others.",
+          "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": "stop-propagation",
-          "description": "If you have nested pb-popover, set this property to\ronly show the innermost popover when triggered",
+          "description": "If you have nested pb-popover, set this property to\nonly show the innermost popover when triggered",
           "type": "Boolean",
           "default": "false"
         },
@@ -8819,30 +8856,30 @@
         {
           "name": "remote",
           "attribute": "remote",
-          "description": "An optional URL to asynchronously load the popover's content from. Content will\rbe loaded after the popover is displayed. The downloaded HTML content will replace the text set via the alternate slot.",
+          "description": "An optional URL to asynchronously load the popover's content from. Content will\nbe loaded after the popover is displayed. The downloaded HTML content will replace the text set via the alternate slot.",
           "type": "String"
         },
         {
           "name": "alternate",
-          "description": "Returns the root element of the alternate content currently shown in the popover.\r\nThis will be initialized from either the default slot or the slot with name 'alternate' (if present).\r\nThe returned element is always a `div` and can be modified."
+          "description": "Returns the root element of the alternate content currently shown in the popover.\nThis will be initialized from either the default slot or the slot with name 'alternate' (if present).\nThe returned element is always a `div` and can be modified."
         },
         {
           "name": "persistent",
           "attribute": "persistent",
-          "description": "If true, show the 'hand' cursor when hovering over the link; `trigger` will be set to 'click'\runless defined otherwise; clicking anywhere on the page will close the popup.",
+          "description": "If true, show the 'hand' cursor when hovering over the link; `trigger` will be set to 'click'\nunless defined otherwise; clicking anywhere on the page will close the popup.",
           "type": "Boolean",
           "default": "false"
         },
         {
           "name": "trigger",
           "attribute": "trigger",
-          "description": "Defines one or more actions (space separated) which should cause\rthe popover to show. If property `persistent` is set, `trigger` will by default be set to `click`.",
+          "description": "Defines one or more actions (space separated) which should cause\nthe popover to show. If property `persistent` is set, `trigger` will by default be set to `click`.",
           "type": "\"click\" | \"mouseenter\" | \"focus\" | \"focusin\""
         },
         {
           "name": "for",
           "attribute": "for",
-          "description": "The id of a trigger element (e.g. a link) to which the popover will\rbe attached. If not set, the trigger is the pb-popover itself.",
+          "description": "The id of a trigger element (e.g. a link) to which the popover will\nbe attached. If not set, the trigger is the pb-popover itself.",
           "type": "String"
         },
         {
@@ -8854,25 +8891,30 @@
         {
           "name": "placement",
           "attribute": "placement",
-          "description": "Preferred placement of the popup.\rDefault is 'auto'.",
+          "description": "Preferred placement of the popup.\nDefault is 'auto'.",
           "type": "\"auto\" | \"top\" | \"bottom\" | \"left\" | \"right\""
         },
+        {
+          "name": "touch",
+          "attribute": "touch",
+          "type": "string"
+        },
         {
           "name": "fallbackPlacement",
           "attribute": "fallback-placement",
-          "description": "Fallback placement if there is more space on another side.\rAccepts same values as `placement`. Separate by space if more than one.",
+          "description": "Fallback placement if there is more space on another side.\nAccepts same values as `placement`. Separate by space if more than one.",
           "type": "String"
         },
         {
           "name": "popupClass",
           "attribute": "popup-class",
-          "description": "Additional class names which will be added to the popup element.\rUse this to apply a specific style to certain popovers, but not others.",
+          "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": "stopPropagation",
           "attribute": "stop-propagation",
-          "description": "If you have nested pb-popover, set this property to\ronly show the innermost popover when triggered",
+          "description": "If you have nested pb-popover, set this property to\nonly show the innermost popover when triggered",
           "type": "Boolean",
           "default": "false"
         },

package/src/pb-browse-docs.js

@@ -156,6 +156,8 @@ export class PbBrowseDocs extends themableMixin(PbLoad) {
                     const param = registry.state[key];
                     if (this.facets[key]) {
                         this.facets[key].push(param);
+                    } else if (Array.isArray(param)) {
+                        this.facets[key] = param;
                     } else {
                         this.facets[key] = [param];
                     }

package/src/pb-custom-form.js

@@ -93,8 +93,24 @@ export class PbCustomForm extends PbLoad {
         this.shadowRoot.getElementById('ironform').reset();
     }
     
+    /**
+     * serialize custom form to object with name value pairs
+     * empty, unselected and undifined inputs will be returned
+     * as null while disabled elements will still be omitted
+     * this allows url parameters to be reset in the URL
+     * as IronForm.serializeform will omit names without a value
+     * @returns {Object} name value pairs
+     */
     serializeForm() {
-        return this.shadowRoot.getElementById('ironform').serializeForm();
+        const elements = this.shadowRoot.getElementById('ironform')._getSubmittableElements()
+        const initial = {}
+        for (const element of elements) {
+            initial[element.name] = null;
+        }
+        return Object.assign(
+            initial,
+            this.shadowRoot.getElementById('ironform').serializeForm()
+        );
     }
 
     _parseHeaders(xhr) {

package/src/pb-link.js

@@ -4,8 +4,8 @@ import { pbMixin } from './pb-mixin.js';
 import { registry } from "./urls.js";
 
 /**
- * Create an internal link: clicking it will cause connected views to
- * update and load the corresponding document fragment defined by the
+ * Create an internal link: clicking it will emit a `pb-refresh`event, 
+ * causing connected views to update and load the corresponding document fragment defined by the
  * properties.
  *
  * @fires pb-refresh - Fires when user clicks the link
@@ -41,10 +41,16 @@ export class PbLink extends pbMixin(LitElement) {
             view: {
                 type: String
             },
+            /**
+             * Additional parameters to be passed in the event details.
+             * Should be specified as a JSON object.
+             */
+            params: {
+                type: Object
+            },
             /**
              * Modify browser history: if set, clicking this
              * element will generate a new history entry in the browser's history.
-             * Only use this on one element on the page.
              */
             history: {
                 type: Boolean
@@ -55,6 +61,7 @@ export class PbLink extends pbMixin(LitElement) {
     constructor() {
         super();
         this.history = true;
+        this.params = null;
     }
 
     connectedCallback() {
@@ -110,6 +117,9 @@ export class PbLink extends pbMixin(LitElement) {
         if (this.view) {
             params.view = this.view;
         }
+        if (this.params) {
+            Object.assign(params, this.params);
+        }
         if (this.history) {
             registry.commit(this, params);
         }

package/src/pb-load.js

@@ -315,6 +315,11 @@ export class PbLoad extends pbMixin(LitElement) {
 
         params = this.prepareParameters(params);
 
+        // filter null values
+        for (const [k,v] of Object.entries(params)) {
+            if (v === null) { delete params[k] }
+        }
+
         const url = this.getURL(params);
 
         console.log("<pb-load> Loading %s with parameters %o", url, params);

package/src/pb-page.js

@@ -39,6 +39,31 @@ export class PbPage extends pbMixin(LitElement) {
                 type: String,
                 attribute: 'app-root'
             },
+            /**
+             * Can be used to define parameters which should be serialized in the
+             * URL path rather than as query parameters. Expects a url pattern
+             * relative to the application root
+             * (supported patterns are documented in the 
+             * [path-to-regexp](https://www.npmjs.com/package/path-to-regexp) library documentation).
+             * 
+             * For example, a pattern `:lang/texts/:path/:id?` would support URLs like 
+             * `en/texts/text1/chapter1`. Whenever components change state – e.g. due to a navigation
+             * event – the standard parameters `path`, `lang` and `id` would be serialized into the
+             * URL path pattern rather than query parameters.
+             */
+            urlTemplate: {
+                type: String,
+                attribute: 'url-template'
+            },
+            /**
+             * A comma-separated list of parameter names which should not be reflected on the browser URL.
+             * Use this to exclude e.g. the default `odd` parameter of a pb-view to be shown in the
+             * browser URL.
+             */
+            urlIgnore: {
+                type: String,
+                attribute: 'url-ignore'
+            },
             /**
              * Is the resource path part of the URL or should it be
              * encoded as a parameter? TEI Publisher uses the
@@ -180,6 +205,8 @@ export class PbPage extends pbMixin(LitElement) {
         super();
         this.unresolved = true;
         this.endpoint = ".";
+        this.urlTemplate = null;
+        this.urlIgnore = null;
         this.urlPath = 'path';
         this.idHash = false;
         this.apiVersion = undefined;
@@ -221,7 +248,7 @@ export class PbPage extends pbMixin(LitElement) {
             return;
         }
 
-        registry.configure(this.urlPath === 'path', this.idHash, this.appRoot);
+        registry.configure(this.urlPath === 'path', this.idHash, this.appRoot, this.urlTemplate, this.urlIgnore);
 
         this.endpoint = this.endpoint.replace(/\/+$/, '');