@teipublisher/pb-components 1.43.0 → 1.43.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/css/components.css +5 -0
- package/dist/demo/components.css +15 -1
- package/dist/demo/pb-view2.html +135 -136
- package/dist/pb-component-docs.js +40 -40
- package/dist/pb-components-bundle.js +261 -261
- package/dist/pb-elements.json +102 -100
- package/dist/{pb-message-c4cd7861.js → pb-message-fbc1b645.js} +25 -26
- package/dist/pb-odd-editor.js +1 -1
- package/package.json +1 -1
- package/pb-elements.json +102 -100
- package/src/assets/components.css +5 -0
- package/src/pb-browse-docs.js +520 -519
- package/src/pb-clipboard.js +75 -74
- package/src/pb-code-editor.js +2 -1
- package/src/pb-collapse.js +183 -182
- package/src/pb-load.js +3 -1
- package/src/pb-page.js +7 -4
- package/src/pb-table-grid.js +2 -2
- package/src/pb-view.js +1366 -1368
- package/src/theming.js +51 -16
package/dist/pb-elements.json
CHANGED
|
@@ -1307,7 +1307,7 @@
|
|
|
1307
1307
|
},
|
|
1308
1308
|
{
|
|
1309
1309
|
"name": "group",
|
|
1310
|
-
"description": "If set, requires the logged in user to be member of\nthe given group.",
|
|
1310
|
+
"description": "If set, requires the logged in user to be member of\r\nthe given group.",
|
|
1311
1311
|
"type": "string"
|
|
1312
1312
|
},
|
|
1313
1313
|
{
|
|
@@ -1356,7 +1356,7 @@
|
|
|
1356
1356
|
},
|
|
1357
1357
|
{
|
|
1358
1358
|
"name": "static",
|
|
1359
|
-
"description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required",
|
|
1359
|
+
"description": "If set, rewrite URLs to load pages as static HTML files,\r\nso no TEI Publisher instance is required",
|
|
1360
1360
|
"type": "boolean",
|
|
1361
1361
|
"default": "false"
|
|
1362
1362
|
},
|
|
@@ -1428,7 +1428,7 @@
|
|
|
1428
1428
|
"name": "no-credentials",
|
|
1429
1429
|
"description": "Indicates whether or not cross-site Access-Control requests should be made.\nDefault is false.",
|
|
1430
1430
|
"type": "boolean",
|
|
1431
|
-
"default": "
|
|
1431
|
+
"default": "false"
|
|
1432
1432
|
},
|
|
1433
1433
|
{
|
|
1434
1434
|
"name": "silent",
|
|
@@ -1488,7 +1488,7 @@
|
|
|
1488
1488
|
{
|
|
1489
1489
|
"name": "group",
|
|
1490
1490
|
"attribute": "group",
|
|
1491
|
-
"description": "If set, requires the logged in user to be member of\nthe given group.",
|
|
1491
|
+
"description": "If set, requires the logged in user to be member of\r\nthe given group.",
|
|
1492
1492
|
"type": "string"
|
|
1493
1493
|
},
|
|
1494
1494
|
{
|
|
@@ -1547,7 +1547,7 @@
|
|
|
1547
1547
|
{
|
|
1548
1548
|
"name": "static",
|
|
1549
1549
|
"attribute": "static",
|
|
1550
|
-
"description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required",
|
|
1550
|
+
"description": "If set, rewrite URLs to load pages as static HTML files,\r\nso no TEI Publisher instance is required",
|
|
1551
1551
|
"type": "boolean",
|
|
1552
1552
|
"default": "false"
|
|
1553
1553
|
},
|
|
@@ -1640,7 +1640,7 @@
|
|
|
1640
1640
|
"attribute": "no-credentials",
|
|
1641
1641
|
"description": "Indicates whether or not cross-site Access-Control requests should be made.\nDefault is false.",
|
|
1642
1642
|
"type": "boolean",
|
|
1643
|
-
"default": "
|
|
1643
|
+
"default": "false"
|
|
1644
1644
|
},
|
|
1645
1645
|
{
|
|
1646
1646
|
"name": "silent",
|
|
@@ -1779,7 +1779,7 @@
|
|
|
1779
1779
|
{
|
|
1780
1780
|
"name": "pb-clipboard",
|
|
1781
1781
|
"path": "./src/pb-clipboard.js",
|
|
1782
|
-
"description": "A component with a button which copies the contained content to the clipboard.\nUse for the typical 'quote this content as' hints on a webpage.",
|
|
1782
|
+
"description": "A component with a button which copies the contained content to the clipboard.\r\nUse for the typical 'quote this content as' hints on a webpage.",
|
|
1783
1783
|
"attributes": [
|
|
1784
1784
|
{
|
|
1785
1785
|
"name": "label",
|
|
@@ -2026,7 +2026,9 @@
|
|
|
2026
2026
|
{
|
|
2027
2027
|
"name": "code-changed"
|
|
2028
2028
|
}
|
|
2029
|
-
]
|
|
2029
|
+
],
|
|
2030
|
+
"deprecated": true,
|
|
2031
|
+
"deprecatedMessage": "directly use `jinn-codemirror` instead, which is included in the tei-publisher-components \nbundle."
|
|
2030
2032
|
},
|
|
2031
2033
|
{
|
|
2032
2034
|
"name": "pb-code-highlight",
|
|
@@ -2179,7 +2181,7 @@
|
|
|
2179
2181
|
{
|
|
2180
2182
|
"name": "pb-collapse",
|
|
2181
2183
|
"path": "./src/pb-collapse.js",
|
|
2182
|
-
"description": "A collapsible block: in collapsed state it only shows a header and expands if clicked.\nThe header should go into slot `collapse-trigger`, the content into `collapse-content`.\nExample:\n\n```html\n<pb-collapse>\n <div slot=\"collapse-trigger\">\n Metadata\n </div>\n <pb-view slot=\"collapse-content\" src=\"document1\" subscribe=\"transcription\" xpath=\"//teiHeader\"></pb-view>\n</pb-collapse>\n```",
|
|
2184
|
+
"description": "A collapsible block: in collapsed state it only shows a header and expands if clicked.\r\nThe header should go into slot `collapse-trigger`, the content into `collapse-content`.\r\nExample:\r\n\r\n```html\r\n<pb-collapse>\r\n <div slot=\"collapse-trigger\">\r\n Metadata\r\n </div>\r\n <pb-view slot=\"collapse-content\" src=\"document1\" subscribe=\"transcription\" xpath=\"//teiHeader\"></pb-view>\r\n</pb-collapse>\r\n```",
|
|
2183
2185
|
"attributes": [
|
|
2184
2186
|
{
|
|
2185
2187
|
"name": "horizontal",
|
|
@@ -2219,7 +2221,7 @@
|
|
|
2219
2221
|
},
|
|
2220
2222
|
{
|
|
2221
2223
|
"name": "toggles",
|
|
2222
|
-
"description": "By default, an open collapse is closed if another pb-collapse is expanded on the same event channel.\nSet to true to keep multiple pb-collapse open at the same time.",
|
|
2224
|
+
"description": "By default, an open collapse is closed if another pb-collapse is expanded on the same event channel.\r\nSet to true to keep multiple pb-collapse open at the same time.",
|
|
2223
2225
|
"type": "boolean",
|
|
2224
2226
|
"default": "false"
|
|
2225
2227
|
},
|
|
@@ -2301,7 +2303,7 @@
|
|
|
2301
2303
|
{
|
|
2302
2304
|
"name": "toggles",
|
|
2303
2305
|
"attribute": "toggles",
|
|
2304
|
-
"description": "By default, an open collapse is closed if another pb-collapse is expanded on the same event channel.\nSet to true to keep multiple pb-collapse open at the same time.",
|
|
2306
|
+
"description": "By default, an open collapse is closed if another pb-collapse is expanded on the same event channel.\r\nSet to true to keep multiple pb-collapse open at the same time.",
|
|
2305
2307
|
"type": "boolean",
|
|
2306
2308
|
"default": "false"
|
|
2307
2309
|
},
|
|
@@ -2600,7 +2602,7 @@
|
|
|
2600
2602
|
"name": "no-credentials",
|
|
2601
2603
|
"description": "Indicates whether or not cross-site Access-Control requests should be made.\nDefault is false.",
|
|
2602
2604
|
"type": "boolean",
|
|
2603
|
-
"default": "
|
|
2605
|
+
"default": "false"
|
|
2604
2606
|
},
|
|
2605
2607
|
{
|
|
2606
2608
|
"name": "silent",
|
|
@@ -2736,7 +2738,7 @@
|
|
|
2736
2738
|
"attribute": "no-credentials",
|
|
2737
2739
|
"description": "Indicates whether or not cross-site Access-Control requests should be made.\nDefault is false.",
|
|
2738
2740
|
"type": "boolean",
|
|
2739
|
-
"default": "
|
|
2741
|
+
"default": "false"
|
|
2740
2742
|
},
|
|
2741
2743
|
{
|
|
2742
2744
|
"name": "silent",
|
|
@@ -5356,7 +5358,7 @@
|
|
|
5356
5358
|
"name": "no-credentials",
|
|
5357
5359
|
"description": "Indicates whether or not cross-site Access-Control requests should be made.\nDefault is false.",
|
|
5358
5360
|
"type": "boolean",
|
|
5359
|
-
"default": "
|
|
5361
|
+
"default": "false"
|
|
5360
5362
|
},
|
|
5361
5363
|
{
|
|
5362
5364
|
"name": "silent",
|
|
@@ -5486,7 +5488,7 @@
|
|
|
5486
5488
|
"attribute": "no-credentials",
|
|
5487
5489
|
"description": "Indicates whether or not cross-site Access-Control requests should be made.\nDefault is false.",
|
|
5488
5490
|
"type": "boolean",
|
|
5489
|
-
"default": "
|
|
5491
|
+
"default": "false"
|
|
5490
5492
|
},
|
|
5491
5493
|
{
|
|
5492
5494
|
"name": "silent",
|
|
@@ -10748,42 +10750,42 @@
|
|
|
10748
10750
|
},
|
|
10749
10751
|
{
|
|
10750
10752
|
"name": "odd",
|
|
10751
|
-
"description": "The ODD to use for rendering the document. Overwrites an ODD defined on\n`pb-document`. The odd should be specified by its name without path\nor the `.odd` suffix.",
|
|
10753
|
+
"description": "The ODD to use for rendering the document. Overwrites an ODD defined on\r\n`pb-document`. The odd should be specified by its name without path\r\nor the `.odd` suffix.",
|
|
10752
10754
|
"type": "string"
|
|
10753
10755
|
},
|
|
10754
10756
|
{
|
|
10755
10757
|
"name": "view",
|
|
10756
|
-
"description": "The view type to use for paginating the document. Either `page`, `div` or `single`.\nOverwrites the same property specified on `pb-document`. Values have the following meaning:\n\nValue | Displayed content\n------|------------------\n`page` | content is displayed page by page as determined by tei:pb\n`div` | content is displayed by divisions\n`single` | do not paginate but display entire content at once",
|
|
10758
|
+
"description": "The view type to use for paginating the document. Either `page`, `div` or `single`.\r\nOverwrites the same property specified on `pb-document`. Values have the following meaning:\r\n\r\nValue | Displayed content\r\n------|------------------\r\n`page` | content is displayed page by page as determined by tei:pb\r\n`div` | content is displayed by divisions\r\n`single` | do not paginate but display entire content at once",
|
|
10757
10759
|
"type": "string"
|
|
10758
10760
|
},
|
|
10759
10761
|
{
|
|
10760
10762
|
"name": "node-id",
|
|
10761
|
-
"description": "An eXist nodeId. If specified, selects the root of the fragment of the document\nwhich should be displayed. Normally this property is set automatically by pagination.",
|
|
10763
|
+
"description": "An eXist nodeId. If specified, selects the root of the fragment of the document\r\nwhich should be displayed. Normally this property is set automatically by pagination.",
|
|
10762
10764
|
"type": "string"
|
|
10763
10765
|
},
|
|
10764
10766
|
{
|
|
10765
10767
|
"name": "xml-id",
|
|
10766
|
-
"description": "An xml:id to be displayed. If specified, this determines the root of the fragment to be\ndisplayed. Use to directly navigate to a specific section.",
|
|
10768
|
+
"description": "An xml:id to be displayed. If specified, this determines the root of the fragment to be\r\ndisplayed. Use to directly navigate to a specific section.",
|
|
10767
10769
|
"type": "array"
|
|
10768
10770
|
},
|
|
10769
10771
|
{
|
|
10770
10772
|
"name": "xpath",
|
|
10771
|
-
"description": "An optional XPath expression: the root of the fragment to be processed is determined\nby evaluating the given XPath expression. The XPath expression should be absolute.\nThe namespace of the document is declared as default namespace, so no prefixes should\nbe used.\n\nIf the `map` property is used, it may change scope for the displayed fragment.",
|
|
10773
|
+
"description": "An optional XPath expression: the root of the fragment to be processed is determined\r\nby evaluating the given XPath expression. The XPath expression should be absolute.\r\nThe namespace of the document is declared as default namespace, so no prefixes should\r\nbe used.\r\n\r\nIf the `map` property is used, it may change scope for the displayed fragment.",
|
|
10772
10774
|
"type": "string"
|
|
10773
10775
|
},
|
|
10774
10776
|
{
|
|
10775
10777
|
"name": "map",
|
|
10776
|
-
"description": "If defined denotes the local name of an XQuery function in `modules/map.xql`, which will be called\nwith the current root node and should return the node of a mapped fragment. This is helpful if one\nwants, for example, to show a translation fragment aligned with the part of the transcription currently\nshown. In this case, the properties of the `pb-view` would still point to the transcription, but the function\nidentified by map would return the corresponding fragment from the translation to be processed.\n\nNavigation in the document is still determined by the current root as defined through the `root`, `xpath`\nand `xmlId` properties.",
|
|
10778
|
+
"description": "If defined denotes the local name of an XQuery function in `modules/map.xql`, which will be called\r\nwith the current root node and should return the node of a mapped fragment. This is helpful if one\r\nwants, for example, to show a translation fragment aligned with the part of the transcription currently\r\nshown. In this case, the properties of the `pb-view` would still point to the transcription, but the function\r\nidentified by map would return the corresponding fragment from the translation to be processed.\r\n\r\nNavigation in the document is still determined by the current root as defined through the `root`, `xpath`\r\nand `xmlId` properties.",
|
|
10777
10779
|
"type": "string"
|
|
10778
10780
|
},
|
|
10779
10781
|
{
|
|
10780
10782
|
"name": "column-separator",
|
|
10781
|
-
"description": "CSS selector to find column breaks in the content returned\nfrom the server. If this property is set and column breaks\nare found, the component will display two columns side by side.",
|
|
10783
|
+
"description": "CSS selector to find column breaks in the content returned\r\nfrom the server. If this property is set and column breaks\r\nare found, the component will display two columns side by side.",
|
|
10782
10784
|
"type": "string"
|
|
10783
10785
|
},
|
|
10784
10786
|
{
|
|
10785
10787
|
"name": "load-css",
|
|
10786
|
-
"description": "If set, points to an external stylesheet which should be applied to\nthe text *after* the ODD-generated styles.",
|
|
10788
|
+
"description": "If set, points to an external stylesheet which should be applied to\r\nthe text *after* the ODD-generated styles.",
|
|
10787
10789
|
"type": "string"
|
|
10788
10790
|
},
|
|
10789
10791
|
{
|
|
@@ -10793,17 +10795,17 @@
|
|
|
10793
10795
|
},
|
|
10794
10796
|
{
|
|
10795
10797
|
"name": "use-language",
|
|
10796
|
-
"description": "If set, a refresh will be triggered if a `pb-i18n-update` event is received,\ne.g. due to the user selecting a different interface language.\n\nAlso requires `requireLanguage` to be set on the surrounding `pb-page`.\nSee there for more information.",
|
|
10798
|
+
"description": "If set, a refresh will be triggered if a `pb-i18n-update` event is received,\r\ne.g. due to the user selecting a different interface language.\r\n\r\nAlso requires `requireLanguage` to be set on the surrounding `pb-page`.\r\nSee there for more information.",
|
|
10797
10799
|
"type": "boolean"
|
|
10798
10800
|
},
|
|
10799
10801
|
{
|
|
10800
10802
|
"name": "infinite-scroll",
|
|
10801
|
-
"description": "Experimental: if enabled, the view will incrementally load new document fragments if the user tries to scroll\nbeyond the start or end of the visible text. The feature inserts a small blank section at the top\nand bottom. If this section becomes visible, a load operation will be triggered.\n\nNote: only browsers implementing the `IntersectionObserver` API are supported. Also the feature\ndoes not work in two-column mode or with animations.",
|
|
10803
|
+
"description": "Experimental: if enabled, the view will incrementally load new document fragments if the user tries to scroll\r\nbeyond the start or end of the visible text. The feature inserts a small blank section at the top\r\nand bottom. If this section becomes visible, a load operation will be triggered.\r\n\r\nNote: only browsers implementing the `IntersectionObserver` API are supported. Also the feature\r\ndoes not work in two-column mode or with animations.",
|
|
10802
10804
|
"type": "boolean"
|
|
10803
10805
|
},
|
|
10804
10806
|
{
|
|
10805
10807
|
"name": "src",
|
|
10806
|
-
"description": "The id of a `pb-document` element this view should display.\nSettings like `odd` or `view` will be taken from the `pb-document`\nunless overwritten by properties in this component.\n\nThis property is **required** and **must** point to an existing `pb-document` with\nthe given id.\n\nSetting the property after initialization will clear the properties xmlId, nodeId and odd.",
|
|
10808
|
+
"description": "The id of a `pb-document` element this view should display.\r\nSettings like `odd` or `view` will be taken from the `pb-document`\r\nunless overwritten by properties in this component.\r\n\r\nThis property is **required** and **must** point to an existing `pb-document` with\r\nthe given id.\r\n\r\nSetting the property after initialization will clear the properties xmlId, nodeId and odd.",
|
|
10807
10809
|
"type": "string"
|
|
10808
10810
|
},
|
|
10809
10811
|
{
|
|
@@ -10813,25 +10815,25 @@
|
|
|
10813
10815
|
},
|
|
10814
10816
|
{
|
|
10815
10817
|
"name": "on-update",
|
|
10816
|
-
"description": "If set to true, the component will not load automatically. Instead it will wait until it receives a `pb-update`\nevent. Use this to make one `pb-view` component dependent on another one. Default is 'false'.",
|
|
10818
|
+
"description": "If set to true, the component will not load automatically. Instead it will wait until it receives a `pb-update`\r\nevent. Use this to make one `pb-view` component dependent on another one. Default is 'false'.",
|
|
10817
10819
|
"type": "boolean",
|
|
10818
10820
|
"default": "false"
|
|
10819
10821
|
},
|
|
10820
10822
|
{
|
|
10821
10823
|
"name": "append-footnotes",
|
|
10822
|
-
"description": "The server returns footnotes separately. Set this property\nif you wish to append them to the main text.",
|
|
10824
|
+
"description": "The server returns footnotes separately. Set this property\r\nif you wish to append them to the main text.",
|
|
10823
10825
|
"type": "boolean",
|
|
10824
10826
|
"default": "false"
|
|
10825
10827
|
},
|
|
10826
10828
|
{
|
|
10827
10829
|
"name": "not-found",
|
|
10828
|
-
"description": "Message to display if no content was returned by the server.\nSet to empty string to show nothing.",
|
|
10830
|
+
"description": "Message to display if no content was returned by the server.\r\nSet to empty string to show nothing.",
|
|
10829
10831
|
"type": "string",
|
|
10830
10832
|
"default": "\"the server did not return any content\""
|
|
10831
10833
|
},
|
|
10832
10834
|
{
|
|
10833
10835
|
"name": "animation",
|
|
10834
|
-
"description": "wether to animate the view when new page is loaded. Defaults to 'false' meaning that no\nanimation takes place. If 'true' will apply a translateX transistion in forward/backward direction.",
|
|
10836
|
+
"description": "wether to animate the view when new page is loaded. Defaults to 'false' meaning that no\r\nanimation takes place. If 'true' will apply a translateX transistion in forward/backward direction.",
|
|
10835
10837
|
"type": "boolean",
|
|
10836
10838
|
"default": "false"
|
|
10837
10839
|
},
|
|
@@ -10849,30 +10851,30 @@
|
|
|
10849
10851
|
},
|
|
10850
10852
|
{
|
|
10851
10853
|
"name": "infinite-scroll-max",
|
|
10852
|
-
"description": "Maximum number of fragments to keep in memory if `infinite-scroll`\nis enabled. If the user is scrolling beyond the maximum, fragements\nwill be removed from the DOM before or after the current reading position.\nDefault is 10. Set to zero to allow loading the entire document.",
|
|
10854
|
+
"description": "Maximum number of fragments to keep in memory if `infinite-scroll`\r\nis enabled. If the user is scrolling beyond the maximum, fragements\r\nwill be removed from the DOM before or after the current reading position.\r\nDefault is 10. Set to zero to allow loading the entire document.",
|
|
10853
10855
|
"type": "number",
|
|
10854
10856
|
"default": "10"
|
|
10855
10857
|
},
|
|
10856
10858
|
{
|
|
10857
10859
|
"name": "disable-history",
|
|
10858
|
-
"description": "By default, navigating to next/previous page will update browser parameters,\nso reloading the page will load the correct position within the document.\n\nSet this property to disable location tracking for the component altogether.",
|
|
10860
|
+
"description": "By default, navigating to next/previous page will update browser parameters,\r\nso reloading the page will load the correct position within the document.\r\n\r\nSet this property to disable location tracking for the component altogether.",
|
|
10859
10861
|
"type": "boolean",
|
|
10860
10862
|
"default": "false"
|
|
10861
10863
|
},
|
|
10862
10864
|
{
|
|
10863
10865
|
"name": "before-update-event",
|
|
10864
|
-
"description": "If set to the name of an event, the content of the pb-view will not be replaced\nimmediately upon updates. Instead, an event is emitted, which contains the new content\nin property `root`. An event handler intercepting the event can thus modify the content.\nOnce it is done, it should pass the modified content to the callback function provided\nin the event detail under the name `render`. See the demo for an example.",
|
|
10866
|
+
"description": "If set to the name of an event, the content of the pb-view will not be replaced\r\nimmediately upon updates. Instead, an event is emitted, which contains the new content\r\nin property `root`. An event handler intercepting the event can thus modify the content.\r\nOnce it is done, it should pass the modified content to the callback function provided\r\nin the event detail under the name `render`. See the demo for an example.",
|
|
10865
10867
|
"type": "string"
|
|
10866
10868
|
},
|
|
10867
10869
|
{
|
|
10868
10870
|
"name": "no-scroll",
|
|
10869
|
-
"description": "If set, do not scroll the view to target node (e.g. given in URL hash) \nafter content was loaded.",
|
|
10871
|
+
"description": "If set, do not scroll the view to target node (e.g. given in URL hash) \r\nafter content was loaded.",
|
|
10870
10872
|
"type": "boolean",
|
|
10871
10873
|
"default": "false"
|
|
10872
10874
|
},
|
|
10873
10875
|
{
|
|
10874
10876
|
"name": "static",
|
|
10875
|
-
"description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required. Use this in combination with\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).\nThe value should point to the HTTP root path under which the static version\nwill be hosted. This is used to resolve CSS stylesheets.",
|
|
10877
|
+
"description": "If set, rewrite URLs to load pages as static HTML files,\r\nso no TEI Publisher instance is required. Use this in combination with\r\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).\r\nThe value should point to the HTTP root path under which the static version\r\nwill be hosted. This is used to resolve CSS stylesheets.",
|
|
10876
10878
|
"type": "string"
|
|
10877
10879
|
},
|
|
10878
10880
|
{
|
|
@@ -10897,7 +10899,7 @@
|
|
|
10897
10899
|
},
|
|
10898
10900
|
{
|
|
10899
10901
|
"name": "wait-for",
|
|
10900
|
-
"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.\n\n`pb-view` by default sets this property to select `pb-toggle-feature` and `pb-select-feature` \nelements.",
|
|
10902
|
+
"description": "A selector pointing to other components this component depends on.\r\nWhen method `wait` is called, it will wait until all referenced\r\ncomponents signal with a `pb-ready` event that they are ready and listening\r\nto events.\r\n\r\n`pb-view` by default sets this property to select `pb-toggle-feature` and `pb-select-feature` \r\nelements.",
|
|
10901
10903
|
"type": "string"
|
|
10902
10904
|
},
|
|
10903
10905
|
{
|
|
@@ -10935,49 +10937,49 @@
|
|
|
10935
10937
|
{
|
|
10936
10938
|
"name": "odd",
|
|
10937
10939
|
"attribute": "odd",
|
|
10938
|
-
"description": "The ODD to use for rendering the document. Overwrites an ODD defined on\n`pb-document`. The odd should be specified by its name without path\nor the `.odd` suffix.",
|
|
10940
|
+
"description": "The ODD to use for rendering the document. Overwrites an ODD defined on\r\n`pb-document`. The odd should be specified by its name without path\r\nor the `.odd` suffix.",
|
|
10939
10941
|
"type": "string"
|
|
10940
10942
|
},
|
|
10941
10943
|
{
|
|
10942
10944
|
"name": "view",
|
|
10943
10945
|
"attribute": "view",
|
|
10944
|
-
"description": "The view type to use for paginating the document. Either `page`, `div` or `single`.\nOverwrites the same property specified on `pb-document`. Values have the following meaning:\n\nValue | Displayed content\n------|------------------\n`page` | content is displayed page by page as determined by tei:pb\n`div` | content is displayed by divisions\n`single` | do not paginate but display entire content at once",
|
|
10946
|
+
"description": "The view type to use for paginating the document. Either `page`, `div` or `single`.\r\nOverwrites the same property specified on `pb-document`. Values have the following meaning:\r\n\r\nValue | Displayed content\r\n------|------------------\r\n`page` | content is displayed page by page as determined by tei:pb\r\n`div` | content is displayed by divisions\r\n`single` | do not paginate but display entire content at once",
|
|
10945
10947
|
"type": "string"
|
|
10946
10948
|
},
|
|
10947
10949
|
{
|
|
10948
10950
|
"name": "nodeId",
|
|
10949
10951
|
"attribute": "node-id",
|
|
10950
|
-
"description": "An eXist nodeId. If specified, selects the root of the fragment of the document\nwhich should be displayed. Normally this property is set automatically by pagination.",
|
|
10952
|
+
"description": "An eXist nodeId. If specified, selects the root of the fragment of the document\r\nwhich should be displayed. Normally this property is set automatically by pagination.",
|
|
10951
10953
|
"type": "string"
|
|
10952
10954
|
},
|
|
10953
10955
|
{
|
|
10954
10956
|
"name": "xmlId",
|
|
10955
10957
|
"attribute": "xml-id",
|
|
10956
|
-
"description": "An xml:id to be displayed. If specified, this determines the root of the fragment to be\ndisplayed. Use to directly navigate to a specific section.",
|
|
10958
|
+
"description": "An xml:id to be displayed. If specified, this determines the root of the fragment to be\r\ndisplayed. Use to directly navigate to a specific section.",
|
|
10957
10959
|
"type": "array"
|
|
10958
10960
|
},
|
|
10959
10961
|
{
|
|
10960
10962
|
"name": "xpath",
|
|
10961
10963
|
"attribute": "xpath",
|
|
10962
|
-
"description": "An optional XPath expression: the root of the fragment to be processed is determined\nby evaluating the given XPath expression. The XPath expression should be absolute.\nThe namespace of the document is declared as default namespace, so no prefixes should\nbe used.\n\nIf the `map` property is used, it may change scope for the displayed fragment.",
|
|
10964
|
+
"description": "An optional XPath expression: the root of the fragment to be processed is determined\r\nby evaluating the given XPath expression. The XPath expression should be absolute.\r\nThe namespace of the document is declared as default namespace, so no prefixes should\r\nbe used.\r\n\r\nIf the `map` property is used, it may change scope for the displayed fragment.",
|
|
10963
10965
|
"type": "string"
|
|
10964
10966
|
},
|
|
10965
10967
|
{
|
|
10966
10968
|
"name": "map",
|
|
10967
10969
|
"attribute": "map",
|
|
10968
|
-
"description": "If defined denotes the local name of an XQuery function in `modules/map.xql`, which will be called\nwith the current root node and should return the node of a mapped fragment. This is helpful if one\nwants, for example, to show a translation fragment aligned with the part of the transcription currently\nshown. In this case, the properties of the `pb-view` would still point to the transcription, but the function\nidentified by map would return the corresponding fragment from the translation to be processed.\n\nNavigation in the document is still determined by the current root as defined through the `root`, `xpath`\nand `xmlId` properties.",
|
|
10970
|
+
"description": "If defined denotes the local name of an XQuery function in `modules/map.xql`, which will be called\r\nwith the current root node and should return the node of a mapped fragment. This is helpful if one\r\nwants, for example, to show a translation fragment aligned with the part of the transcription currently\r\nshown. In this case, the properties of the `pb-view` would still point to the transcription, but the function\r\nidentified by map would return the corresponding fragment from the translation to be processed.\r\n\r\nNavigation in the document is still determined by the current root as defined through the `root`, `xpath`\r\nand `xmlId` properties.",
|
|
10969
10971
|
"type": "string"
|
|
10970
10972
|
},
|
|
10971
10973
|
{
|
|
10972
10974
|
"name": "columnSeparator",
|
|
10973
10975
|
"attribute": "column-separator",
|
|
10974
|
-
"description": "CSS selector to find column breaks in the content returned\nfrom the server. If this property is set and column breaks\nare found, the component will display two columns side by side.",
|
|
10976
|
+
"description": "CSS selector to find column breaks in the content returned\r\nfrom the server. If this property is set and column breaks\r\nare found, the component will display two columns side by side.",
|
|
10975
10977
|
"type": "string"
|
|
10976
10978
|
},
|
|
10977
10979
|
{
|
|
10978
10980
|
"name": "loadCss",
|
|
10979
10981
|
"attribute": "load-css",
|
|
10980
|
-
"description": "If set, points to an external stylesheet which should be applied to\nthe text *after* the ODD-generated styles.",
|
|
10982
|
+
"description": "If set, points to an external stylesheet which should be applied to\r\nthe text *after* the ODD-generated styles.",
|
|
10981
10983
|
"type": "string"
|
|
10982
10984
|
},
|
|
10983
10985
|
{
|
|
@@ -10989,19 +10991,19 @@
|
|
|
10989
10991
|
{
|
|
10990
10992
|
"name": "useLanguage",
|
|
10991
10993
|
"attribute": "use-language",
|
|
10992
|
-
"description": "If set, a refresh will be triggered if a `pb-i18n-update` event is received,\ne.g. due to the user selecting a different interface language.\n\nAlso requires `requireLanguage` to be set on the surrounding `pb-page`.\nSee there for more information.",
|
|
10994
|
+
"description": "If set, a refresh will be triggered if a `pb-i18n-update` event is received,\r\ne.g. due to the user selecting a different interface language.\r\n\r\nAlso requires `requireLanguage` to be set on the surrounding `pb-page`.\r\nSee there for more information.",
|
|
10993
10995
|
"type": "boolean"
|
|
10994
10996
|
},
|
|
10995
10997
|
{
|
|
10996
10998
|
"name": "infiniteScroll",
|
|
10997
10999
|
"attribute": "infinite-scroll",
|
|
10998
|
-
"description": "Experimental: if enabled, the view will incrementally load new document fragments if the user tries to scroll\nbeyond the start or end of the visible text. The feature inserts a small blank section at the top\nand bottom. If this section becomes visible, a load operation will be triggered.\n\nNote: only browsers implementing the `IntersectionObserver` API are supported. Also the feature\ndoes not work in two-column mode or with animations.",
|
|
11000
|
+
"description": "Experimental: if enabled, the view will incrementally load new document fragments if the user tries to scroll\r\nbeyond the start or end of the visible text. The feature inserts a small blank section at the top\r\nand bottom. If this section becomes visible, a load operation will be triggered.\r\n\r\nNote: only browsers implementing the `IntersectionObserver` API are supported. Also the feature\r\ndoes not work in two-column mode or with animations.",
|
|
10999
11001
|
"type": "boolean"
|
|
11000
11002
|
},
|
|
11001
11003
|
{
|
|
11002
11004
|
"name": "src",
|
|
11003
11005
|
"attribute": "src",
|
|
11004
|
-
"description": "The id of a `pb-document` element this view should display.\nSettings like `odd` or `view` will be taken from the `pb-document`\nunless overwritten by properties in this component.\n\nThis property is **required** and **must** point to an existing `pb-document` with\nthe given id.\n\nSetting the property after initialization will clear the properties xmlId, nodeId and odd.",
|
|
11006
|
+
"description": "The id of a `pb-document` element this view should display.\r\nSettings like `odd` or `view` will be taken from the `pb-document`\r\nunless overwritten by properties in this component.\r\n\r\nThis property is **required** and **must** point to an existing `pb-document` with\r\nthe given id.\r\n\r\nSetting the property after initialization will clear the properties xmlId, nodeId and odd.",
|
|
11005
11007
|
"type": "string"
|
|
11006
11008
|
},
|
|
11007
11009
|
{
|
|
@@ -11013,28 +11015,28 @@
|
|
|
11013
11015
|
{
|
|
11014
11016
|
"name": "onUpdate",
|
|
11015
11017
|
"attribute": "on-update",
|
|
11016
|
-
"description": "If set to true, the component will not load automatically. Instead it will wait until it receives a `pb-update`\nevent. Use this to make one `pb-view` component dependent on another one. Default is 'false'.",
|
|
11018
|
+
"description": "If set to true, the component will not load automatically. Instead it will wait until it receives a `pb-update`\r\nevent. Use this to make one `pb-view` component dependent on another one. Default is 'false'.",
|
|
11017
11019
|
"type": "boolean",
|
|
11018
11020
|
"default": "false"
|
|
11019
11021
|
},
|
|
11020
11022
|
{
|
|
11021
11023
|
"name": "appendFootnotes",
|
|
11022
11024
|
"attribute": "append-footnotes",
|
|
11023
|
-
"description": "The server returns footnotes separately. Set this property\nif you wish to append them to the main text.",
|
|
11025
|
+
"description": "The server returns footnotes separately. Set this property\r\nif you wish to append them to the main text.",
|
|
11024
11026
|
"type": "boolean",
|
|
11025
11027
|
"default": "false"
|
|
11026
11028
|
},
|
|
11027
11029
|
{
|
|
11028
11030
|
"name": "notFound",
|
|
11029
11031
|
"attribute": "not-found",
|
|
11030
|
-
"description": "Message to display if no content was returned by the server.\nSet to empty string to show nothing.",
|
|
11032
|
+
"description": "Message to display if no content was returned by the server.\r\nSet to empty string to show nothing.",
|
|
11031
11033
|
"type": "string",
|
|
11032
11034
|
"default": "\"the server did not return any content\""
|
|
11033
11035
|
},
|
|
11034
11036
|
{
|
|
11035
11037
|
"name": "animation",
|
|
11036
11038
|
"attribute": "animation",
|
|
11037
|
-
"description": "wether to animate the view when new page is loaded. Defaults to 'false' meaning that no\nanimation takes place. If 'true' will apply a translateX transistion in forward/backward direction.",
|
|
11039
|
+
"description": "wether to animate the view when new page is loaded. Defaults to 'false' meaning that no\r\nanimation takes place. If 'true' will apply a translateX transistion in forward/backward direction.",
|
|
11038
11040
|
"type": "boolean",
|
|
11039
11041
|
"default": "false"
|
|
11040
11042
|
},
|
|
@@ -11060,34 +11062,34 @@
|
|
|
11060
11062
|
{
|
|
11061
11063
|
"name": "infiniteScrollMax",
|
|
11062
11064
|
"attribute": "infinite-scroll-max",
|
|
11063
|
-
"description": "Maximum number of fragments to keep in memory if `infinite-scroll`\nis enabled. If the user is scrolling beyond the maximum, fragements\nwill be removed from the DOM before or after the current reading position.\nDefault is 10. Set to zero to allow loading the entire document.",
|
|
11065
|
+
"description": "Maximum number of fragments to keep in memory if `infinite-scroll`\r\nis enabled. If the user is scrolling beyond the maximum, fragements\r\nwill be removed from the DOM before or after the current reading position.\r\nDefault is 10. Set to zero to allow loading the entire document.",
|
|
11064
11066
|
"type": "number",
|
|
11065
11067
|
"default": "10"
|
|
11066
11068
|
},
|
|
11067
11069
|
{
|
|
11068
11070
|
"name": "disableHistory",
|
|
11069
11071
|
"attribute": "disable-history",
|
|
11070
|
-
"description": "By default, navigating to next/previous page will update browser parameters,\nso reloading the page will load the correct position within the document.\n\nSet this property to disable location tracking for the component altogether.",
|
|
11072
|
+
"description": "By default, navigating to next/previous page will update browser parameters,\r\nso reloading the page will load the correct position within the document.\r\n\r\nSet this property to disable location tracking for the component altogether.",
|
|
11071
11073
|
"type": "boolean",
|
|
11072
11074
|
"default": "false"
|
|
11073
11075
|
},
|
|
11074
11076
|
{
|
|
11075
11077
|
"name": "beforeUpdate",
|
|
11076
11078
|
"attribute": "before-update-event",
|
|
11077
|
-
"description": "If set to the name of an event, the content of the pb-view will not be replaced\nimmediately upon updates. Instead, an event is emitted, which contains the new content\nin property `root`. An event handler intercepting the event can thus modify the content.\nOnce it is done, it should pass the modified content to the callback function provided\nin the event detail under the name `render`. See the demo for an example.",
|
|
11079
|
+
"description": "If set to the name of an event, the content of the pb-view will not be replaced\r\nimmediately upon updates. Instead, an event is emitted, which contains the new content\r\nin property `root`. An event handler intercepting the event can thus modify the content.\r\nOnce it is done, it should pass the modified content to the callback function provided\r\nin the event detail under the name `render`. See the demo for an example.",
|
|
11078
11080
|
"type": "string"
|
|
11079
11081
|
},
|
|
11080
11082
|
{
|
|
11081
11083
|
"name": "noScroll",
|
|
11082
11084
|
"attribute": "no-scroll",
|
|
11083
|
-
"description": "If set, do not scroll the view to target node (e.g. given in URL hash) \nafter content was loaded.",
|
|
11085
|
+
"description": "If set, do not scroll the view to target node (e.g. given in URL hash) \r\nafter content was loaded.",
|
|
11084
11086
|
"type": "boolean",
|
|
11085
11087
|
"default": "false"
|
|
11086
11088
|
},
|
|
11087
11089
|
{
|
|
11088
11090
|
"name": "static",
|
|
11089
11091
|
"attribute": "static",
|
|
11090
|
-
"description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required. Use this in combination with\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).\nThe value should point to the HTTP root path under which the static version\nwill be hosted. This is used to resolve CSS stylesheets.",
|
|
11092
|
+
"description": "If set, rewrite URLs to load pages as static HTML files,\r\nso no TEI Publisher instance is required. Use this in combination with\r\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).\r\nThe value should point to the HTTP root path under which the static version\r\nwill be hosted. This is used to resolve CSS stylesheets.",
|
|
11091
11093
|
"type": "string"
|
|
11092
11094
|
},
|
|
11093
11095
|
{
|
|
@@ -11117,7 +11119,7 @@
|
|
|
11117
11119
|
{
|
|
11118
11120
|
"name": "waitFor",
|
|
11119
11121
|
"attribute": "wait-for",
|
|
11120
|
-
"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.\n\n`pb-view` by default sets this property to select `pb-toggle-feature` and `pb-select-feature` \nelements.",
|
|
11122
|
+
"description": "A selector pointing to other components this component depends on.\r\nWhen method `wait` is called, it will wait until all referenced\r\ncomponents signal with a `pb-ready` event that they are ready and listening\r\nto events.\r\n\r\n`pb-view` by default sets this property to select `pb-toggle-feature` and `pb-select-feature` \r\nelements.",
|
|
11121
11123
|
"type": "string"
|
|
11122
11124
|
},
|
|
11123
11125
|
{
|
|
@@ -11230,46 +11232,46 @@
|
|
|
11230
11232
|
{
|
|
11231
11233
|
"name": "pb-view",
|
|
11232
11234
|
"path": "./src/pb-view.js",
|
|
11233
|
-
"description": "This is the main component for viewing text which has been transformed via an ODD.\nThe document to be viewed is determined by the `pb-document` element the property\n`src` points to. If not overwritten, `pb-view` will use the settings defined by\nthe connected document, like view type, ODD etc.\n\n`pb-view` can display an entire document or just a fragment of it\nas defined by the properties `xpath`, `xmlId` or `nodeId`. The most common use case\nis to set `xpath` to point to a specific part of a document.\n\nNavigating to the next or previous fragment would usually be triggered by a separate\n`pb-navigation` element, which sends a `pb-navigate` event to the `pb-view`. However,\n`pb-view` also implements automatic loading of next/previous fragments if the user\nscrolls the page beyond the current viewport boudaries. To enable this, set property\n`infinite-scroll`.\n\nYou may also define optional parameters to be passed to the ODD in nested `pb-param`\ntags. These parameters can be accessed within the ODD via the `$parameters` map. For\nexample, the following snippet is being used to output breadcrumbs above the main text\nin the documentation view:\n\n```xml\n<section class=\"breadcrumbs\">\n <pb-view id=\"title-view1\" src=\"document1\" subscribe=\"transcription\">\n <pb-param name=\"mode\" value=\"breadcrumbs\"/>\n </pb-view>\n</section>\n```",
|
|
11235
|
+
"description": "This is the main component for viewing text which has been transformed via an ODD.\r\nThe document to be viewed is determined by the `pb-document` element the property\r\n`src` points to. If not overwritten, `pb-view` will use the settings defined by\r\nthe connected document, like view type, ODD etc.\r\n\r\n`pb-view` can display an entire document or just a fragment of it\r\nas defined by the properties `xpath`, `xmlId` or `nodeId`. The most common use case\r\nis to set `xpath` to point to a specific part of a document.\r\n\r\nNavigating to the next or previous fragment would usually be triggered by a separate\r\n`pb-navigation` element, which sends a `pb-navigate` event to the `pb-view`. However,\r\n`pb-view` also implements automatic loading of next/previous fragments if the user\r\nscrolls the page beyond the current viewport boudaries. To enable this, set property\r\n`infinite-scroll`.\r\n\r\nYou may also define optional parameters to be passed to the ODD in nested `pb-param`\r\ntags. These parameters can be accessed within the ODD via the `$parameters` map. For\r\nexample, the following snippet is being used to output breadcrumbs above the main text\r\nin the documentation view:\r\n\r\n```xml\r\n<section class=\"breadcrumbs\">\r\n <pb-view id=\"title-view1\" src=\"document1\" subscribe=\"transcription\">\r\n <pb-param name=\"mode\" value=\"breadcrumbs\"/>\r\n </pb-view>\r\n</section>\r\n```",
|
|
11234
11236
|
"attributes": [
|
|
11235
11237
|
{
|
|
11236
11238
|
"name": "odd",
|
|
11237
|
-
"description": "The ODD to use for rendering the document. Overwrites an ODD defined on\n`pb-document`. The odd should be specified by its name without path\nor the `.odd` suffix.",
|
|
11239
|
+
"description": "The ODD to use for rendering the document. Overwrites an ODD defined on\r\n`pb-document`. The odd should be specified by its name without path\r\nor the `.odd` suffix.",
|
|
11238
11240
|
"type": "string"
|
|
11239
11241
|
},
|
|
11240
11242
|
{
|
|
11241
11243
|
"name": "view",
|
|
11242
|
-
"description": "The view type to use for paginating the document. Either `page`, `div` or `single`.\nOverwrites the same property specified on `pb-document`. Values have the following meaning:\n\nValue | Displayed content\n------|------------------\n`page` | content is displayed page by page as determined by tei:pb\n`div` | content is displayed by divisions\n`single` | do not paginate but display entire content at once",
|
|
11244
|
+
"description": "The view type to use for paginating the document. Either `page`, `div` or `single`.\r\nOverwrites the same property specified on `pb-document`. Values have the following meaning:\r\n\r\nValue | Displayed content\r\n------|------------------\r\n`page` | content is displayed page by page as determined by tei:pb\r\n`div` | content is displayed by divisions\r\n`single` | do not paginate but display entire content at once",
|
|
11243
11245
|
"type": "string"
|
|
11244
11246
|
},
|
|
11245
11247
|
{
|
|
11246
11248
|
"name": "node-id",
|
|
11247
|
-
"description": "An eXist nodeId. If specified, selects the root of the fragment of the document\nwhich should be displayed. Normally this property is set automatically by pagination.",
|
|
11249
|
+
"description": "An eXist nodeId. If specified, selects the root of the fragment of the document\r\nwhich should be displayed. Normally this property is set automatically by pagination.",
|
|
11248
11250
|
"type": "string"
|
|
11249
11251
|
},
|
|
11250
11252
|
{
|
|
11251
11253
|
"name": "xml-id",
|
|
11252
|
-
"description": "An xml:id to be displayed. If specified, this determines the root of the fragment to be\ndisplayed. Use to directly navigate to a specific section.",
|
|
11254
|
+
"description": "An xml:id to be displayed. If specified, this determines the root of the fragment to be\r\ndisplayed. Use to directly navigate to a specific section.",
|
|
11253
11255
|
"type": "array"
|
|
11254
11256
|
},
|
|
11255
11257
|
{
|
|
11256
11258
|
"name": "xpath",
|
|
11257
|
-
"description": "An optional XPath expression: the root of the fragment to be processed is determined\nby evaluating the given XPath expression. The XPath expression should be absolute.\nThe namespace of the document is declared as default namespace, so no prefixes should\nbe used.\n\nIf the `map` property is used, it may change scope for the displayed fragment.",
|
|
11259
|
+
"description": "An optional XPath expression: the root of the fragment to be processed is determined\r\nby evaluating the given XPath expression. The XPath expression should be absolute.\r\nThe namespace of the document is declared as default namespace, so no prefixes should\r\nbe used.\r\n\r\nIf the `map` property is used, it may change scope for the displayed fragment.",
|
|
11258
11260
|
"type": "string"
|
|
11259
11261
|
},
|
|
11260
11262
|
{
|
|
11261
11263
|
"name": "map",
|
|
11262
|
-
"description": "If defined denotes the local name of an XQuery function in `modules/map.xql`, which will be called\nwith the current root node and should return the node of a mapped fragment. This is helpful if one\nwants, for example, to show a translation fragment aligned with the part of the transcription currently\nshown. In this case, the properties of the `pb-view` would still point to the transcription, but the function\nidentified by map would return the corresponding fragment from the translation to be processed.\n\nNavigation in the document is still determined by the current root as defined through the `root`, `xpath`\nand `xmlId` properties.",
|
|
11264
|
+
"description": "If defined denotes the local name of an XQuery function in `modules/map.xql`, which will be called\r\nwith the current root node and should return the node of a mapped fragment. This is helpful if one\r\nwants, for example, to show a translation fragment aligned with the part of the transcription currently\r\nshown. In this case, the properties of the `pb-view` would still point to the transcription, but the function\r\nidentified by map would return the corresponding fragment from the translation to be processed.\r\n\r\nNavigation in the document is still determined by the current root as defined through the `root`, `xpath`\r\nand `xmlId` properties.",
|
|
11263
11265
|
"type": "string"
|
|
11264
11266
|
},
|
|
11265
11267
|
{
|
|
11266
11268
|
"name": "column-separator",
|
|
11267
|
-
"description": "CSS selector to find column breaks in the content returned\nfrom the server. If this property is set and column breaks\nare found, the component will display two columns side by side.",
|
|
11269
|
+
"description": "CSS selector to find column breaks in the content returned\r\nfrom the server. If this property is set and column breaks\r\nare found, the component will display two columns side by side.",
|
|
11268
11270
|
"type": "string"
|
|
11269
11271
|
},
|
|
11270
11272
|
{
|
|
11271
11273
|
"name": "load-css",
|
|
11272
|
-
"description": "If set, points to an external stylesheet which should be applied to\nthe text *after* the ODD-generated styles.",
|
|
11274
|
+
"description": "If set, points to an external stylesheet which should be applied to\r\nthe text *after* the ODD-generated styles.",
|
|
11273
11275
|
"type": "string"
|
|
11274
11276
|
},
|
|
11275
11277
|
{
|
|
@@ -11279,17 +11281,17 @@
|
|
|
11279
11281
|
},
|
|
11280
11282
|
{
|
|
11281
11283
|
"name": "use-language",
|
|
11282
|
-
"description": "If set, a refresh will be triggered if a `pb-i18n-update` event is received,\ne.g. due to the user selecting a different interface language.\n\nAlso requires `requireLanguage` to be set on the surrounding `pb-page`.\nSee there for more information.",
|
|
11284
|
+
"description": "If set, a refresh will be triggered if a `pb-i18n-update` event is received,\r\ne.g. due to the user selecting a different interface language.\r\n\r\nAlso requires `requireLanguage` to be set on the surrounding `pb-page`.\r\nSee there for more information.",
|
|
11283
11285
|
"type": "boolean"
|
|
11284
11286
|
},
|
|
11285
11287
|
{
|
|
11286
11288
|
"name": "infinite-scroll",
|
|
11287
|
-
"description": "Experimental: if enabled, the view will incrementally load new document fragments if the user tries to scroll\nbeyond the start or end of the visible text. The feature inserts a small blank section at the top\nand bottom. If this section becomes visible, a load operation will be triggered.\n\nNote: only browsers implementing the `IntersectionObserver` API are supported. Also the feature\ndoes not work in two-column mode or with animations.",
|
|
11289
|
+
"description": "Experimental: if enabled, the view will incrementally load new document fragments if the user tries to scroll\r\nbeyond the start or end of the visible text. The feature inserts a small blank section at the top\r\nand bottom. If this section becomes visible, a load operation will be triggered.\r\n\r\nNote: only browsers implementing the `IntersectionObserver` API are supported. Also the feature\r\ndoes not work in two-column mode or with animations.",
|
|
11288
11290
|
"type": "boolean"
|
|
11289
11291
|
},
|
|
11290
11292
|
{
|
|
11291
11293
|
"name": "src",
|
|
11292
|
-
"description": "The id of a `pb-document` element this view should display.\nSettings like `odd` or `view` will be taken from the `pb-document`\nunless overwritten by properties in this component.\n\nThis property is **required** and **must** point to an existing `pb-document` with\nthe given id.\n\nSetting the property after initialization will clear the properties xmlId, nodeId and odd.",
|
|
11294
|
+
"description": "The id of a `pb-document` element this view should display.\r\nSettings like `odd` or `view` will be taken from the `pb-document`\r\nunless overwritten by properties in this component.\r\n\r\nThis property is **required** and **must** point to an existing `pb-document` with\r\nthe given id.\r\n\r\nSetting the property after initialization will clear the properties xmlId, nodeId and odd.",
|
|
11293
11295
|
"type": "string"
|
|
11294
11296
|
},
|
|
11295
11297
|
{
|
|
@@ -11299,25 +11301,25 @@
|
|
|
11299
11301
|
},
|
|
11300
11302
|
{
|
|
11301
11303
|
"name": "on-update",
|
|
11302
|
-
"description": "If set to true, the component will not load automatically. Instead it will wait until it receives a `pb-update`\nevent. Use this to make one `pb-view` component dependent on another one. Default is 'false'.",
|
|
11304
|
+
"description": "If set to true, the component will not load automatically. Instead it will wait until it receives a `pb-update`\r\nevent. Use this to make one `pb-view` component dependent on another one. Default is 'false'.",
|
|
11303
11305
|
"type": "boolean",
|
|
11304
11306
|
"default": "false"
|
|
11305
11307
|
},
|
|
11306
11308
|
{
|
|
11307
11309
|
"name": "append-footnotes",
|
|
11308
|
-
"description": "The server returns footnotes separately. Set this property\nif you wish to append them to the main text.",
|
|
11310
|
+
"description": "The server returns footnotes separately. Set this property\r\nif you wish to append them to the main text.",
|
|
11309
11311
|
"type": "boolean",
|
|
11310
11312
|
"default": "false"
|
|
11311
11313
|
},
|
|
11312
11314
|
{
|
|
11313
11315
|
"name": "not-found",
|
|
11314
|
-
"description": "Message to display if no content was returned by the server.\nSet to empty string to show nothing.",
|
|
11316
|
+
"description": "Message to display if no content was returned by the server.\r\nSet to empty string to show nothing.",
|
|
11315
11317
|
"type": "string",
|
|
11316
11318
|
"default": "\"the server did not return any content\""
|
|
11317
11319
|
},
|
|
11318
11320
|
{
|
|
11319
11321
|
"name": "animation",
|
|
11320
|
-
"description": "wether to animate the view when new page is loaded. Defaults to 'false' meaning that no\nanimation takes place. If 'true' will apply a translateX transistion in forward/backward direction.",
|
|
11322
|
+
"description": "wether to animate the view when new page is loaded. Defaults to 'false' meaning that no\r\nanimation takes place. If 'true' will apply a translateX transistion in forward/backward direction.",
|
|
11321
11323
|
"type": "boolean",
|
|
11322
11324
|
"default": "false"
|
|
11323
11325
|
},
|
|
@@ -11335,30 +11337,30 @@
|
|
|
11335
11337
|
},
|
|
11336
11338
|
{
|
|
11337
11339
|
"name": "infinite-scroll-max",
|
|
11338
|
-
"description": "Maximum number of fragments to keep in memory if `infinite-scroll`\nis enabled. If the user is scrolling beyond the maximum, fragements\nwill be removed from the DOM before or after the current reading position.\nDefault is 10. Set to zero to allow loading the entire document.",
|
|
11340
|
+
"description": "Maximum number of fragments to keep in memory if `infinite-scroll`\r\nis enabled. If the user is scrolling beyond the maximum, fragements\r\nwill be removed from the DOM before or after the current reading position.\r\nDefault is 10. Set to zero to allow loading the entire document.",
|
|
11339
11341
|
"type": "number",
|
|
11340
11342
|
"default": "10"
|
|
11341
11343
|
},
|
|
11342
11344
|
{
|
|
11343
11345
|
"name": "disable-history",
|
|
11344
|
-
"description": "By default, navigating to next/previous page will update browser parameters,\nso reloading the page will load the correct position within the document.\n\nSet this property to disable location tracking for the component altogether.",
|
|
11346
|
+
"description": "By default, navigating to next/previous page will update browser parameters,\r\nso reloading the page will load the correct position within the document.\r\n\r\nSet this property to disable location tracking for the component altogether.",
|
|
11345
11347
|
"type": "boolean",
|
|
11346
11348
|
"default": "false"
|
|
11347
11349
|
},
|
|
11348
11350
|
{
|
|
11349
11351
|
"name": "before-update-event",
|
|
11350
|
-
"description": "If set to the name of an event, the content of the pb-view will not be replaced\nimmediately upon updates. Instead, an event is emitted, which contains the new content\nin property `root`. An event handler intercepting the event can thus modify the content.\nOnce it is done, it should pass the modified content to the callback function provided\nin the event detail under the name `render`. See the demo for an example.",
|
|
11352
|
+
"description": "If set to the name of an event, the content of the pb-view will not be replaced\r\nimmediately upon updates. Instead, an event is emitted, which contains the new content\r\nin property `root`. An event handler intercepting the event can thus modify the content.\r\nOnce it is done, it should pass the modified content to the callback function provided\r\nin the event detail under the name `render`. See the demo for an example.",
|
|
11351
11353
|
"type": "string"
|
|
11352
11354
|
},
|
|
11353
11355
|
{
|
|
11354
11356
|
"name": "no-scroll",
|
|
11355
|
-
"description": "If set, do not scroll the view to target node (e.g. given in URL hash) \nafter content was loaded.",
|
|
11357
|
+
"description": "If set, do not scroll the view to target node (e.g. given in URL hash) \r\nafter content was loaded.",
|
|
11356
11358
|
"type": "boolean",
|
|
11357
11359
|
"default": "false"
|
|
11358
11360
|
},
|
|
11359
11361
|
{
|
|
11360
11362
|
"name": "static",
|
|
11361
|
-
"description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required. Use this in combination with\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).\nThe value should point to the HTTP root path under which the static version\nwill be hosted. This is used to resolve CSS stylesheets.",
|
|
11363
|
+
"description": "If set, rewrite URLs to load pages as static HTML files,\r\nso no TEI Publisher instance is required. Use this in combination with\r\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).\r\nThe value should point to the HTTP root path under which the static version\r\nwill be hosted. This is used to resolve CSS stylesheets.",
|
|
11362
11364
|
"type": "string"
|
|
11363
11365
|
},
|
|
11364
11366
|
{
|
|
@@ -11383,7 +11385,7 @@
|
|
|
11383
11385
|
},
|
|
11384
11386
|
{
|
|
11385
11387
|
"name": "wait-for",
|
|
11386
|
-
"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.\n\n`pb-view` by default sets this property to select `pb-toggle-feature` and `pb-select-feature` \nelements.",
|
|
11388
|
+
"description": "A selector pointing to other components this component depends on.\r\nWhen method `wait` is called, it will wait until all referenced\r\ncomponents signal with a `pb-ready` event that they are ready and listening\r\nto events.\r\n\r\n`pb-view` by default sets this property to select `pb-toggle-feature` and `pb-select-feature` \r\nelements.",
|
|
11387
11389
|
"type": "string"
|
|
11388
11390
|
},
|
|
11389
11391
|
{
|
|
@@ -11397,49 +11399,49 @@
|
|
|
11397
11399
|
{
|
|
11398
11400
|
"name": "odd",
|
|
11399
11401
|
"attribute": "odd",
|
|
11400
|
-
"description": "The ODD to use for rendering the document. Overwrites an ODD defined on\n`pb-document`. The odd should be specified by its name without path\nor the `.odd` suffix.",
|
|
11402
|
+
"description": "The ODD to use for rendering the document. Overwrites an ODD defined on\r\n`pb-document`. The odd should be specified by its name without path\r\nor the `.odd` suffix.",
|
|
11401
11403
|
"type": "string"
|
|
11402
11404
|
},
|
|
11403
11405
|
{
|
|
11404
11406
|
"name": "view",
|
|
11405
11407
|
"attribute": "view",
|
|
11406
|
-
"description": "The view type to use for paginating the document. Either `page`, `div` or `single`.\nOverwrites the same property specified on `pb-document`. Values have the following meaning:\n\nValue | Displayed content\n------|------------------\n`page` | content is displayed page by page as determined by tei:pb\n`div` | content is displayed by divisions\n`single` | do not paginate but display entire content at once",
|
|
11408
|
+
"description": "The view type to use for paginating the document. Either `page`, `div` or `single`.\r\nOverwrites the same property specified on `pb-document`. Values have the following meaning:\r\n\r\nValue | Displayed content\r\n------|------------------\r\n`page` | content is displayed page by page as determined by tei:pb\r\n`div` | content is displayed by divisions\r\n`single` | do not paginate but display entire content at once",
|
|
11407
11409
|
"type": "string"
|
|
11408
11410
|
},
|
|
11409
11411
|
{
|
|
11410
11412
|
"name": "nodeId",
|
|
11411
11413
|
"attribute": "node-id",
|
|
11412
|
-
"description": "An eXist nodeId. If specified, selects the root of the fragment of the document\nwhich should be displayed. Normally this property is set automatically by pagination.",
|
|
11414
|
+
"description": "An eXist nodeId. If specified, selects the root of the fragment of the document\r\nwhich should be displayed. Normally this property is set automatically by pagination.",
|
|
11413
11415
|
"type": "string"
|
|
11414
11416
|
},
|
|
11415
11417
|
{
|
|
11416
11418
|
"name": "xmlId",
|
|
11417
11419
|
"attribute": "xml-id",
|
|
11418
|
-
"description": "An xml:id to be displayed. If specified, this determines the root of the fragment to be\ndisplayed. Use to directly navigate to a specific section.",
|
|
11420
|
+
"description": "An xml:id to be displayed. If specified, this determines the root of the fragment to be\r\ndisplayed. Use to directly navigate to a specific section.",
|
|
11419
11421
|
"type": "array"
|
|
11420
11422
|
},
|
|
11421
11423
|
{
|
|
11422
11424
|
"name": "xpath",
|
|
11423
11425
|
"attribute": "xpath",
|
|
11424
|
-
"description": "An optional XPath expression: the root of the fragment to be processed is determined\nby evaluating the given XPath expression. The XPath expression should be absolute.\nThe namespace of the document is declared as default namespace, so no prefixes should\nbe used.\n\nIf the `map` property is used, it may change scope for the displayed fragment.",
|
|
11426
|
+
"description": "An optional XPath expression: the root of the fragment to be processed is determined\r\nby evaluating the given XPath expression. The XPath expression should be absolute.\r\nThe namespace of the document is declared as default namespace, so no prefixes should\r\nbe used.\r\n\r\nIf the `map` property is used, it may change scope for the displayed fragment.",
|
|
11425
11427
|
"type": "string"
|
|
11426
11428
|
},
|
|
11427
11429
|
{
|
|
11428
11430
|
"name": "map",
|
|
11429
11431
|
"attribute": "map",
|
|
11430
|
-
"description": "If defined denotes the local name of an XQuery function in `modules/map.xql`, which will be called\nwith the current root node and should return the node of a mapped fragment. This is helpful if one\nwants, for example, to show a translation fragment aligned with the part of the transcription currently\nshown. In this case, the properties of the `pb-view` would still point to the transcription, but the function\nidentified by map would return the corresponding fragment from the translation to be processed.\n\nNavigation in the document is still determined by the current root as defined through the `root`, `xpath`\nand `xmlId` properties.",
|
|
11432
|
+
"description": "If defined denotes the local name of an XQuery function in `modules/map.xql`, which will be called\r\nwith the current root node and should return the node of a mapped fragment. This is helpful if one\r\nwants, for example, to show a translation fragment aligned with the part of the transcription currently\r\nshown. In this case, the properties of the `pb-view` would still point to the transcription, but the function\r\nidentified by map would return the corresponding fragment from the translation to be processed.\r\n\r\nNavigation in the document is still determined by the current root as defined through the `root`, `xpath`\r\nand `xmlId` properties.",
|
|
11431
11433
|
"type": "string"
|
|
11432
11434
|
},
|
|
11433
11435
|
{
|
|
11434
11436
|
"name": "columnSeparator",
|
|
11435
11437
|
"attribute": "column-separator",
|
|
11436
|
-
"description": "CSS selector to find column breaks in the content returned\nfrom the server. If this property is set and column breaks\nare found, the component will display two columns side by side.",
|
|
11438
|
+
"description": "CSS selector to find column breaks in the content returned\r\nfrom the server. If this property is set and column breaks\r\nare found, the component will display two columns side by side.",
|
|
11437
11439
|
"type": "string"
|
|
11438
11440
|
},
|
|
11439
11441
|
{
|
|
11440
11442
|
"name": "loadCss",
|
|
11441
11443
|
"attribute": "load-css",
|
|
11442
|
-
"description": "If set, points to an external stylesheet which should be applied to\nthe text *after* the ODD-generated styles.",
|
|
11444
|
+
"description": "If set, points to an external stylesheet which should be applied to\r\nthe text *after* the ODD-generated styles.",
|
|
11443
11445
|
"type": "string"
|
|
11444
11446
|
},
|
|
11445
11447
|
{
|
|
@@ -11451,19 +11453,19 @@
|
|
|
11451
11453
|
{
|
|
11452
11454
|
"name": "useLanguage",
|
|
11453
11455
|
"attribute": "use-language",
|
|
11454
|
-
"description": "If set, a refresh will be triggered if a `pb-i18n-update` event is received,\ne.g. due to the user selecting a different interface language.\n\nAlso requires `requireLanguage` to be set on the surrounding `pb-page`.\nSee there for more information.",
|
|
11456
|
+
"description": "If set, a refresh will be triggered if a `pb-i18n-update` event is received,\r\ne.g. due to the user selecting a different interface language.\r\n\r\nAlso requires `requireLanguage` to be set on the surrounding `pb-page`.\r\nSee there for more information.",
|
|
11455
11457
|
"type": "boolean"
|
|
11456
11458
|
},
|
|
11457
11459
|
{
|
|
11458
11460
|
"name": "infiniteScroll",
|
|
11459
11461
|
"attribute": "infinite-scroll",
|
|
11460
|
-
"description": "Experimental: if enabled, the view will incrementally load new document fragments if the user tries to scroll\nbeyond the start or end of the visible text. The feature inserts a small blank section at the top\nand bottom. If this section becomes visible, a load operation will be triggered.\n\nNote: only browsers implementing the `IntersectionObserver` API are supported. Also the feature\ndoes not work in two-column mode or with animations.",
|
|
11462
|
+
"description": "Experimental: if enabled, the view will incrementally load new document fragments if the user tries to scroll\r\nbeyond the start or end of the visible text. The feature inserts a small blank section at the top\r\nand bottom. If this section becomes visible, a load operation will be triggered.\r\n\r\nNote: only browsers implementing the `IntersectionObserver` API are supported. Also the feature\r\ndoes not work in two-column mode or with animations.",
|
|
11461
11463
|
"type": "boolean"
|
|
11462
11464
|
},
|
|
11463
11465
|
{
|
|
11464
11466
|
"name": "src",
|
|
11465
11467
|
"attribute": "src",
|
|
11466
|
-
"description": "The id of a `pb-document` element this view should display.\nSettings like `odd` or `view` will be taken from the `pb-document`\nunless overwritten by properties in this component.\n\nThis property is **required** and **must** point to an existing `pb-document` with\nthe given id.\n\nSetting the property after initialization will clear the properties xmlId, nodeId and odd.",
|
|
11468
|
+
"description": "The id of a `pb-document` element this view should display.\r\nSettings like `odd` or `view` will be taken from the `pb-document`\r\nunless overwritten by properties in this component.\r\n\r\nThis property is **required** and **must** point to an existing `pb-document` with\r\nthe given id.\r\n\r\nSetting the property after initialization will clear the properties xmlId, nodeId and odd.",
|
|
11467
11469
|
"type": "string"
|
|
11468
11470
|
},
|
|
11469
11471
|
{
|
|
@@ -11475,28 +11477,28 @@
|
|
|
11475
11477
|
{
|
|
11476
11478
|
"name": "onUpdate",
|
|
11477
11479
|
"attribute": "on-update",
|
|
11478
|
-
"description": "If set to true, the component will not load automatically. Instead it will wait until it receives a `pb-update`\nevent. Use this to make one `pb-view` component dependent on another one. Default is 'false'.",
|
|
11480
|
+
"description": "If set to true, the component will not load automatically. Instead it will wait until it receives a `pb-update`\r\nevent. Use this to make one `pb-view` component dependent on another one. Default is 'false'.",
|
|
11479
11481
|
"type": "boolean",
|
|
11480
11482
|
"default": "false"
|
|
11481
11483
|
},
|
|
11482
11484
|
{
|
|
11483
11485
|
"name": "appendFootnotes",
|
|
11484
11486
|
"attribute": "append-footnotes",
|
|
11485
|
-
"description": "The server returns footnotes separately. Set this property\nif you wish to append them to the main text.",
|
|
11487
|
+
"description": "The server returns footnotes separately. Set this property\r\nif you wish to append them to the main text.",
|
|
11486
11488
|
"type": "boolean",
|
|
11487
11489
|
"default": "false"
|
|
11488
11490
|
},
|
|
11489
11491
|
{
|
|
11490
11492
|
"name": "notFound",
|
|
11491
11493
|
"attribute": "not-found",
|
|
11492
|
-
"description": "Message to display if no content was returned by the server.\nSet to empty string to show nothing.",
|
|
11494
|
+
"description": "Message to display if no content was returned by the server.\r\nSet to empty string to show nothing.",
|
|
11493
11495
|
"type": "string",
|
|
11494
11496
|
"default": "\"the server did not return any content\""
|
|
11495
11497
|
},
|
|
11496
11498
|
{
|
|
11497
11499
|
"name": "animation",
|
|
11498
11500
|
"attribute": "animation",
|
|
11499
|
-
"description": "wether to animate the view when new page is loaded. Defaults to 'false' meaning that no\nanimation takes place. If 'true' will apply a translateX transistion in forward/backward direction.",
|
|
11501
|
+
"description": "wether to animate the view when new page is loaded. Defaults to 'false' meaning that no\r\nanimation takes place. If 'true' will apply a translateX transistion in forward/backward direction.",
|
|
11500
11502
|
"type": "boolean",
|
|
11501
11503
|
"default": "false"
|
|
11502
11504
|
},
|
|
@@ -11522,34 +11524,34 @@
|
|
|
11522
11524
|
{
|
|
11523
11525
|
"name": "infiniteScrollMax",
|
|
11524
11526
|
"attribute": "infinite-scroll-max",
|
|
11525
|
-
"description": "Maximum number of fragments to keep in memory if `infinite-scroll`\nis enabled. If the user is scrolling beyond the maximum, fragements\nwill be removed from the DOM before or after the current reading position.\nDefault is 10. Set to zero to allow loading the entire document.",
|
|
11527
|
+
"description": "Maximum number of fragments to keep in memory if `infinite-scroll`\r\nis enabled. If the user is scrolling beyond the maximum, fragements\r\nwill be removed from the DOM before or after the current reading position.\r\nDefault is 10. Set to zero to allow loading the entire document.",
|
|
11526
11528
|
"type": "number",
|
|
11527
11529
|
"default": "10"
|
|
11528
11530
|
},
|
|
11529
11531
|
{
|
|
11530
11532
|
"name": "disableHistory",
|
|
11531
11533
|
"attribute": "disable-history",
|
|
11532
|
-
"description": "By default, navigating to next/previous page will update browser parameters,\nso reloading the page will load the correct position within the document.\n\nSet this property to disable location tracking for the component altogether.",
|
|
11534
|
+
"description": "By default, navigating to next/previous page will update browser parameters,\r\nso reloading the page will load the correct position within the document.\r\n\r\nSet this property to disable location tracking for the component altogether.",
|
|
11533
11535
|
"type": "boolean",
|
|
11534
11536
|
"default": "false"
|
|
11535
11537
|
},
|
|
11536
11538
|
{
|
|
11537
11539
|
"name": "beforeUpdate",
|
|
11538
11540
|
"attribute": "before-update-event",
|
|
11539
|
-
"description": "If set to the name of an event, the content of the pb-view will not be replaced\nimmediately upon updates. Instead, an event is emitted, which contains the new content\nin property `root`. An event handler intercepting the event can thus modify the content.\nOnce it is done, it should pass the modified content to the callback function provided\nin the event detail under the name `render`. See the demo for an example.",
|
|
11541
|
+
"description": "If set to the name of an event, the content of the pb-view will not be replaced\r\nimmediately upon updates. Instead, an event is emitted, which contains the new content\r\nin property `root`. An event handler intercepting the event can thus modify the content.\r\nOnce it is done, it should pass the modified content to the callback function provided\r\nin the event detail under the name `render`. See the demo for an example.",
|
|
11540
11542
|
"type": "string"
|
|
11541
11543
|
},
|
|
11542
11544
|
{
|
|
11543
11545
|
"name": "noScroll",
|
|
11544
11546
|
"attribute": "no-scroll",
|
|
11545
|
-
"description": "If set, do not scroll the view to target node (e.g. given in URL hash) \nafter content was loaded.",
|
|
11547
|
+
"description": "If set, do not scroll the view to target node (e.g. given in URL hash) \r\nafter content was loaded.",
|
|
11546
11548
|
"type": "boolean",
|
|
11547
11549
|
"default": "false"
|
|
11548
11550
|
},
|
|
11549
11551
|
{
|
|
11550
11552
|
"name": "static",
|
|
11551
11553
|
"attribute": "static",
|
|
11552
|
-
"description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required. Use this in combination with\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).\nThe value should point to the HTTP root path under which the static version\nwill be hosted. This is used to resolve CSS stylesheets.",
|
|
11554
|
+
"description": "If set, rewrite URLs to load pages as static HTML files,\r\nso no TEI Publisher instance is required. Use this in combination with\r\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).\r\nThe value should point to the HTTP root path under which the static version\r\nwill be hosted. This is used to resolve CSS stylesheets.",
|
|
11553
11555
|
"type": "string"
|
|
11554
11556
|
},
|
|
11555
11557
|
{
|
|
@@ -11579,7 +11581,7 @@
|
|
|
11579
11581
|
{
|
|
11580
11582
|
"name": "waitFor",
|
|
11581
11583
|
"attribute": "wait-for",
|
|
11582
|
-
"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.\n\n`pb-view` by default sets this property to select `pb-toggle-feature` and `pb-select-feature` \nelements.",
|
|
11584
|
+
"description": "A selector pointing to other components this component depends on.\r\nWhen method `wait` is called, it will wait until all referenced\r\ncomponents signal with a `pb-ready` event that they are ready and listening\r\nto events.\r\n\r\n`pb-view` by default sets this property to select `pb-toggle-feature` and `pb-select-feature` \r\nelements.",
|
|
11583
11585
|
"type": "string"
|
|
11584
11586
|
},
|
|
11585
11587
|
{
|