@teipublisher/pb-components 2.26.1-next.3 → 3.0.0-next-4.1
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/.github/workflows/docker-cypress.yml +54 -0
- package/.github/workflows/main.yml +6 -4
- package/.github/workflows/node.js.yml +56 -21
- package/.github/workflows/release.js.yml +19 -17
- package/.releaserc.json +1 -1
- package/CHANGELOG.md +346 -11
- package/Dockerfile +78 -70
- package/README.md +112 -4
- package/css/components.css +5 -5
- package/css/gridjs/mermaid.min.css +1 -1
- package/css/leaflet/Control.Geocoder.css +1 -126
- package/css/leaflet/images/layers.png +0 -0
- package/css/tify/tify.css +6 -5
- package/css/tom-select/tom-select.bootstrap4.min.css +1 -1
- package/css/tom-select/tom-select.bootstrap5.min.css +1 -1
- package/css/tom-select/tom-select.default.min.css +1 -1
- package/css/tom-select/tom-select.default.min.css.map +1 -0
- package/css/tom-select/tom-select.min.css +1 -1
- package/cypress.config.js +84 -0
- package/dist/api.html +1 -1
- package/dist/css/design-system.css +607 -0
- package/dist/demo/bundle-test.html +4 -3
- package/dist/demo/components.css +46 -1
- package/dist/demo/design-system.html +710 -0
- package/dist/demo/dts-client.html +2 -2
- package/dist/demo/pb-autocomplete.html +23 -11
- package/dist/demo/pb-autocomplete2.html +66 -55
- package/dist/demo/pb-autocomplete3.html +17 -8
- package/dist/demo/pb-blacklab-highlight.html +28 -11
- package/dist/demo/pb-blacklab-results.html +3 -2
- package/dist/demo/pb-browse-docs.html +24 -24
- package/dist/demo/pb-browse-docs2.html +3 -3
- package/dist/demo/pb-clipboard.html +32 -28
- package/dist/demo/pb-code-editor.html +6 -6
- package/dist/demo/pb-code-highlight.html +63 -63
- package/dist/demo/pb-codepen.html +1 -1
- package/dist/demo/pb-collapse.html +1 -1
- package/dist/demo/pb-collapse2.html +2 -2
- package/dist/demo/pb-combo-box.html +135 -130
- package/dist/demo/pb-custom-form.html +64 -55
- package/dist/demo/pb-dialog.html +12 -6
- package/dist/demo/pb-document.html +1 -1
- package/dist/demo/pb-download.html +68 -59
- package/dist/demo/pb-drawer.html +67 -46
- package/dist/demo/pb-drawer2.html +65 -58
- package/dist/demo/pb-edit-app.html +2 -2
- package/dist/demo/pb-edit-xml.html +1 -1
- package/dist/demo/pb-facsimile-2.html +26 -11
- package/dist/demo/pb-facsimile-3.html +25 -10
- package/dist/demo/pb-facsimile-dedup-test-2.html +48 -0
- package/dist/demo/pb-facsimile-dedup-test.html +48 -0
- package/dist/demo/pb-facsimile.html +4 -4
- package/dist/demo/pb-formula.html +1 -1
- package/dist/demo/pb-grid.html +22 -8
- package/dist/demo/pb-highlight.html +2 -2
- package/dist/demo/pb-i18n-simple.html +1 -0
- package/dist/demo/pb-i18n.html +15 -5
- package/dist/demo/pb-image-strip-standalone.html +2 -2
- package/dist/demo/pb-image-strip-view.html +2 -2
- package/dist/demo/pb-leaflet-map.html +3 -3
- package/dist/demo/pb-leaflet-map2.html +2 -2
- package/dist/demo/pb-leaflet-map3.html +3 -3
- package/dist/demo/pb-link.html +1 -1
- package/dist/demo/pb-load.html +2 -6
- package/dist/demo/pb-login.html +1 -3
- package/dist/demo/pb-manage-odds.html +9 -4
- package/dist/demo/pb-markdown.html +1 -1
- package/dist/demo/pb-media-query.html +2 -2
- package/dist/demo/pb-mei.html +2 -2
- package/dist/demo/pb-mei2.html +2 -2
- package/dist/demo/pb-message.html +2 -3
- package/dist/demo/pb-odd-editor.html +54 -52
- package/dist/demo/pb-page-header.html +27 -0
- package/dist/demo/pb-popover.html +1 -1
- package/dist/demo/pb-print-preview.html +2 -2
- package/dist/demo/pb-progress.html +4 -4
- package/dist/demo/pb-repeat.html +32 -36
- package/dist/demo/pb-search.html +16 -5
- package/dist/demo/pb-search2.html +4 -4
- package/dist/demo/pb-search3.html +3 -3
- package/dist/demo/pb-search4.html +3 -3
- package/dist/demo/pb-select-feature.html +4 -4
- package/dist/demo/pb-select-feature2.html +4 -4
- package/dist/demo/pb-select-feature3.html +2 -2
- package/dist/demo/pb-select-i18n.html +58 -53
- package/dist/demo/pb-select-odd.html +1 -1
- package/dist/demo/pb-select.html +190 -75
- package/dist/demo/pb-select2.html +91 -37
- package/dist/demo/pb-select3.html +109 -41
- package/dist/demo/pb-svg.html +1 -1
- package/dist/demo/pb-table-grid.html +26 -15
- package/dist/demo/pb-tabs.html +15 -7
- package/dist/demo/pb-tify.html +7 -7
- package/dist/demo/pb-timeline.html +1 -1
- package/dist/demo/pb-timeline2.html +1 -1
- package/dist/demo/pb-toggle-feature.html +26 -23
- package/dist/demo/pb-toggle-feature2.html +4 -4
- package/dist/demo/pb-toggle-feature3.html +2 -2
- package/dist/demo/pb-toggle-feature4.html +56 -54
- package/dist/demo/pb-version.html +2 -2
- package/dist/demo/pb-view.html +78 -40
- package/dist/demo/pb-view2.html +69 -46
- package/dist/demo/pb-view3.html +53 -48
- package/dist/demo/pb-view4.html +70 -49
- package/dist/demo/pb-zoom.html +2 -2
- package/dist/{es-global-bridge-d8ce175d.js → es-global-bridge-D8ZcUcx_.js} +0 -4
- package/dist/focus-mixin-VCsFap6b.js +768 -0
- package/dist/images/icons.svg +217 -0
- package/dist/jinn-codemirror-DETLdm08.js +1 -0
- package/dist/lib/openseadragon.min.js +80 -0
- package/dist/lib/openseadragon.min.js.map +1 -0
- package/dist/pb-code-editor.js +25 -20
- package/dist/pb-component-docs.js +414 -3225
- package/dist/pb-components-bundle.js +3046 -4402
- package/dist/pb-dialog-tklYGWfc.js +121 -0
- package/dist/pb-edit-app.js +208 -107
- package/dist/pb-elements.json +716 -249
- package/dist/pb-facsimile.js +46 -0
- package/dist/pb-i18n-C0NDma4h.js +1 -0
- package/dist/pb-leaflet-map.js +23 -23
- package/dist/pb-mei.js +152 -134
- package/dist/pb-mixin-DHoWQheB.js +1 -0
- package/dist/pb-odd-editor.js +1671 -1231
- package/dist/pb-tify.js +1 -27
- package/dist/unsafe-html-D5VGo9Oq.js +1 -0
- package/dist/urls-BEONu_g4.js +1 -0
- package/eslint.config.mjs +92 -0
- package/gh-pages.js +5 -3
- package/i18n/common/en.json +6 -0
- package/i18n/common/pl.json +2 -2
- package/images/icons.svg +217 -0
- package/index.html +0 -5
- package/lib/leaflet-src.js.map +1 -0
- package/lib/leaflet.markercluster-src.js.map +1 -0
- package/lib/openseadragon.min.js +6 -6
- package/package.json +56 -81
- package/pb-elements.json +716 -249
- package/rollup.config.mjs +312 -0
- package/src/assets/components.css +5 -5
- package/src/assets/design-system.css +607 -0
- package/src/authority/airtable.js +20 -21
- package/src/authority/anton.js +129 -129
- package/src/authority/custom.js +70 -27
- package/src/authority/geonames.js +38 -32
- package/src/authority/gnd.js +50 -42
- package/src/authority/kbga.js +136 -134
- package/src/authority/metagrid.js +44 -46
- package/src/authority/reconciliation.js +66 -68
- package/src/authority/registry.js +4 -4
- package/src/docs/demo-utils.js +91 -0
- package/src/docs/pb-component-docs.js +287 -147
- package/src/docs/pb-component-view.js +380 -273
- package/src/docs/pb-components-list.js +115 -51
- package/src/docs/pb-demo-snippet.js +199 -174
- package/src/dts-client.js +306 -303
- package/src/dts-select-endpoint.js +125 -85
- package/src/parse-date-service.js +184 -135
- package/src/pb-ajax.js +175 -173
- package/src/pb-authority-lookup.js +198 -158
- package/src/pb-autocomplete.js +731 -313
- package/src/pb-blacklab-highlight.js +266 -260
- package/src/pb-blacklab-results.js +230 -225
- package/src/pb-browse-docs.js +601 -484
- package/src/pb-browse.js +68 -65
- package/src/pb-clipboard.js +97 -76
- package/src/pb-code-editor.js +111 -103
- package/src/pb-code-highlight.js +234 -204
- package/src/pb-codepen.js +81 -73
- package/src/pb-collapse.js +265 -152
- package/src/pb-combo-box.js +191 -191
- package/src/pb-components-bundle.js +1 -7
- package/src/pb-components.js +2 -6
- package/src/pb-custom-form.js +230 -141
- package/src/pb-dialog.js +99 -63
- package/src/pb-document.js +118 -91
- package/src/pb-download.js +214 -198
- package/src/pb-drawer.js +146 -149
- package/src/pb-edit-app.js +471 -240
- package/src/pb-edit-xml.js +101 -98
- package/src/pb-events.js +126 -107
- package/src/pb-facs-link.js +130 -101
- package/src/pb-facsimile.js +494 -410
- package/src/pb-fetch.js +389 -0
- package/src/pb-formula.js +152 -154
- package/src/pb-geolocation.js +130 -132
- package/src/pb-grid-action.js +59 -56
- package/src/pb-grid.js +388 -228
- package/src/pb-highlight.js +142 -142
- package/src/pb-hotkeys.js +40 -42
- package/src/pb-i18n.js +115 -127
- package/src/pb-icon-button.js +108 -0
- package/src/pb-icon.js +283 -0
- package/src/pb-image-strip.js +85 -79
- package/src/pb-lang.js +142 -57
- package/src/pb-leaflet-map.js +551 -483
- package/src/pb-link.js +132 -126
- package/src/pb-load.js +495 -428
- package/src/pb-login.js +303 -248
- package/src/pb-manage-odds.js +384 -338
- package/src/pb-map-icon.js +90 -90
- package/src/pb-map-layer.js +86 -86
- package/src/pb-markdown.js +107 -110
- package/src/pb-media-query.js +75 -73
- package/src/pb-mei.js +523 -303
- package/src/pb-message.js +144 -98
- package/src/pb-mixin.js +268 -265
- package/src/pb-navigation.js +83 -96
- package/src/pb-observable.js +39 -39
- package/src/pb-odd-editor.js +1209 -948
- package/src/pb-odd-elementspec-editor.js +375 -310
- package/src/pb-odd-model-editor.js +1189 -941
- package/src/pb-odd-parameter-editor.js +269 -170
- package/src/pb-odd-rendition-editor.js +184 -131
- package/src/pb-page.js +451 -422
- package/src/pb-paginate.js +260 -178
- package/src/pb-panel.js +217 -183
- package/src/pb-popover-themes.js +16 -9
- package/src/pb-popover.js +297 -288
- package/src/pb-print-preview.js +128 -128
- package/src/pb-progress.js +52 -52
- package/src/pb-repeat.js +141 -108
- package/src/pb-restricted.js +85 -78
- package/src/pb-search.js +258 -230
- package/src/pb-select-feature.js +210 -126
- package/src/pb-select-odd.js +184 -118
- package/src/pb-select-template.js +113 -78
- package/src/pb-select.js +330 -229
- package/src/pb-split-list.js +181 -176
- package/src/pb-svg.js +81 -80
- package/src/pb-table-column.js +55 -55
- package/src/pb-table-grid.js +334 -205
- package/src/pb-tabs.js +238 -61
- package/src/pb-tify.js +3331 -126
- package/src/pb-timeline.js +394 -255
- package/src/pb-toggle-feature.js +196 -188
- package/src/pb-upload.js +201 -176
- package/src/pb-version.js +22 -34
- package/src/pb-view-annotate.js +138 -102
- package/src/pb-view.js +1722 -1272
- package/src/pb-zoom.js +144 -46
- package/src/search-result-service.js +256 -223
- package/src/seed-element.js +14 -22
- package/src/settings.js +4 -4
- package/src/theming.js +98 -91
- package/src/urls.js +403 -289
- package/src/utils.js +53 -51
- package/vite.config.js +86 -0
- package/css/pb-styles.css +0 -51
- package/dist/iron-form-3b8dcaa7.js +0 -210
- package/dist/jinn-codemirror-da0e2d1f.js +0 -1
- package/dist/paper-checkbox-515a5284.js +0 -1597
- package/dist/paper-icon-button-b1d31571.js +0 -398
- package/dist/paper-listbox-a3b7175c.js +0 -1265
- package/dist/pb-i18n-0611135a.js +0 -1
- package/dist/pb-mixin-b1caa22e.js +0 -158
- package/dist/polymer-hack.js +0 -1
- package/dist/vaadin-element-mixin-fe4a4883.js +0 -527
- package/lib/Control.Geocoder.min.js +0 -2
- package/lib/Control.Geocoder.min.js.map +0 -1
- package/src/assets/pb-styles.css +0 -51
- package/src/pb-light-dom.js +0 -41
- package/src/polymer-hack.js +0 -6
package/dist/pb-elements.json
CHANGED
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
},
|
|
33
33
|
{
|
|
34
34
|
"name": "view",
|
|
35
|
-
"type": "PbComponentView"
|
|
35
|
+
"type": "PbComponentView|null"
|
|
36
36
|
}
|
|
37
37
|
],
|
|
38
38
|
"slots": [
|
|
@@ -111,28 +111,24 @@
|
|
|
111
111
|
"name": "pb-demo-snippet",
|
|
112
112
|
"path": "./src/docs/pb-demo-snippet.js",
|
|
113
113
|
"description": "Viewer for demo code.",
|
|
114
|
-
"
|
|
114
|
+
"properties": [
|
|
115
115
|
{
|
|
116
|
-
"name": "
|
|
117
|
-
"type": "
|
|
118
|
-
"default": "\"
|
|
116
|
+
"name": "properties",
|
|
117
|
+
"type": "{ title: { type: StringConstructor; }; code: { type: StringConstructor; }; _showCodeLabel: { type: StringConstructor; }; _requirePbTify: { ...; }; }",
|
|
118
|
+
"default": "{\"title\":{\"type\":\"String\"},\"code\":{\"type\":\"String\"},\"_showCodeLabel\":{\"type\":\"String\"},\"_requirePbTify\":{\"type\":\"Boolean\"}}"
|
|
119
119
|
},
|
|
120
120
|
{
|
|
121
|
-
"name": "
|
|
122
|
-
"type": "
|
|
123
|
-
"default": "\"
|
|
124
|
-
}
|
|
125
|
-
],
|
|
126
|
-
"properties": [
|
|
121
|
+
"name": "styles",
|
|
122
|
+
"type": "CSSResult",
|
|
123
|
+
"default": "\"css`\\n :host {\\n display: block;\\n box-shadow: 0 2px 2px rgba(0, 0, 0, 0.14), 0 1px 5px rgba(0, 0, 0, 0.12),\\n 0 3px 1px -2px rgba(0, 0, 0, 0.2);\\n padding: 20px;\\n background: #fff;\\n }\\n\\n pb-code-highlight {\\n display: none;\\n margin-top: 30px;\\n }\\n\\n pb-code-highlight.open {\\n display: block;\\n }\\n\\n .buttons {\\n display: flex;\\n justify-content: space-between;\\n margin-top: 20px;\\n padding-top: 10px;\\n border-top: 1px solid var(--google-grey-400, #999);\\n }\\n\\n .pretty-button {\\n cursor: pointer;\\n display: inline-block;\\n box-sizing: border-box;\\n margin: 12px 0;\\n padding: 13px 44px;\\n border: 2px solid #2196f3;\\n background-color: transparent;\\n font-size: 14px;\\n font-weight: 500;\\n color: #2196f3;\\n text-align: center;\\n text-decoration: none;\\n text-transform: uppercase;\\n border-radius: 0;\\n appearance: none;\\n }\\n\\n .pretty-button:hover,\\n .pretty-button:active {\\n background-color: #2196f3;\\n color: #fff;\\n }\\n\\n .pretty-button:disabled {\\n background-color: transparent;\\n border-color: #999;\\n color: #999;\\n }\\n `\""
|
|
124
|
+
},
|
|
127
125
|
{
|
|
128
126
|
"name": "title",
|
|
129
|
-
"attribute": "title",
|
|
130
127
|
"type": "string",
|
|
131
128
|
"default": "\"TEI Publisher Webcomponents Example\""
|
|
132
129
|
},
|
|
133
130
|
{
|
|
134
131
|
"name": "code",
|
|
135
|
-
"attribute": "code",
|
|
136
132
|
"type": "string",
|
|
137
133
|
"default": "\"Loading ...\""
|
|
138
134
|
}
|
|
@@ -796,59 +792,68 @@
|
|
|
796
792
|
},
|
|
797
793
|
{
|
|
798
794
|
"name": "pb-authority-lookup",
|
|
799
|
-
"description": "When received, starts a lookup using the passed in query string and
|
|
795
|
+
"description": "When received, starts a lookup using the passed in query string and\nauthority type"
|
|
800
796
|
}
|
|
801
797
|
]
|
|
802
798
|
},
|
|
803
799
|
{
|
|
804
800
|
"name": "pb-autocomplete",
|
|
805
801
|
"path": "./src/pb-autocomplete.js",
|
|
806
|
-
"description": "Provides an input with attached autocomplete. The autocomplete suggestions can be read\neither from a static list or a remote endpoint to which the current user input is sent.",
|
|
807
802
|
"attributes": [
|
|
808
|
-
{
|
|
809
|
-
"name": "name",
|
|
810
|
-
"description": "Name of the form field which will be submitted",
|
|
811
|
-
"type": "string"
|
|
812
|
-
},
|
|
813
|
-
{
|
|
814
|
-
"name": "value",
|
|
815
|
-
"description": "Value of the form field which will be submitted",
|
|
816
|
-
"type": "string"
|
|
817
|
-
},
|
|
818
803
|
{
|
|
819
804
|
"name": "source",
|
|
820
|
-
"description": "Optional URL to query for suggestions. If relative, it is interpreted\nrelative to the endpoint defined on a surrounding `pb-page`.\n\nUpon autocomplete, the current input by the user will be sent with a query parameter\n`query`. The name/values of form controls nested within `pb-autocomplete` will also be\nappended to the request as parameters. This allows the server side code to distinguish\ndifferent states.",
|
|
821
|
-
"type": "string"
|
|
822
|
-
},
|
|
823
|
-
{
|
|
824
|
-
"name": "icon",
|
|
825
|
-
"description": "An icon to display next to the input.",
|
|
826
805
|
"type": "string"
|
|
827
806
|
},
|
|
828
807
|
{
|
|
829
808
|
"name": "placeholder",
|
|
830
|
-
"description": "Placeholder to display if field is empty",
|
|
831
809
|
"type": "string",
|
|
832
810
|
"default": "\"search.placeholder\""
|
|
833
811
|
},
|
|
812
|
+
{
|
|
813
|
+
"name": "label",
|
|
814
|
+
"type": "string",
|
|
815
|
+
"default": "\"\""
|
|
816
|
+
},
|
|
834
817
|
{
|
|
835
818
|
"name": "suggestions",
|
|
836
|
-
"description": "A static list of suggestions. Use instead of `source`. May either be a flat array of strings,\nor an array containing objects of the form `{\"text\": \"\", \"value\": \"\"}, in which case \"value\" denotes\nthe value to be used when the enclosing form is submitted, and \"text\" is the label to be displayed.",
|
|
837
819
|
"type": "array",
|
|
838
820
|
"default": "[]"
|
|
839
821
|
},
|
|
822
|
+
{
|
|
823
|
+
"name": "substring",
|
|
824
|
+
"type": "boolean",
|
|
825
|
+
"default": "false"
|
|
826
|
+
},
|
|
840
827
|
{
|
|
841
828
|
"name": "preload",
|
|
842
|
-
"description": "If set, the entire list of possible suggestions will be preloaded upon initialization of the\ncomponent.",
|
|
843
829
|
"type": "boolean",
|
|
844
830
|
"default": "false"
|
|
845
831
|
},
|
|
846
832
|
{
|
|
847
|
-
"name": "
|
|
848
|
-
"
|
|
833
|
+
"name": "icon",
|
|
834
|
+
"type": "string",
|
|
835
|
+
"default": "\"\""
|
|
836
|
+
},
|
|
837
|
+
{
|
|
838
|
+
"name": "helper-text",
|
|
839
|
+
"type": "string",
|
|
840
|
+
"default": "\"\""
|
|
841
|
+
},
|
|
842
|
+
{
|
|
843
|
+
"name": "always-float-label",
|
|
849
844
|
"type": "boolean",
|
|
850
845
|
"default": "false"
|
|
851
846
|
},
|
|
847
|
+
{
|
|
848
|
+
"name": "value",
|
|
849
|
+
"type": "string",
|
|
850
|
+
"default": "\"\""
|
|
851
|
+
},
|
|
852
|
+
{
|
|
853
|
+
"name": "name",
|
|
854
|
+
"type": "string",
|
|
855
|
+
"default": "\"\""
|
|
856
|
+
},
|
|
852
857
|
{
|
|
853
858
|
"name": "subscribe",
|
|
854
859
|
"description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
|
|
@@ -882,61 +887,79 @@
|
|
|
882
887
|
}
|
|
883
888
|
],
|
|
884
889
|
"properties": [
|
|
885
|
-
{
|
|
886
|
-
"name": "name",
|
|
887
|
-
"attribute": "name",
|
|
888
|
-
"description": "Name of the form field which will be submitted",
|
|
889
|
-
"type": "string"
|
|
890
|
-
},
|
|
891
|
-
{
|
|
892
|
-
"name": "value",
|
|
893
|
-
"attribute": "value",
|
|
894
|
-
"description": "Value of the form field which will be submitted",
|
|
895
|
-
"type": "string"
|
|
896
|
-
},
|
|
897
890
|
{
|
|
898
891
|
"name": "source",
|
|
899
892
|
"attribute": "source",
|
|
900
|
-
"description": "Optional URL to query for suggestions. If relative, it is interpreted\nrelative to the endpoint defined on a surrounding `pb-page`.\n\nUpon autocomplete, the current input by the user will be sent with a query parameter\n`query`. The name/values of form controls nested within `pb-autocomplete` will also be\nappended to the request as parameters. This allows the server side code to distinguish\ndifferent states.",
|
|
901
|
-
"type": "string"
|
|
902
|
-
},
|
|
903
|
-
{
|
|
904
|
-
"name": "icon",
|
|
905
|
-
"attribute": "icon",
|
|
906
|
-
"description": "An icon to display next to the input.",
|
|
907
893
|
"type": "string"
|
|
908
894
|
},
|
|
909
895
|
{
|
|
910
896
|
"name": "placeholder",
|
|
911
897
|
"attribute": "placeholder",
|
|
912
|
-
"description": "Placeholder to display if field is empty",
|
|
913
898
|
"type": "string",
|
|
914
899
|
"default": "\"search.placeholder\""
|
|
915
900
|
},
|
|
901
|
+
{
|
|
902
|
+
"name": "label",
|
|
903
|
+
"attribute": "label",
|
|
904
|
+
"type": "string",
|
|
905
|
+
"default": "\"\""
|
|
906
|
+
},
|
|
916
907
|
{
|
|
917
908
|
"name": "suggestions",
|
|
918
909
|
"attribute": "suggestions",
|
|
919
|
-
"description": "A static list of suggestions. Use instead of `source`. May either be a flat array of strings,\nor an array containing objects of the form `{\"text\": \"\", \"value\": \"\"}, in which case \"value\" denotes\nthe value to be used when the enclosing form is submitted, and \"text\" is the label to be displayed.",
|
|
920
910
|
"type": "array",
|
|
921
911
|
"default": "[]"
|
|
922
912
|
},
|
|
923
913
|
{
|
|
924
|
-
"name": "
|
|
914
|
+
"name": "substring",
|
|
915
|
+
"attribute": "substring",
|
|
916
|
+
"type": "boolean",
|
|
917
|
+
"default": "false"
|
|
925
918
|
},
|
|
926
919
|
{
|
|
927
920
|
"name": "preload",
|
|
928
921
|
"attribute": "preload",
|
|
929
|
-
"description": "If set, the entire list of possible suggestions will be preloaded upon initialization of the\ncomponent.",
|
|
930
922
|
"type": "boolean",
|
|
931
923
|
"default": "false"
|
|
932
924
|
},
|
|
933
925
|
{
|
|
934
|
-
"name": "
|
|
935
|
-
"attribute": "
|
|
936
|
-
"
|
|
926
|
+
"name": "icon",
|
|
927
|
+
"attribute": "icon",
|
|
928
|
+
"type": "string",
|
|
929
|
+
"default": "\"\""
|
|
930
|
+
},
|
|
931
|
+
{
|
|
932
|
+
"name": "helperText",
|
|
933
|
+
"attribute": "helper-text",
|
|
934
|
+
"type": "string",
|
|
935
|
+
"default": "\"\""
|
|
936
|
+
},
|
|
937
|
+
{
|
|
938
|
+
"name": "alwaysFloatLabel",
|
|
939
|
+
"attribute": "always-float-label",
|
|
937
940
|
"type": "boolean",
|
|
938
941
|
"default": "false"
|
|
939
942
|
},
|
|
943
|
+
{
|
|
944
|
+
"name": "lastSelected"
|
|
945
|
+
},
|
|
946
|
+
{
|
|
947
|
+
"name": "value",
|
|
948
|
+
"attribute": "value",
|
|
949
|
+
"type": "string",
|
|
950
|
+
"default": "\"\""
|
|
951
|
+
},
|
|
952
|
+
{
|
|
953
|
+
"name": "name",
|
|
954
|
+
"attribute": "name",
|
|
955
|
+
"type": "string",
|
|
956
|
+
"default": "\"\""
|
|
957
|
+
},
|
|
958
|
+
{
|
|
959
|
+
"name": "requestParams",
|
|
960
|
+
"type": "object",
|
|
961
|
+
"default": "{}"
|
|
962
|
+
},
|
|
940
963
|
{
|
|
941
964
|
"name": "subscribe",
|
|
942
965
|
"attribute": "subscribe",
|
|
@@ -974,40 +997,12 @@
|
|
|
974
997
|
"type": "boolean",
|
|
975
998
|
"default": "false"
|
|
976
999
|
}
|
|
977
|
-
],
|
|
978
|
-
"slots": [
|
|
979
|
-
{
|
|
980
|
-
"name": "",
|
|
981
|
-
"description": "default unnamed slot"
|
|
982
|
-
}
|
|
983
|
-
],
|
|
984
|
-
"cssProperties": [
|
|
985
|
-
{
|
|
986
|
-
"name": "--pb-search-label-color",
|
|
987
|
-
"description": "Color of the label and underline"
|
|
988
|
-
},
|
|
989
|
-
{
|
|
990
|
-
"name": "--pb-search-input-color",
|
|
991
|
-
"description": "Text color for input field"
|
|
992
|
-
},
|
|
993
|
-
{
|
|
994
|
-
"name": "--pb-search-focus-color",
|
|
995
|
-
"description": "Color for label and underline if input has focus"
|
|
996
|
-
},
|
|
997
|
-
{
|
|
998
|
-
"name": "--pb-search-suggestions-color",
|
|
999
|
-
"description": "Color for the labels shown in the suggestions dropdown"
|
|
1000
|
-
},
|
|
1001
|
-
{
|
|
1002
|
-
"name": "--pb-search-suggestions-background",
|
|
1003
|
-
"description": "Background for the suggestions dropdown"
|
|
1004
|
-
}
|
|
1005
1000
|
]
|
|
1006
1001
|
},
|
|
1007
1002
|
{
|
|
1008
1003
|
"name": "pb-blacklab-highlight",
|
|
1009
1004
|
"path": "./src/pb-blacklab-highlight.js",
|
|
1010
|
-
"description": "This component queries the blacklab API of TEI-Publisher for a list of text matches\nin a given document. The query is given as a CQL querystring (see pattern property).\n\n**Note**: There's no demo for this component yet as it would need a blacklab instance
|
|
1005
|
+
"description": "This component queries the blacklab API of TEI-Publisher for a list of text matches\nin a given document. The query is given as a CQL querystring (see pattern property).\n\n**Note**: There's no demo for this component yet as it would need a blacklab instance.\n\nThe component displays 2 navigation buttons to jump to previous / next match and\na display of the current index and total number of matches.\n\nWhen navigating and the requested match is not on the current page a pb-refresh is dispatched\nto load the correct page. Once the page has dispatch pb-update this component will refresh and trigger\nloading of matches from the API.\n\nHighlighting is accomplished by marking the matched text with the following CSS classes:\n- kwic-start - for the start of the match\n- kwic-end - for the end of the match (might be on the same node as 'kwic-start'\n- kwic-current - to set a different highlight color for the current match\n\nWhen navigating the browser URL will be updated to allow bookmarks for a certain match.\n\nNote: this component does no caching of query results yet. In case of heavier use the data can be taken\nfrom localStorage ('pb-kwic-results') as usually pb-kwic-results has been visited by the user before. For\nstability reasons this was not done in this version.\n\n\nWhen data are present highlights are processed.",
|
|
1011
1006
|
"attributes": [
|
|
1012
1007
|
{
|
|
1013
1008
|
"name": "current",
|
|
@@ -1475,7 +1470,7 @@
|
|
|
1475
1470
|
},
|
|
1476
1471
|
{
|
|
1477
1472
|
"name": "use-language",
|
|
1478
|
-
"description": "If set, a parameter \"language\" will be added to the parameter list
|
|
1473
|
+
"description": "If set, a parameter \"language\" will be added to the parameter list.\nAlso, 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.",
|
|
1479
1474
|
"type": "boolean"
|
|
1480
1475
|
},
|
|
1481
1476
|
{
|
|
@@ -1678,7 +1673,7 @@
|
|
|
1678
1673
|
{
|
|
1679
1674
|
"name": "useLanguage",
|
|
1680
1675
|
"attribute": "use-language",
|
|
1681
|
-
"description": "If set, a parameter \"language\" will be added to the parameter list
|
|
1676
|
+
"description": "If set, a parameter \"language\" will be added to the parameter list.\nAlso, 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.",
|
|
1682
1677
|
"type": "boolean"
|
|
1683
1678
|
},
|
|
1684
1679
|
{
|
|
@@ -1873,7 +1868,7 @@
|
|
|
1873
1868
|
{
|
|
1874
1869
|
"name": "pb-browse",
|
|
1875
1870
|
"path": "./src/pb-browse.js",
|
|
1876
|
-
"description": "Extends PbLoad to support browsing collections.\n\nThis is a reduced version of `pb-browse-docs`, which differs\nfrom a plain `pb-load` only in that it scans the returned\ncollection listing for links to subcollections and keeps\ntrack of the current collection
|
|
1871
|
+
"description": "Extends PbLoad to support browsing collections.\n\nThis is a reduced version of `pb-browse-docs`, which differs\nfrom a plain `pb-load` only in that it scans the returned\ncollection listing for links to subcollections and keeps\ntrack of the current collection.\n\nAll UI elements present in `pb-browse-docs` have been removed.",
|
|
1877
1872
|
"attributes": [
|
|
1878
1873
|
{
|
|
1879
1874
|
"name": "collection",
|
|
@@ -1918,7 +1913,7 @@
|
|
|
1918
1913
|
},
|
|
1919
1914
|
{
|
|
1920
1915
|
"name": "use-language",
|
|
1921
|
-
"description": "If set, a parameter \"language\" will be added to the parameter list
|
|
1916
|
+
"description": "If set, a parameter \"language\" will be added to the parameter list.\nAlso, 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.",
|
|
1922
1917
|
"type": "boolean"
|
|
1923
1918
|
},
|
|
1924
1919
|
{
|
|
@@ -2052,7 +2047,7 @@
|
|
|
2052
2047
|
{
|
|
2053
2048
|
"name": "useLanguage",
|
|
2054
2049
|
"attribute": "use-language",
|
|
2055
|
-
"description": "If set, a parameter \"language\" will be added to the parameter list
|
|
2050
|
+
"description": "If set, a parameter \"language\" will be added to the parameter list.\nAlso, 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.",
|
|
2056
2051
|
"type": "boolean"
|
|
2057
2052
|
},
|
|
2058
2053
|
{
|
|
@@ -2183,7 +2178,7 @@
|
|
|
2183
2178
|
{
|
|
2184
2179
|
"name": "pb-clipboard",
|
|
2185
2180
|
"path": "./src/pb-clipboard.js",
|
|
2186
|
-
"description": "A component with a button which copies the contained content to the clipboard.\
|
|
2181
|
+
"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.",
|
|
2187
2182
|
"attributes": [
|
|
2188
2183
|
{
|
|
2189
2184
|
"name": "label",
|
|
@@ -2432,16 +2427,16 @@
|
|
|
2432
2427
|
}
|
|
2433
2428
|
],
|
|
2434
2429
|
"deprecated": true,
|
|
2435
|
-
"deprecatedMessage": "directly use `jinn-codemirror`/`jinn-xml-editor`/`jinn-epidoc-editor` instead, which are
|
|
2430
|
+
"deprecatedMessage": "directly use `jinn-codemirror`/`jinn-xml-editor`/`jinn-epidoc-editor` instead, which are\nincluded in the `pb-code-editor` bundle."
|
|
2436
2431
|
},
|
|
2437
2432
|
{
|
|
2438
2433
|
"name": "pb-code-highlight",
|
|
2439
2434
|
"path": "./src/pb-code-highlight.js",
|
|
2440
|
-
"description": "Highlight a code snippet. The snippet may either be passed in a template child\
|
|
2435
|
+
"description": "Highlight a code snippet. The snippet may either be passed in a template child\nelement, which could contain HTML or text. If no template child is present, the\ncomponent will take any text content contained in it and highlight it. One can also\npass the code to be highlighted in the `code` property.",
|
|
2441
2436
|
"attributes": [
|
|
2442
2437
|
{
|
|
2443
2438
|
"name": "code",
|
|
2444
|
-
"description": "The code to be highlighted as a string. If not set,\
|
|
2439
|
+
"description": "The code to be highlighted as a string. If not set,\nthis will be populated from either a template child element\nor the element's text content.\nThe value of the property can be changed programmatically from JavaScript.",
|
|
2445
2440
|
"type": "string"
|
|
2446
2441
|
},
|
|
2447
2442
|
{
|
|
@@ -2452,7 +2447,7 @@
|
|
|
2452
2447
|
},
|
|
2453
2448
|
{
|
|
2454
2449
|
"name": "theme",
|
|
2455
|
-
"description": "Highlighting theme to use: 'coy', 'dark', 'funky', 'okaida', 'solarizedlight',\
|
|
2450
|
+
"description": "Highlighting theme to use: 'coy', 'dark', 'funky', 'okaida', 'solarizedlight',\n'tomorrow', 'twilight' or 'default'.",
|
|
2456
2451
|
"type": "string",
|
|
2457
2452
|
"default": "\"default\""
|
|
2458
2453
|
},
|
|
@@ -2466,7 +2461,7 @@
|
|
|
2466
2461
|
{
|
|
2467
2462
|
"name": "code",
|
|
2468
2463
|
"attribute": "code",
|
|
2469
|
-
"description": "The code to be highlighted as a string. If not set,\
|
|
2464
|
+
"description": "The code to be highlighted as a string. If not set,\nthis will be populated from either a template child element\nor the element's text content.\nThe value of the property can be changed programmatically from JavaScript.",
|
|
2470
2465
|
"type": "string"
|
|
2471
2466
|
},
|
|
2472
2467
|
{
|
|
@@ -2479,7 +2474,7 @@
|
|
|
2479
2474
|
{
|
|
2480
2475
|
"name": "theme",
|
|
2481
2476
|
"attribute": "theme",
|
|
2482
|
-
"description": "Highlighting theme to use: 'coy', 'dark', 'funky', 'okaida', 'solarizedlight',\
|
|
2477
|
+
"description": "Highlighting theme to use: 'coy', 'dark', 'funky', 'okaida', 'solarizedlight',\n'tomorrow', 'twilight' or 'default'.",
|
|
2483
2478
|
"type": "string",
|
|
2484
2479
|
"default": "\"default\""
|
|
2485
2480
|
},
|
|
@@ -2588,14 +2583,13 @@
|
|
|
2588
2583
|
"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```\n\nBy adding a CSS 'icon-right' to a `pb-collapse` the icon can be placed on the right side\n```\n<pb-collapse class='icon-right'>\n```",
|
|
2589
2584
|
"attributes": [
|
|
2590
2585
|
{
|
|
2591
|
-
"name": "
|
|
2592
|
-
"
|
|
2593
|
-
"
|
|
2594
|
-
"deprecatedMessage": "Corresponds to the iron-collapse's horizontal property."
|
|
2586
|
+
"name": "icon-sprite",
|
|
2587
|
+
"description": "Optional custom sprite source passed to pb-icon.",
|
|
2588
|
+
"type": "string"
|
|
2595
2589
|
},
|
|
2596
2590
|
{
|
|
2597
2591
|
"name": "no-animation",
|
|
2598
|
-
"description": "
|
|
2592
|
+
"description": "Whether to disable animations.",
|
|
2599
2593
|
"type": "boolean",
|
|
2600
2594
|
"default": "false"
|
|
2601
2595
|
},
|
|
@@ -2607,19 +2601,19 @@
|
|
|
2607
2601
|
},
|
|
2608
2602
|
{
|
|
2609
2603
|
"name": "expand-icon",
|
|
2610
|
-
"description": "
|
|
2604
|
+
"description": "Icon to show when the collapse is closed.",
|
|
2611
2605
|
"type": "string",
|
|
2612
2606
|
"default": "\"icons:expand-more\""
|
|
2613
2607
|
},
|
|
2614
2608
|
{
|
|
2615
2609
|
"name": "collapse-icon",
|
|
2616
|
-
"description": "
|
|
2610
|
+
"description": "Icon to show when the collapse is open.",
|
|
2617
2611
|
"type": "string",
|
|
2618
2612
|
"default": "\"icons:expand-less\""
|
|
2619
2613
|
},
|
|
2620
2614
|
{
|
|
2621
2615
|
"name": "no-icons",
|
|
2622
|
-
"description": "
|
|
2616
|
+
"description": "Disable icons entirely.",
|
|
2623
2617
|
"type": "boolean",
|
|
2624
2618
|
"default": "false"
|
|
2625
2619
|
},
|
|
@@ -2662,17 +2656,21 @@
|
|
|
2662
2656
|
}
|
|
2663
2657
|
],
|
|
2664
2658
|
"properties": [
|
|
2659
|
+
{
|
|
2660
|
+
"name": "iconSprite",
|
|
2661
|
+
"attribute": "icon-sprite",
|
|
2662
|
+
"description": "Optional custom sprite source passed to pb-icon.",
|
|
2663
|
+
"type": "string"
|
|
2664
|
+
},
|
|
2665
2665
|
{
|
|
2666
2666
|
"name": "horizontal",
|
|
2667
|
-
"attribute": "horizontal",
|
|
2668
2667
|
"type": "boolean",
|
|
2669
|
-
"default": "false"
|
|
2670
|
-
"deprecatedMessage": "Corresponds to the iron-collapse's horizontal property."
|
|
2668
|
+
"default": "false"
|
|
2671
2669
|
},
|
|
2672
2670
|
{
|
|
2673
2671
|
"name": "noAnimation",
|
|
2674
2672
|
"attribute": "no-animation",
|
|
2675
|
-
"description": "
|
|
2673
|
+
"description": "Whether to disable animations.",
|
|
2676
2674
|
"type": "boolean",
|
|
2677
2675
|
"default": "false"
|
|
2678
2676
|
},
|
|
@@ -2686,21 +2684,21 @@
|
|
|
2686
2684
|
{
|
|
2687
2685
|
"name": "expandIcon",
|
|
2688
2686
|
"attribute": "expand-icon",
|
|
2689
|
-
"description": "
|
|
2687
|
+
"description": "Icon to show when the collapse is closed.",
|
|
2690
2688
|
"type": "string",
|
|
2691
2689
|
"default": "\"icons:expand-more\""
|
|
2692
2690
|
},
|
|
2693
2691
|
{
|
|
2694
2692
|
"name": "collapseIcon",
|
|
2695
2693
|
"attribute": "collapse-icon",
|
|
2696
|
-
"description": "
|
|
2694
|
+
"description": "Icon to show when the collapse is open.",
|
|
2697
2695
|
"type": "string",
|
|
2698
2696
|
"default": "\"icons:expand-less\""
|
|
2699
2697
|
},
|
|
2700
2698
|
{
|
|
2701
2699
|
"name": "noIcons",
|
|
2702
2700
|
"attribute": "no-icons",
|
|
2703
|
-
"description": "
|
|
2701
|
+
"description": "Disable icons entirely.",
|
|
2704
2702
|
"type": "boolean",
|
|
2705
2703
|
"default": "false"
|
|
2706
2704
|
},
|
|
@@ -2768,15 +2766,24 @@
|
|
|
2768
2766
|
"cssProperties": [
|
|
2769
2767
|
{
|
|
2770
2768
|
"name": "--pb-collapse-icon-padding",
|
|
2771
|
-
"description": "padding
|
|
2772
|
-
"default": "\"
|
|
2769
|
+
"description": "padding left or right of the \"caret\" icon left to the collapsible item",
|
|
2770
|
+
"default": "\".5rem\""
|
|
2771
|
+
},
|
|
2772
|
+
{
|
|
2773
|
+
"name": "--pb-collapse-icon-size",
|
|
2774
|
+
"description": "size of the \"caret\" icon left to the collapsible item",
|
|
2775
|
+
"default": "\".75rem\""
|
|
2776
|
+
},
|
|
2777
|
+
{
|
|
2778
|
+
"name": "--pb-collapse-icon-image",
|
|
2779
|
+
"description": "image of the \"caret\" icon left to the collapsible item"
|
|
2773
2780
|
}
|
|
2774
2781
|
]
|
|
2775
2782
|
},
|
|
2776
2783
|
{
|
|
2777
2784
|
"name": "pb-combo-box",
|
|
2778
2785
|
"path": "./src/pb-combo-box.js",
|
|
2779
|
-
"description": "Provides a combo box, i.e. a combination of an input with a dropdown.\nItems to select from may be obtained from a remote data source.\n\nThe form control to be used (either a select or input) should be passed
|
|
2786
|
+
"description": "Provides a combo box, i.e. a combination of an input with a dropdown.\nItems to select from may be obtained from a remote data source.\n\nThe form control to be used (either a select or input) should be passed\nin the content of the element. If no control is provided, a simple `<input>`\nwill be created.",
|
|
2780
2787
|
"attributes": [
|
|
2781
2788
|
{
|
|
2782
2789
|
"name": "source",
|
|
@@ -2987,7 +2994,7 @@
|
|
|
2987
2994
|
},
|
|
2988
2995
|
{
|
|
2989
2996
|
"name": "use-language",
|
|
2990
|
-
"description": "If set, a parameter \"language\" will be added to the parameter list
|
|
2997
|
+
"description": "If set, a parameter \"language\" will be added to the parameter list.\nAlso, 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.",
|
|
2991
2998
|
"type": "boolean"
|
|
2992
2999
|
},
|
|
2993
3000
|
{
|
|
@@ -3114,7 +3121,7 @@
|
|
|
3114
3121
|
{
|
|
3115
3122
|
"name": "useLanguage",
|
|
3116
3123
|
"attribute": "use-language",
|
|
3117
|
-
"description": "If set, a parameter \"language\" will be added to the parameter list
|
|
3124
|
+
"description": "If set, a parameter \"language\" will be added to the parameter list.\nAlso, 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.",
|
|
3118
3125
|
"type": "boolean"
|
|
3119
3126
|
},
|
|
3120
3127
|
{
|
|
@@ -3257,7 +3264,7 @@
|
|
|
3257
3264
|
{
|
|
3258
3265
|
"name": "pb-dialog",
|
|
3259
3266
|
"path": "./src/pb-dialog.js",
|
|
3260
|
-
"description": "A simple dialog component using the HTML5 <dialog> element
|
|
3267
|
+
"description": "A simple dialog component using the HTML5 <dialog> element.\n\nAny button with the attribute `rel=\"prev\"` will close the dialog when clicked.",
|
|
3261
3268
|
"attributes": [
|
|
3262
3269
|
{
|
|
3263
3270
|
"name": "open",
|
|
@@ -3547,7 +3554,7 @@
|
|
|
3547
3554
|
"attributes": [
|
|
3548
3555
|
{
|
|
3549
3556
|
"name": "src",
|
|
3550
|
-
"description": "optional id reference to a pb-document. If `url` is not specified
|
|
3557
|
+
"description": "optional id reference to a pb-document. If `url` is not specified,\na correct download URL is constructed using the given document path and parameters.\nOtherwise `url` will be used as main URL.",
|
|
3551
3558
|
"type": "string"
|
|
3552
3559
|
},
|
|
3553
3560
|
{
|
|
@@ -3562,7 +3569,7 @@
|
|
|
3562
3569
|
},
|
|
3563
3570
|
{
|
|
3564
3571
|
"name": "dialog",
|
|
3565
|
-
"description": "id of dialog component to show when downloading. A
|
|
3572
|
+
"description": "id of dialog component to show when downloading. A `pb-dialog` component with this id must\nexist.",
|
|
3566
3573
|
"type": "string"
|
|
3567
3574
|
},
|
|
3568
3575
|
{
|
|
@@ -3623,7 +3630,7 @@
|
|
|
3623
3630
|
{
|
|
3624
3631
|
"name": "src",
|
|
3625
3632
|
"attribute": "src",
|
|
3626
|
-
"description": "optional id reference to a pb-document. If `url` is not specified
|
|
3633
|
+
"description": "optional id reference to a pb-document. If `url` is not specified,\na correct download URL is constructed using the given document path and parameters.\nOtherwise `url` will be used as main URL.",
|
|
3627
3634
|
"type": "string"
|
|
3628
3635
|
},
|
|
3629
3636
|
{
|
|
@@ -3641,7 +3648,7 @@
|
|
|
3641
3648
|
{
|
|
3642
3649
|
"name": "dialog",
|
|
3643
3650
|
"attribute": "dialog",
|
|
3644
|
-
"description": "id of dialog component to show when downloading. A
|
|
3651
|
+
"description": "id of dialog component to show when downloading. A `pb-dialog` component with this id must\nexist.",
|
|
3645
3652
|
"type": "string"
|
|
3646
3653
|
},
|
|
3647
3654
|
{
|
|
@@ -4014,6 +4021,9 @@
|
|
|
4014
4021
|
{
|
|
4015
4022
|
"name": "pb-end-update",
|
|
4016
4023
|
"description": "Fired after the element has finished updating its content"
|
|
4024
|
+
},
|
|
4025
|
+
{
|
|
4026
|
+
"name": "submit"
|
|
4017
4027
|
}
|
|
4018
4028
|
]
|
|
4019
4029
|
},
|
|
@@ -4156,9 +4166,9 @@
|
|
|
4156
4166
|
},
|
|
4157
4167
|
{
|
|
4158
4168
|
"name": "trigger",
|
|
4159
|
-
"description": "Type of event which should trigger the facsimile to display
|
|
4169
|
+
"description": "Type of event which should trigger the facsimile to display.\nEither 'click' or 'mouseover' (default).",
|
|
4160
4170
|
"type": "string",
|
|
4161
|
-
"default": "\"
|
|
4171
|
+
"default": "\"click\""
|
|
4162
4172
|
},
|
|
4163
4173
|
{
|
|
4164
4174
|
"name": "label",
|
|
@@ -4225,9 +4235,9 @@
|
|
|
4225
4235
|
{
|
|
4226
4236
|
"name": "trigger",
|
|
4227
4237
|
"attribute": "trigger",
|
|
4228
|
-
"description": "Type of event which should trigger the facsimile to display
|
|
4238
|
+
"description": "Type of event which should trigger the facsimile to display.\nEither 'click' or 'mouseover' (default).",
|
|
4229
4239
|
"type": "string",
|
|
4230
|
-
"default": "\"
|
|
4240
|
+
"default": "\"click\""
|
|
4231
4241
|
},
|
|
4232
4242
|
{
|
|
4233
4243
|
"name": "label",
|
|
@@ -4648,6 +4658,84 @@
|
|
|
4648
4658
|
}
|
|
4649
4659
|
]
|
|
4650
4660
|
},
|
|
4661
|
+
{
|
|
4662
|
+
"name": "pb-fetch",
|
|
4663
|
+
"path": "./src/pb-fetch.js",
|
|
4664
|
+
"description": "Lightweight replacement for `<iron-ajax>` using the Fetch API.\nProvides a mostly compatible surface for existing components.",
|
|
4665
|
+
"attributes": [
|
|
4666
|
+
{
|
|
4667
|
+
"name": "method",
|
|
4668
|
+
"type": "string"
|
|
4669
|
+
},
|
|
4670
|
+
{
|
|
4671
|
+
"name": "handle-as"
|
|
4672
|
+
},
|
|
4673
|
+
{
|
|
4674
|
+
"name": "with-credentials"
|
|
4675
|
+
},
|
|
4676
|
+
{
|
|
4677
|
+
"name": "content-type"
|
|
4678
|
+
}
|
|
4679
|
+
],
|
|
4680
|
+
"properties": [
|
|
4681
|
+
{
|
|
4682
|
+
"name": "url",
|
|
4683
|
+
"type": "string"
|
|
4684
|
+
},
|
|
4685
|
+
{
|
|
4686
|
+
"name": "handleAs",
|
|
4687
|
+
"type": "string"
|
|
4688
|
+
},
|
|
4689
|
+
{
|
|
4690
|
+
"name": "withCredentials",
|
|
4691
|
+
"type": "boolean"
|
|
4692
|
+
},
|
|
4693
|
+
{
|
|
4694
|
+
"name": "contentType"
|
|
4695
|
+
},
|
|
4696
|
+
{
|
|
4697
|
+
"name": "method",
|
|
4698
|
+
"attribute": "method",
|
|
4699
|
+
"type": "string"
|
|
4700
|
+
},
|
|
4701
|
+
{
|
|
4702
|
+
"name": "params",
|
|
4703
|
+
"type": "object",
|
|
4704
|
+
"default": "{}"
|
|
4705
|
+
},
|
|
4706
|
+
{
|
|
4707
|
+
"name": "headers",
|
|
4708
|
+
"type": "object",
|
|
4709
|
+
"default": "{}"
|
|
4710
|
+
},
|
|
4711
|
+
{
|
|
4712
|
+
"name": "body",
|
|
4713
|
+
"default": "\"undefined\""
|
|
4714
|
+
},
|
|
4715
|
+
{
|
|
4716
|
+
"name": "loading",
|
|
4717
|
+
"type": "boolean",
|
|
4718
|
+
"default": "false"
|
|
4719
|
+
},
|
|
4720
|
+
{
|
|
4721
|
+
"name": "lastResponse"
|
|
4722
|
+
},
|
|
4723
|
+
{
|
|
4724
|
+
"name": "lastRequest"
|
|
4725
|
+
},
|
|
4726
|
+
{
|
|
4727
|
+
"name": "lastError"
|
|
4728
|
+
}
|
|
4729
|
+
],
|
|
4730
|
+
"events": [
|
|
4731
|
+
{
|
|
4732
|
+
"name": "error"
|
|
4733
|
+
},
|
|
4734
|
+
{
|
|
4735
|
+
"name": "response"
|
|
4736
|
+
}
|
|
4737
|
+
]
|
|
4738
|
+
},
|
|
4651
4739
|
{
|
|
4652
4740
|
"name": "pb-formula",
|
|
4653
4741
|
"path": "./src/pb-formula.js",
|
|
@@ -4712,7 +4800,7 @@
|
|
|
4712
4800
|
{
|
|
4713
4801
|
"name": "pb-geolocation",
|
|
4714
4802
|
"path": "./src/pb-geolocation.js",
|
|
4715
|
-
"description": "Represents a geo location. Extends `pb-highlight`, but sends an additional `pb-geolocation` event\non mouseover.\n\nFor `pb-leaflet-map` to show markers for `pb-geolocation` elements, make sure that map subscribes to the channel\ninto which `pb-geolocation`s emit and that map is loaded before the emitting component, e.g. `pb-view`, by specifying
|
|
4803
|
+
"description": "Represents a geo location. Extends `pb-highlight`, but sends an additional `pb-geolocation` event\non mouseover.\n\nFor `pb-leaflet-map` to show markers for `pb-geolocation` elements, make sure that map subscribes to the channel\ninto which `pb-geolocation`s emit and that map is loaded before the emitting component, e.g. `pb-view`, by specifying\n`wait-for` property.",
|
|
4716
4804
|
"attributes": [
|
|
4717
4805
|
{
|
|
4718
4806
|
"name": "longitude",
|
|
@@ -5322,66 +5410,287 @@
|
|
|
5322
5410
|
"type": "string"
|
|
5323
5411
|
},
|
|
5324
5412
|
{
|
|
5325
|
-
"name": "disabled",
|
|
5326
|
-
"attribute": "disabled",
|
|
5327
|
-
"description": "Common property to disable the functionality associated with a component.\n`pb-highlight` and `pb-popover` react to this.",
|
|
5413
|
+
"name": "disabled",
|
|
5414
|
+
"attribute": "disabled",
|
|
5415
|
+
"description": "Common property to disable the functionality associated with a component.\n`pb-highlight` and `pb-popover` react to this.",
|
|
5416
|
+
"type": "boolean",
|
|
5417
|
+
"default": "false"
|
|
5418
|
+
}
|
|
5419
|
+
],
|
|
5420
|
+
"events": [
|
|
5421
|
+
{
|
|
5422
|
+
"name": "pb-highlight-off",
|
|
5423
|
+
"description": "Fires removal of all highlights that might have existed before"
|
|
5424
|
+
},
|
|
5425
|
+
{
|
|
5426
|
+
"name": "pb-highlight-on",
|
|
5427
|
+
"description": "Fires highlight event with a key passed to which other pb-highlight elements with the same key will react"
|
|
5428
|
+
}
|
|
5429
|
+
],
|
|
5430
|
+
"slots": [
|
|
5431
|
+
{
|
|
5432
|
+
"name": "",
|
|
5433
|
+
"description": "default unnamed slot for highlight content"
|
|
5434
|
+
}
|
|
5435
|
+
],
|
|
5436
|
+
"cssProperties": [
|
|
5437
|
+
{
|
|
5438
|
+
"name": "--pb-highlight-color",
|
|
5439
|
+
"description": "Background color to highlight an element"
|
|
5440
|
+
}
|
|
5441
|
+
]
|
|
5442
|
+
},
|
|
5443
|
+
{
|
|
5444
|
+
"name": "pb-i18n",
|
|
5445
|
+
"path": "./src/pb-i18n.js",
|
|
5446
|
+
"description": "Insert translated text somewhere on an HTML page. If no translation is found,\ndisplay the contained content.",
|
|
5447
|
+
"attributes": [
|
|
5448
|
+
{
|
|
5449
|
+
"name": "key",
|
|
5450
|
+
"description": "The i18n key to use for looking up the translation.",
|
|
5451
|
+
"type": "string",
|
|
5452
|
+
"default": "\"missing-key\""
|
|
5453
|
+
},
|
|
5454
|
+
{
|
|
5455
|
+
"name": "options",
|
|
5456
|
+
"description": "Optional interpolation parameters to be passed to the\ntranslation function",
|
|
5457
|
+
"type": "object"
|
|
5458
|
+
}
|
|
5459
|
+
],
|
|
5460
|
+
"properties": [
|
|
5461
|
+
{
|
|
5462
|
+
"name": "key",
|
|
5463
|
+
"attribute": "key",
|
|
5464
|
+
"description": "The i18n key to use for looking up the translation.",
|
|
5465
|
+
"type": "string",
|
|
5466
|
+
"default": "\"missing-key\""
|
|
5467
|
+
},
|
|
5468
|
+
{
|
|
5469
|
+
"name": "options",
|
|
5470
|
+
"attribute": "options",
|
|
5471
|
+
"description": "Optional interpolation parameters to be passed to the\ntranslation function",
|
|
5472
|
+
"type": "object"
|
|
5473
|
+
}
|
|
5474
|
+
]
|
|
5475
|
+
},
|
|
5476
|
+
{
|
|
5477
|
+
"name": "pb-icon-button",
|
|
5478
|
+
"path": "./src/pb-icon-button.js",
|
|
5479
|
+
"properties": [
|
|
5480
|
+
{
|
|
5481
|
+
"name": "properties",
|
|
5482
|
+
"type": "{ icon: { type: StringConstructor; }; disabled: { type: BooleanConstructor; reflect: boolean; }; label: { type: StringConstructor; }; toggles: { ...; }; active: { ...; }; }",
|
|
5483
|
+
"default": "{\"icon\":{\"type\":\"String\"},\"disabled\":{\"type\":\"Boolean\",\"reflect\":true},\"label\":{\"type\":\"String\"},\"toggles\":{\"type\":\"Boolean\"},\"active\":{\"type\":\"Boolean\",\"reflect\":true}}"
|
|
5484
|
+
},
|
|
5485
|
+
{
|
|
5486
|
+
"name": "styles",
|
|
5487
|
+
"type": "CSSResult",
|
|
5488
|
+
"default": "\"css`\\n :host {\\n display: inline-flex;\\n box-sizing: border-box;\\n --pb-icon-button-size: 40px;\\n }\\n\\n button {\\n width: var(--pb-icon-button-size);\\n height: var(--pb-icon-button-size);\\n border-radius: 999px;\\n border: none;\\n background: transparent;\\n color: inherit;\\n padding: 0;\\n cursor: pointer;\\n display: inline-flex;\\n align-items: center;\\n justify-content: center;\\n transition: background 0.2s ease-in-out;\\n }\\n\\n button:hover:not(:disabled),\\n button:focus-visible {\\n background: var(--pb-icon-button-hover-background, rgba(0, 0, 0, 0.05));\\n outline: none;\\n }\\n\\n button:disabled {\\n opacity: 0.4;\\n cursor: not-allowed;\\n }\\n\\n :host([active]) button {\\n background: var(--pb-icon-button-active-background, rgba(0, 0, 0, 0.08));\\n }\\n `\""
|
|
5489
|
+
},
|
|
5490
|
+
{
|
|
5491
|
+
"name": "icon",
|
|
5492
|
+
"type": "string",
|
|
5493
|
+
"default": "\"\""
|
|
5494
|
+
},
|
|
5495
|
+
{
|
|
5496
|
+
"name": "disabled",
|
|
5497
|
+
"type": "boolean",
|
|
5498
|
+
"default": "false"
|
|
5499
|
+
},
|
|
5500
|
+
{
|
|
5501
|
+
"name": "label",
|
|
5502
|
+
"type": "string",
|
|
5503
|
+
"default": "\"\""
|
|
5504
|
+
},
|
|
5505
|
+
{
|
|
5506
|
+
"name": "toggles",
|
|
5507
|
+
"type": "boolean",
|
|
5508
|
+
"default": "false"
|
|
5509
|
+
},
|
|
5510
|
+
{
|
|
5511
|
+
"name": "active",
|
|
5512
|
+
"type": "boolean",
|
|
5513
|
+
"default": "false"
|
|
5514
|
+
}
|
|
5515
|
+
],
|
|
5516
|
+
"events": [
|
|
5517
|
+
{
|
|
5518
|
+
"name": "active-changed"
|
|
5519
|
+
}
|
|
5520
|
+
]
|
|
5521
|
+
},
|
|
5522
|
+
{
|
|
5523
|
+
"name": "pb-icon",
|
|
5524
|
+
"path": "./src/pb-icon.js",
|
|
5525
|
+
"description": "A versatile icon component that replaces iron-icon and iron-icons.\nSupports both SVG sprite references and inline SVG content.",
|
|
5526
|
+
"attributes": [
|
|
5527
|
+
{
|
|
5528
|
+
"name": "sprite",
|
|
5529
|
+
"description": "Path or URL to the SVG sprite file. Optional.\nIf not specified, defaults to 'dist/images/icons.svg'.\nIf set to a string starting with '#', uses inline sprite.",
|
|
5530
|
+
"type": "string"
|
|
5531
|
+
},
|
|
5532
|
+
{
|
|
5533
|
+
"name": "icon",
|
|
5534
|
+
"description": "Icon name to display from the icon sprite.\nIf not provided, expects SVG content in the default slot.",
|
|
5535
|
+
"type": "string",
|
|
5536
|
+
"default": "\"\""
|
|
5537
|
+
},
|
|
5538
|
+
{
|
|
5539
|
+
"name": "size",
|
|
5540
|
+
"description": "Icon size. Can be a preset (xs, sm, md, lg, xl) or a custom size.",
|
|
5541
|
+
"type": "string",
|
|
5542
|
+
"default": "\"\""
|
|
5543
|
+
},
|
|
5544
|
+
{
|
|
5545
|
+
"name": "label",
|
|
5546
|
+
"description": "ARIA label for accessibility. Auto-generated from icon name if not provided.",
|
|
5547
|
+
"type": "string",
|
|
5548
|
+
"default": "\"\""
|
|
5549
|
+
},
|
|
5550
|
+
{
|
|
5551
|
+
"name": "decorative",
|
|
5552
|
+
"description": "Whether the icon is decorative (hidden from screen readers).",
|
|
5553
|
+
"type": "boolean",
|
|
5554
|
+
"default": "false"
|
|
5555
|
+
}
|
|
5556
|
+
],
|
|
5557
|
+
"properties": [
|
|
5558
|
+
{
|
|
5559
|
+
"name": "sprite",
|
|
5560
|
+
"attribute": "sprite",
|
|
5561
|
+
"description": "Path or URL to the SVG sprite file. Optional.\nIf not specified, defaults to 'dist/images/icons.svg'.\nIf set to a string starting with '#', uses inline sprite.",
|
|
5562
|
+
"type": "string"
|
|
5563
|
+
},
|
|
5564
|
+
{
|
|
5565
|
+
"name": "icon",
|
|
5566
|
+
"attribute": "icon",
|
|
5567
|
+
"description": "Icon name to display from the icon sprite.\nIf not provided, expects SVG content in the default slot.",
|
|
5568
|
+
"type": "string",
|
|
5569
|
+
"default": "\"\""
|
|
5570
|
+
},
|
|
5571
|
+
{
|
|
5572
|
+
"name": "size",
|
|
5573
|
+
"attribute": "size",
|
|
5574
|
+
"description": "Icon size. Can be a preset (xs, sm, md, lg, xl) or a custom size.",
|
|
5575
|
+
"type": "string",
|
|
5576
|
+
"default": "\"\""
|
|
5577
|
+
},
|
|
5578
|
+
{
|
|
5579
|
+
"name": "label",
|
|
5580
|
+
"attribute": "label",
|
|
5581
|
+
"description": "ARIA label for accessibility. Auto-generated from icon name if not provided.",
|
|
5582
|
+
"type": "string",
|
|
5583
|
+
"default": "\"\""
|
|
5584
|
+
},
|
|
5585
|
+
{
|
|
5586
|
+
"name": "decorative",
|
|
5587
|
+
"attribute": "decorative",
|
|
5588
|
+
"description": "Whether the icon is decorative (hidden from screen readers).",
|
|
5328
5589
|
"type": "boolean",
|
|
5329
5590
|
"default": "false"
|
|
5330
5591
|
}
|
|
5331
5592
|
],
|
|
5332
|
-
"events": [
|
|
5333
|
-
{
|
|
5334
|
-
"name": "pb-highlight-off",
|
|
5335
|
-
"description": "Fires removal of all highlights that might have existed before"
|
|
5336
|
-
},
|
|
5337
|
-
{
|
|
5338
|
-
"name": "pb-highlight-on",
|
|
5339
|
-
"description": "Fires highlight event with a key passed to which other pb-highlight elements with the same key will react"
|
|
5340
|
-
}
|
|
5341
|
-
],
|
|
5342
5593
|
"slots": [
|
|
5343
5594
|
{
|
|
5344
5595
|
"name": "",
|
|
5345
|
-
"description": "
|
|
5596
|
+
"description": "Inline SVG content when not using icon name"
|
|
5346
5597
|
}
|
|
5347
5598
|
],
|
|
5348
5599
|
"cssProperties": [
|
|
5349
5600
|
{
|
|
5350
|
-
"name": "--pb-
|
|
5351
|
-
"description": "
|
|
5601
|
+
"name": "--pb-icon-color",
|
|
5602
|
+
"description": "Icon color (defaults to currentColor)"
|
|
5603
|
+
},
|
|
5604
|
+
{
|
|
5605
|
+
"name": "--pb-icon-size",
|
|
5606
|
+
"description": "Icon size (defaults to 1em)"
|
|
5352
5607
|
}
|
|
5353
5608
|
]
|
|
5354
5609
|
},
|
|
5355
5610
|
{
|
|
5356
|
-
"name": "
|
|
5357
|
-
"path": "./src/pb-
|
|
5358
|
-
"description": "Insert translated text somewhere on an HTML page. If no translation is found,\ndisplay the contained content.",
|
|
5611
|
+
"name": "iron-icon",
|
|
5612
|
+
"path": "./src/pb-icon.js",
|
|
5359
5613
|
"attributes": [
|
|
5360
5614
|
{
|
|
5361
|
-
"name": "
|
|
5362
|
-
"description": "Optional
|
|
5363
|
-
"type": "
|
|
5615
|
+
"name": "sprite",
|
|
5616
|
+
"description": "Path or URL to the SVG sprite file. Optional.\nIf not specified, defaults to 'dist/images/icons.svg'.\nIf set to a string starting with '#', uses inline sprite.",
|
|
5617
|
+
"type": "string"
|
|
5364
5618
|
},
|
|
5365
5619
|
{
|
|
5366
|
-
"name": "
|
|
5367
|
-
"description": "
|
|
5620
|
+
"name": "icon",
|
|
5621
|
+
"description": "Icon name to display from the icon sprite.\nIf not provided, expects SVG content in the default slot.",
|
|
5368
5622
|
"type": "string",
|
|
5369
|
-
"default": "\"
|
|
5623
|
+
"default": "\"\""
|
|
5624
|
+
},
|
|
5625
|
+
{
|
|
5626
|
+
"name": "size",
|
|
5627
|
+
"description": "Icon size. Can be a preset (xs, sm, md, lg, xl) or a custom size.",
|
|
5628
|
+
"type": "string",
|
|
5629
|
+
"default": "\"\""
|
|
5630
|
+
},
|
|
5631
|
+
{
|
|
5632
|
+
"name": "label",
|
|
5633
|
+
"description": "ARIA label for accessibility. Auto-generated from icon name if not provided.",
|
|
5634
|
+
"type": "string",
|
|
5635
|
+
"default": "\"\""
|
|
5636
|
+
},
|
|
5637
|
+
{
|
|
5638
|
+
"name": "decorative",
|
|
5639
|
+
"description": "Whether the icon is decorative (hidden from screen readers).",
|
|
5640
|
+
"type": "boolean",
|
|
5641
|
+
"default": "false"
|
|
5370
5642
|
}
|
|
5371
5643
|
],
|
|
5372
5644
|
"properties": [
|
|
5373
5645
|
{
|
|
5374
|
-
"name": "
|
|
5375
|
-
"attribute": "
|
|
5376
|
-
"description": "Optional
|
|
5377
|
-
"type": "
|
|
5646
|
+
"name": "sprite",
|
|
5647
|
+
"attribute": "sprite",
|
|
5648
|
+
"description": "Path or URL to the SVG sprite file. Optional.\nIf not specified, defaults to 'dist/images/icons.svg'.\nIf set to a string starting with '#', uses inline sprite.",
|
|
5649
|
+
"type": "string"
|
|
5378
5650
|
},
|
|
5379
5651
|
{
|
|
5380
|
-
"name": "
|
|
5381
|
-
"attribute": "
|
|
5382
|
-
"description": "
|
|
5652
|
+
"name": "icon",
|
|
5653
|
+
"attribute": "icon",
|
|
5654
|
+
"description": "Icon name to display from the icon sprite.\nIf not provided, expects SVG content in the default slot.",
|
|
5383
5655
|
"type": "string",
|
|
5384
|
-
"default": "\"
|
|
5656
|
+
"default": "\"\""
|
|
5657
|
+
},
|
|
5658
|
+
{
|
|
5659
|
+
"name": "size",
|
|
5660
|
+
"attribute": "size",
|
|
5661
|
+
"description": "Icon size. Can be a preset (xs, sm, md, lg, xl) or a custom size.",
|
|
5662
|
+
"type": "string",
|
|
5663
|
+
"default": "\"\""
|
|
5664
|
+
},
|
|
5665
|
+
{
|
|
5666
|
+
"name": "label",
|
|
5667
|
+
"attribute": "label",
|
|
5668
|
+
"description": "ARIA label for accessibility. Auto-generated from icon name if not provided.",
|
|
5669
|
+
"type": "string",
|
|
5670
|
+
"default": "\"\""
|
|
5671
|
+
},
|
|
5672
|
+
{
|
|
5673
|
+
"name": "decorative",
|
|
5674
|
+
"attribute": "decorative",
|
|
5675
|
+
"description": "Whether the icon is decorative (hidden from screen readers).",
|
|
5676
|
+
"type": "boolean",
|
|
5677
|
+
"default": "false"
|
|
5678
|
+
}
|
|
5679
|
+
],
|
|
5680
|
+
"slots": [
|
|
5681
|
+
{
|
|
5682
|
+
"name": "",
|
|
5683
|
+
"description": "Inline SVG content when not using icon name"
|
|
5684
|
+
}
|
|
5685
|
+
],
|
|
5686
|
+
"cssProperties": [
|
|
5687
|
+
{
|
|
5688
|
+
"name": "--pb-icon-color",
|
|
5689
|
+
"description": "Icon color (defaults to currentColor)"
|
|
5690
|
+
},
|
|
5691
|
+
{
|
|
5692
|
+
"name": "--pb-icon-size",
|
|
5693
|
+
"description": "Icon size (defaults to 1em)"
|
|
5385
5694
|
}
|
|
5386
5695
|
]
|
|
5387
5696
|
},
|
|
@@ -5524,6 +5833,12 @@
|
|
|
5524
5833
|
"type": "string",
|
|
5525
5834
|
"default": "\"language\""
|
|
5526
5835
|
},
|
|
5836
|
+
{
|
|
5837
|
+
"name": "display",
|
|
5838
|
+
"description": "How should the selected value be displayed?\n\n- `text` - Display the text content of the selected option\n- other - Attribute name to use",
|
|
5839
|
+
"type": "string",
|
|
5840
|
+
"default": "\"value\""
|
|
5841
|
+
},
|
|
5527
5842
|
{
|
|
5528
5843
|
"name": "subscribe",
|
|
5529
5844
|
"description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
|
|
@@ -5569,6 +5884,13 @@
|
|
|
5569
5884
|
"type": "string",
|
|
5570
5885
|
"default": "\"language\""
|
|
5571
5886
|
},
|
|
5887
|
+
{
|
|
5888
|
+
"name": "display",
|
|
5889
|
+
"attribute": "display",
|
|
5890
|
+
"description": "How should the selected value be displayed?\n\n- `text` - Display the text content of the selected option\n- other - Attribute name to use",
|
|
5891
|
+
"type": "string",
|
|
5892
|
+
"default": "\"value\""
|
|
5893
|
+
},
|
|
5572
5894
|
{
|
|
5573
5895
|
"name": "subscribe",
|
|
5574
5896
|
"attribute": "subscribe",
|
|
@@ -5618,9 +5940,19 @@
|
|
|
5618
5940
|
}
|
|
5619
5941
|
],
|
|
5620
5942
|
"slots": [
|
|
5943
|
+
{
|
|
5944
|
+
"name": "select",
|
|
5945
|
+
"description": "Optional select element to use for language selection. If not provided, a default one will be created."
|
|
5946
|
+
},
|
|
5621
5947
|
{
|
|
5622
5948
|
"name": "",
|
|
5623
|
-
"description": "unnamed default slot for dropdown menu options
|
|
5949
|
+
"description": "unnamed default slot for dropdown menu options"
|
|
5950
|
+
}
|
|
5951
|
+
],
|
|
5952
|
+
"cssProperties": [
|
|
5953
|
+
{
|
|
5954
|
+
"name": "--pb-lang-input-color",
|
|
5955
|
+
"description": "Color of the text in the language field"
|
|
5624
5956
|
}
|
|
5625
5957
|
]
|
|
5626
5958
|
},
|
|
@@ -5695,7 +6027,7 @@
|
|
|
5695
6027
|
},
|
|
5696
6028
|
{
|
|
5697
6029
|
"name": "geo-coding",
|
|
5698
|
-
"description": "Enables geocoding: an additional control will allow users to search for a place.\nReverse geocoding is also possible: clicking on the map while pressing ctrl or cmd
|
|
6030
|
+
"description": "Enables geocoding: an additional control will allow users to search for a place.\nReverse geocoding is also possible: clicking on the map while pressing ctrl or cmd\nwill request information about the current location.\n\nIn both cases, a `pb-geocode` event will be emitted containing additional information\nabout the place in the event details (see demo).\n\nFor lookups the free OSM/Nominatim service is used.",
|
|
5699
6031
|
"type": "boolean",
|
|
5700
6032
|
"default": "false"
|
|
5701
6033
|
},
|
|
@@ -5815,7 +6147,7 @@
|
|
|
5815
6147
|
{
|
|
5816
6148
|
"name": "geoCoding",
|
|
5817
6149
|
"attribute": "geo-coding",
|
|
5818
|
-
"description": "Enables geocoding: an additional control will allow users to search for a place.\nReverse geocoding is also possible: clicking on the map while pressing ctrl or cmd
|
|
6150
|
+
"description": "Enables geocoding: an additional control will allow users to search for a place.\nReverse geocoding is also possible: clicking on the map while pressing ctrl or cmd\nwill request information about the current location.\n\nIn both cases, a `pb-geocode` event will be emitted containing additional information\nabout the place in the event details (see demo).\n\nFor lookups the free OSM/Nominatim service is used.",
|
|
5819
6151
|
"type": "boolean",
|
|
5820
6152
|
"default": "false"
|
|
5821
6153
|
},
|
|
@@ -5889,7 +6221,7 @@
|
|
|
5889
6221
|
{
|
|
5890
6222
|
"name": "pb-link",
|
|
5891
6223
|
"path": "./src/pb-link.js",
|
|
5892
|
-
"description": "Create an internal link: clicking it will emit a `pb-refresh`event
|
|
6224
|
+
"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.",
|
|
5893
6225
|
"attributes": [
|
|
5894
6226
|
{
|
|
5895
6227
|
"name": "xml-id",
|
|
@@ -6106,7 +6438,7 @@
|
|
|
6106
6438
|
},
|
|
6107
6439
|
{
|
|
6108
6440
|
"name": "use-language",
|
|
6109
|
-
"description": "If set, a parameter \"language\" will be added to the parameter list
|
|
6441
|
+
"description": "If set, a parameter \"language\" will be added to the parameter list.\nAlso, 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.",
|
|
6110
6442
|
"type": "boolean"
|
|
6111
6443
|
},
|
|
6112
6444
|
{
|
|
@@ -6227,7 +6559,7 @@
|
|
|
6227
6559
|
{
|
|
6228
6560
|
"name": "useLanguage",
|
|
6229
6561
|
"attribute": "use-language",
|
|
6230
|
-
"description": "If set, a parameter \"language\" will be added to the parameter list
|
|
6562
|
+
"description": "If set, a parameter \"language\" will be added to the parameter list.\nAlso, 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.",
|
|
6231
6563
|
"type": "boolean"
|
|
6232
6564
|
},
|
|
6233
6565
|
{
|
|
@@ -6698,7 +7030,7 @@
|
|
|
6698
7030
|
{
|
|
6699
7031
|
"name": "pb-map-icon",
|
|
6700
7032
|
"path": "./src/pb-map-icon.js",
|
|
6701
|
-
"description": "Configure a map icon type to be used for markers
|
|
7033
|
+
"description": "Configure a map icon type to be used for markers.\nShould be nested inside `pb-leaflet-map`.",
|
|
6702
7034
|
"attributes": [
|
|
6703
7035
|
{
|
|
6704
7036
|
"name": "icon-size",
|
|
@@ -7091,7 +7423,7 @@
|
|
|
7091
7423
|
{
|
|
7092
7424
|
"name": "pb-mei",
|
|
7093
7425
|
"path": "./src/pb-mei.js",
|
|
7094
|
-
"description": "A viewer and player for MEI musical notation based on [Verovio](https://www.verovio.org/).\nSupports optional MIDI playback using [web-midi-player](https://midi.yvesgurcan.com/).\nBoth libraries are loaded dynamically when the component is used the first time.\n\nViewing options to be selected by the user can be defined via nested `pb-option` elements:\n\n```html\n<pb-mei id=\"viewer\" player url=\"http://www.marenzio.org/mei/M-06-5/M_06_5_01_S_io_parto_i_moro_e_pur_partir_conviene.mei\"
|
|
7426
|
+
"description": "A viewer and player for MEI musical notation based on [Verovio](https://www.verovio.org/).\nSupports optional MIDI playback using [web-midi-player](https://midi.yvesgurcan.com/).\nBoth libraries are loaded dynamically when the component is used the first time.\n\nViewing options to be selected by the user can be defined via nested `pb-option` elements:\n\n```html\n<pb-mei id=\"viewer\" player url=\"http://www.marenzio.org/mei/M-06-5/M_06_5_01_S_io_parto_i_moro_e_pur_partir_conviene.mei\"\n footer=\"none\">\n <pb-option name=\"appXPath\" on=\"./rdg[contains(@label, 'original')]\" off=\"\">Original Clefs</pb-option>\n</pb-mei>\n```\n\nThe MEI document to display can either be given directly in the `data` property or loaded from an URL\nspecified in `url`.",
|
|
7095
7427
|
"attributes": [
|
|
7096
7428
|
{
|
|
7097
7429
|
"name": "data",
|
|
@@ -7100,7 +7432,7 @@
|
|
|
7100
7432
|
},
|
|
7101
7433
|
{
|
|
7102
7434
|
"name": "url",
|
|
7103
|
-
"description": "URL of the MEI file to load. Will be used if no `data` property is present
|
|
7435
|
+
"description": "URL of the MEI file to load. Will be used if no `data` property is present.\nA relative URL would be resolved relative to the TEI Publisher endpoint.",
|
|
7104
7436
|
"type": "string"
|
|
7105
7437
|
},
|
|
7106
7438
|
{
|
|
@@ -7188,7 +7520,7 @@
|
|
|
7188
7520
|
{
|
|
7189
7521
|
"name": "url",
|
|
7190
7522
|
"attribute": "url",
|
|
7191
|
-
"description": "URL of the MEI file to load. Will be used if no `data` property is present
|
|
7523
|
+
"description": "URL of the MEI file to load. Will be used if no `data` property is present.\nA relative URL would be resolved relative to the TEI Publisher endpoint.",
|
|
7192
7524
|
"type": "string"
|
|
7193
7525
|
},
|
|
7194
7526
|
{
|
|
@@ -7280,6 +7612,11 @@
|
|
|
7280
7612
|
"default": "false"
|
|
7281
7613
|
}
|
|
7282
7614
|
],
|
|
7615
|
+
"events": [
|
|
7616
|
+
{
|
|
7617
|
+
"name": "pb-mei-error"
|
|
7618
|
+
}
|
|
7619
|
+
],
|
|
7283
7620
|
"cssProperties": [
|
|
7284
7621
|
{
|
|
7285
7622
|
"name": "--pb-mei-min-width",
|
|
@@ -7319,6 +7656,11 @@
|
|
|
7319
7656
|
"description": "type of message. Can be either 'message' or 'confirm'. In case of confirm the buttons 'yes' and 'no'\nwill be shown and the dialog becomes modal.",
|
|
7320
7657
|
"type": "string",
|
|
7321
7658
|
"default": "\"message\""
|
|
7659
|
+
},
|
|
7660
|
+
{
|
|
7661
|
+
"name": "open",
|
|
7662
|
+
"type": "boolean",
|
|
7663
|
+
"default": "false"
|
|
7322
7664
|
}
|
|
7323
7665
|
],
|
|
7324
7666
|
"properties": [
|
|
@@ -7342,6 +7684,12 @@
|
|
|
7342
7684
|
"description": "type of message. Can be either 'message' or 'confirm'. In case of confirm the buttons 'yes' and 'no'\nwill be shown and the dialog becomes modal.",
|
|
7343
7685
|
"type": "string",
|
|
7344
7686
|
"default": "\"message\""
|
|
7687
|
+
},
|
|
7688
|
+
{
|
|
7689
|
+
"name": "open",
|
|
7690
|
+
"attribute": "open",
|
|
7691
|
+
"type": "boolean",
|
|
7692
|
+
"default": "false"
|
|
7345
7693
|
}
|
|
7346
7694
|
]
|
|
7347
7695
|
},
|
|
@@ -7583,6 +7931,10 @@
|
|
|
7583
7931
|
"path": "./src/pb-odd-editor.js",
|
|
7584
7932
|
"description": "ODD editor component",
|
|
7585
7933
|
"attributes": [
|
|
7934
|
+
{
|
|
7935
|
+
"name": "tabs",
|
|
7936
|
+
"type": "array"
|
|
7937
|
+
},
|
|
7586
7938
|
{
|
|
7587
7939
|
"name": "ident",
|
|
7588
7940
|
"type": "string",
|
|
@@ -7676,11 +8028,6 @@
|
|
|
7676
8028
|
"type": "boolean",
|
|
7677
8029
|
"default": "true"
|
|
7678
8030
|
},
|
|
7679
|
-
{
|
|
7680
|
-
"name": "tabs",
|
|
7681
|
-
"type": "array",
|
|
7682
|
-
"default": "[]"
|
|
7683
|
-
},
|
|
7684
8031
|
{
|
|
7685
8032
|
"name": "tabIndex",
|
|
7686
8033
|
"type": "number",
|
|
@@ -7724,6 +8071,15 @@
|
|
|
7724
8071
|
}
|
|
7725
8072
|
],
|
|
7726
8073
|
"properties": [
|
|
8074
|
+
{
|
|
8075
|
+
"name": "tabs",
|
|
8076
|
+
"attribute": "tabs",
|
|
8077
|
+
"type": "array"
|
|
8078
|
+
},
|
|
8079
|
+
{
|
|
8080
|
+
"name": "safeTabs",
|
|
8081
|
+
"type": "array"
|
|
8082
|
+
},
|
|
7727
8083
|
{
|
|
7728
8084
|
"name": "ident",
|
|
7729
8085
|
"attribute": "ident",
|
|
@@ -7835,12 +8191,6 @@
|
|
|
7835
8191
|
"type": "boolean",
|
|
7836
8192
|
"default": "true"
|
|
7837
8193
|
},
|
|
7838
|
-
{
|
|
7839
|
-
"name": "tabs",
|
|
7840
|
-
"attribute": "tabs",
|
|
7841
|
-
"type": "array",
|
|
7842
|
-
"default": "[]"
|
|
7843
|
-
},
|
|
7844
8194
|
{
|
|
7845
8195
|
"name": "tabIndex",
|
|
7846
8196
|
"attribute": "tabIndex",
|
|
@@ -7942,7 +8292,7 @@
|
|
|
7942
8292
|
"type": "string"
|
|
7943
8293
|
},
|
|
7944
8294
|
{
|
|
7945
|
-
"name": "
|
|
8295
|
+
"name": "apiVersion",
|
|
7946
8296
|
"type": "string"
|
|
7947
8297
|
},
|
|
7948
8298
|
{
|
|
@@ -7971,7 +8321,7 @@
|
|
|
7971
8321
|
},
|
|
7972
8322
|
{
|
|
7973
8323
|
"name": "apiVersion",
|
|
7974
|
-
"attribute": "
|
|
8324
|
+
"attribute": "apiVersion",
|
|
7975
8325
|
"type": "string"
|
|
7976
8326
|
},
|
|
7977
8327
|
{
|
|
@@ -8033,7 +8383,7 @@
|
|
|
8033
8383
|
"type": "string"
|
|
8034
8384
|
},
|
|
8035
8385
|
{
|
|
8036
|
-
"name": "
|
|
8386
|
+
"name": "apiVersion",
|
|
8037
8387
|
"type": "string"
|
|
8038
8388
|
},
|
|
8039
8389
|
{
|
|
@@ -8119,7 +8469,7 @@
|
|
|
8119
8469
|
"default": "\"expand-more\""
|
|
8120
8470
|
},
|
|
8121
8471
|
{
|
|
8122
|
-
"name": "
|
|
8472
|
+
"name": "hasCustomBehaviour",
|
|
8123
8473
|
"type": "boolean",
|
|
8124
8474
|
"default": "false"
|
|
8125
8475
|
}
|
|
@@ -8142,7 +8492,7 @@
|
|
|
8142
8492
|
},
|
|
8143
8493
|
{
|
|
8144
8494
|
"name": "apiVersion",
|
|
8145
|
-
"attribute": "
|
|
8495
|
+
"attribute": "apiVersion",
|
|
8146
8496
|
"type": "string"
|
|
8147
8497
|
},
|
|
8148
8498
|
{
|
|
@@ -8250,7 +8600,7 @@
|
|
|
8250
8600
|
},
|
|
8251
8601
|
{
|
|
8252
8602
|
"name": "hasCustomBehaviour",
|
|
8253
|
-
"attribute": "
|
|
8603
|
+
"attribute": "hasCustomBehaviour",
|
|
8254
8604
|
"type": "boolean",
|
|
8255
8605
|
"default": "false"
|
|
8256
8606
|
}
|
|
@@ -8285,7 +8635,7 @@
|
|
|
8285
8635
|
"description": "represents an odd parameter element for editing",
|
|
8286
8636
|
"attributes": [
|
|
8287
8637
|
{
|
|
8288
|
-
"name": "
|
|
8638
|
+
"name": "apiVersion",
|
|
8289
8639
|
"type": "string"
|
|
8290
8640
|
},
|
|
8291
8641
|
{
|
|
@@ -8324,7 +8674,7 @@
|
|
|
8324
8674
|
"properties": [
|
|
8325
8675
|
{
|
|
8326
8676
|
"name": "apiVersion",
|
|
8327
|
-
"attribute": "
|
|
8677
|
+
"attribute": "apiVersion",
|
|
8328
8678
|
"type": "string"
|
|
8329
8679
|
},
|
|
8330
8680
|
{
|
|
@@ -8405,8 +8755,7 @@
|
|
|
8405
8755
|
},
|
|
8406
8756
|
{
|
|
8407
8757
|
"name": "scope",
|
|
8408
|
-
"type": "string"
|
|
8409
|
-
"default": "\"\""
|
|
8758
|
+
"type": "string"
|
|
8410
8759
|
},
|
|
8411
8760
|
{
|
|
8412
8761
|
"name": "selected",
|
|
@@ -8430,8 +8779,7 @@
|
|
|
8430
8779
|
{
|
|
8431
8780
|
"name": "scope",
|
|
8432
8781
|
"attribute": "scope",
|
|
8433
|
-
"type": "string"
|
|
8434
|
-
"default": "\"\""
|
|
8782
|
+
"type": "string"
|
|
8435
8783
|
},
|
|
8436
8784
|
{
|
|
8437
8785
|
"name": "selected",
|
|
@@ -8469,7 +8817,7 @@
|
|
|
8469
8817
|
},
|
|
8470
8818
|
{
|
|
8471
8819
|
"name": "locales",
|
|
8472
|
-
"description": "Optional URL pointing to a directory from which additional i18n
|
|
8820
|
+
"description": "Optional URL pointing to a directory from which additional i18n\nlanguage files will be loaded. The URL should contain placeholders\nfor the language (`lng`) and the namespace (`ns`), e.g.\n\n`resources/i18n/{{ns}}_{{lng}}.json`\n\nor\n\n`resources/i18n/{{ns}}/{{lng}}.json`\n\nThe latter assumes custom language files in a subdirectory, the first\nexpects the namespace to be specified at the start of the file name.\n\nThe default namespace for custom language files is assumed to be `app`,\nbut you can define additional namespaces via `localeFallbackNS`.",
|
|
8473
8821
|
"type": "string"
|
|
8474
8822
|
},
|
|
8475
8823
|
{
|
|
@@ -8496,7 +8844,7 @@
|
|
|
8496
8844
|
},
|
|
8497
8845
|
{
|
|
8498
8846
|
"name": "url-template",
|
|
8499
|
-
"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
|
|
8847
|
+
"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.",
|
|
8500
8848
|
"type": "string"
|
|
8501
8849
|
},
|
|
8502
8850
|
{
|
|
@@ -8523,7 +8871,7 @@
|
|
|
8523
8871
|
},
|
|
8524
8872
|
{
|
|
8525
8873
|
"name": "require-language",
|
|
8526
|
-
"description": "If set, the element will wait for a language being set by i18n before\nit sends a `pb-page-ready` event. Elements like `pb-view` will wait\nfor this event before displaying content.\n\nAlso, `pb-view` will pass the configured language to the server endpoint\nwhere it will be available to ODD processing models in variable
|
|
8874
|
+
"description": "If set, the element will wait for a language being set by i18n before\nit sends a `pb-page-ready` event. Elements like `pb-view` will wait\nfor this event before displaying content.\n\nAlso, `pb-view` will pass the configured language to the server endpoint\nwhere it will be available to ODD processing models in variable\n`$parameters?language` and can thus be used to change output depending on\nthe user interface language.\n\nIf you would like `pb-view` to refresh automatically whenever the language\nsetting changes, specify property `useLanguage` on the corresponding `pb-view`.",
|
|
8527
8875
|
"type": "boolean",
|
|
8528
8876
|
"default": "false"
|
|
8529
8877
|
},
|
|
@@ -8590,7 +8938,7 @@
|
|
|
8590
8938
|
{
|
|
8591
8939
|
"name": "locales",
|
|
8592
8940
|
"attribute": "locales",
|
|
8593
|
-
"description": "Optional URL pointing to a directory from which additional i18n
|
|
8941
|
+
"description": "Optional URL pointing to a directory from which additional i18n\nlanguage files will be loaded. The URL should contain placeholders\nfor the language (`lng`) and the namespace (`ns`), e.g.\n\n`resources/i18n/{{ns}}_{{lng}}.json`\n\nor\n\n`resources/i18n/{{ns}}/{{lng}}.json`\n\nThe latter assumes custom language files in a subdirectory, the first\nexpects the namespace to be specified at the start of the file name.\n\nThe default namespace for custom language files is assumed to be `app`,\nbut you can define additional namespaces via `localeFallbackNS`.",
|
|
8594
8942
|
"type": "string"
|
|
8595
8943
|
},
|
|
8596
8944
|
{
|
|
@@ -8626,7 +8974,7 @@
|
|
|
8626
8974
|
{
|
|
8627
8975
|
"name": "urlTemplate",
|
|
8628
8976
|
"attribute": "url-template",
|
|
8629
|
-
"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
|
|
8977
|
+
"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.",
|
|
8630
8978
|
"type": "string"
|
|
8631
8979
|
},
|
|
8632
8980
|
{
|
|
@@ -8658,7 +9006,7 @@
|
|
|
8658
9006
|
{
|
|
8659
9007
|
"name": "requireLanguage",
|
|
8660
9008
|
"attribute": "require-language",
|
|
8661
|
-
"description": "If set, the element will wait for a language being set by i18n before\nit sends a `pb-page-ready` event. Elements like `pb-view` will wait\nfor this event before displaying content.\n\nAlso, `pb-view` will pass the configured language to the server endpoint\nwhere it will be available to ODD processing models in variable
|
|
9009
|
+
"description": "If set, the element will wait for a language being set by i18n before\nit sends a `pb-page-ready` event. Elements like `pb-view` will wait\nfor this event before displaying content.\n\nAlso, `pb-view` will pass the configured language to the server endpoint\nwhere it will be available to ODD processing models in variable\n`$parameters?language` and can thus be used to change output depending on\nthe user interface language.\n\nIf you would like `pb-view` to refresh automatically whenever the language\nsetting changes, specify property `useLanguage` on the corresponding `pb-view`.",
|
|
8662
9010
|
"type": "boolean",
|
|
8663
9011
|
"default": "false"
|
|
8664
9012
|
},
|
|
@@ -8751,6 +9099,11 @@
|
|
|
8751
9099
|
"path": "./src/pb-paginate.js",
|
|
8752
9100
|
"description": "Display a pagination control from which the user can select a page to view\nfrom a multi-page collection of resources. To determine the number of pages,\n`pb-paginate` listens for the `pb-results-received` event emitted by `pb-load`.\nIf the user clicks on one of the page indicators, a `pb-load` event is emitted,\nwhich should cause the connected `pb-load` element to refresh.",
|
|
8753
9101
|
"attributes": [
|
|
9102
|
+
{
|
|
9103
|
+
"name": "show-previous-next",
|
|
9104
|
+
"description": "show or hide (i.e. generate) previous and next buttons,\ndefault value is false, controls are not generated",
|
|
9105
|
+
"type": "boolean"
|
|
9106
|
+
},
|
|
8754
9107
|
{
|
|
8755
9108
|
"name": "total",
|
|
8756
9109
|
"description": "total number of pages",
|
|
@@ -8777,13 +9130,13 @@
|
|
|
8777
9130
|
},
|
|
8778
9131
|
{
|
|
8779
9132
|
"name": "page-count",
|
|
8780
|
-
"description": "the amount of pages",
|
|
9133
|
+
"description": "the amount of pages needed for all items,\ncalculated from total / perPage",
|
|
8781
9134
|
"type": "number",
|
|
8782
9135
|
"default": "10"
|
|
8783
9136
|
},
|
|
8784
9137
|
{
|
|
8785
9138
|
"name": "range",
|
|
8786
|
-
"description": "
|
|
9139
|
+
"description": "the amount of page numbers shown within the component",
|
|
8787
9140
|
"type": "number",
|
|
8788
9141
|
"default": "5"
|
|
8789
9142
|
},
|
|
@@ -8832,6 +9185,12 @@
|
|
|
8832
9185
|
}
|
|
8833
9186
|
],
|
|
8834
9187
|
"properties": [
|
|
9188
|
+
{
|
|
9189
|
+
"name": "showPreviousNext",
|
|
9190
|
+
"attribute": "show-previous-next",
|
|
9191
|
+
"description": "show or hide (i.e. generate) previous and next buttons,\ndefault value is false, controls are not generated",
|
|
9192
|
+
"type": "boolean"
|
|
9193
|
+
},
|
|
8835
9194
|
{
|
|
8836
9195
|
"name": "total",
|
|
8837
9196
|
"attribute": "total",
|
|
@@ -8863,14 +9222,14 @@
|
|
|
8863
9222
|
{
|
|
8864
9223
|
"name": "pageCount",
|
|
8865
9224
|
"attribute": "page-count",
|
|
8866
|
-
"description": "the amount of pages",
|
|
9225
|
+
"description": "the amount of pages needed for all items,\ncalculated from total / perPage",
|
|
8867
9226
|
"type": "number",
|
|
8868
9227
|
"default": "10"
|
|
8869
9228
|
},
|
|
8870
9229
|
{
|
|
8871
9230
|
"name": "range",
|
|
8872
9231
|
"attribute": "range",
|
|
8873
|
-
"description": "
|
|
9232
|
+
"description": "the amount of page numbers shown within the component",
|
|
8874
9233
|
"type": "number",
|
|
8875
9234
|
"default": "5"
|
|
8876
9235
|
},
|
|
@@ -9111,7 +9470,7 @@
|
|
|
9111
9470
|
{
|
|
9112
9471
|
"name": "pb-popover",
|
|
9113
9472
|
"path": "./src/pb-popover.js",
|
|
9114
|
-
"description": "Show a popover. It may either
|
|
9473
|
+
"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.",
|
|
9115
9474
|
"attributes": [
|
|
9116
9475
|
{
|
|
9117
9476
|
"name": "remote",
|
|
@@ -9495,7 +9854,7 @@
|
|
|
9495
9854
|
{
|
|
9496
9855
|
"name": "pb-progress",
|
|
9497
9856
|
"path": "./src/pb-progress.js",
|
|
9498
|
-
"description": "A progress bar which becomes active when signal `pb-start-update` is\nbeing sent and is deactivated on `pb-end-update
|
|
9857
|
+
"description": "A progress bar which becomes active when signal `pb-start-update` is\nbeing sent and is deactivated on `pb-end-update`.\n\nUses a native `<progress>` element.",
|
|
9499
9858
|
"attributes": [
|
|
9500
9859
|
{
|
|
9501
9860
|
"name": "subscribe",
|
|
@@ -10034,7 +10393,7 @@
|
|
|
10034
10393
|
{
|
|
10035
10394
|
"name": "pb-select-feature",
|
|
10036
10395
|
"path": "./src/pb-select-feature.js",
|
|
10037
|
-
"description": "Similar to `pb-toggle-feature` but allows you to choose from a list of defined states instead of a simple\non/off toggle. Like `pb-toggle-feature` it can change state server-side as well as client-side
|
|
10396
|
+
"description": "Similar to `pb-toggle-feature` but allows you to choose from a list of defined states instead of a simple\non/off toggle. Like `pb-toggle-feature` it can change state server-side as well as client-side.\n\nThe list of states is passed as a JSON array to property `items`:\n\n# Server-side\n\nProperties to be passed to the server are specified as follows:\n\n```javascript\n[\n {\"name\": \"Diplomatic View\", \"properties\": {\"mode\": \"diplomatic\", \"view\": \"page\"}},\n {\"name\": \"Normalized View\", \"properties\": {\"mode\": \"norm\", \"view\": \"single\"}}\n]\n```\n\nIf the `name` property references the path to a translated label, the translation will be used instead.\n# Client-side\n\n```javascript\n[\n {\"name\": \"Diplomatic View\", \"selectors\": [{\"selector\": \".choice,.choice-alternate,br\", \"state\": false},{\"selector\": \".tei-foreign,pb-highlight,pb-popover\", \"command\": \"disable\"}]},\n {\"name\": \"Normalized View\", \"selectors\": [{\"selector\": \".choice,.choice-alternate,br\", \"state\": true},{\"selector\": \".tei-foreign,pb-highlight,pb-popover\", \"command\": \"disable\"}]},\n {\"name\": \"Plain Reading View\", \"selectors\": [{\"selector\": \".choice,.choice-alternate,br\", \"state\": true}, {\"selector\": \".tei-foreign,pb-highlight,pb-popover\", \"command\": \"disable\", \"state\": true}]}\n]\n```\n\nEach item in the `selectors` property above defines either a state or a command. *state* will simply add\na css class `.toggle` to the target element when true. If *command* is set to 'disable', it will entirely disable\nthe functionality of selected elements - provided that they are\npublisher components implementing the corresponding `command` method of `pb-mixin`.\n\nClient-side you may also pass an optional property `\"global\": true` to toggle the state of elements which reside\nin the surrounding HTML context below `pb-page` (means: elements which are not inside a `pb-view` or `pb-load`).",
|
|
10038
10397
|
"attributes": [
|
|
10039
10398
|
{
|
|
10040
10399
|
"name": "name",
|
|
@@ -10315,6 +10674,11 @@
|
|
|
10315
10674
|
"type": "string",
|
|
10316
10675
|
"default": "\"document.selectTemplate\""
|
|
10317
10676
|
},
|
|
10677
|
+
{
|
|
10678
|
+
"name": "name",
|
|
10679
|
+
"type": "string",
|
|
10680
|
+
"default": "\"\""
|
|
10681
|
+
},
|
|
10318
10682
|
{
|
|
10319
10683
|
"name": "subscribe",
|
|
10320
10684
|
"description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
|
|
@@ -10361,6 +10725,12 @@
|
|
|
10361
10725
|
"type": "string",
|
|
10362
10726
|
"default": "\"document.selectTemplate\""
|
|
10363
10727
|
},
|
|
10728
|
+
{
|
|
10729
|
+
"name": "name",
|
|
10730
|
+
"attribute": "name",
|
|
10731
|
+
"type": "string",
|
|
10732
|
+
"default": "\"\""
|
|
10733
|
+
},
|
|
10364
10734
|
{
|
|
10365
10735
|
"name": "subscribe",
|
|
10366
10736
|
"attribute": "subscribe",
|
|
@@ -10567,7 +10937,7 @@
|
|
|
10567
10937
|
{
|
|
10568
10938
|
"name": "pb-split-list",
|
|
10569
10939
|
"path": "./src/pb-split-list.js",
|
|
10570
|
-
"description": "Implements a list which is split into different categories
|
|
10940
|
+
"description": "Implements a list which is split into different categories\n(e.g. letters of the alphabet, countries ...).\nOnly one category is shown at a time unless the server reports\nno categories (e.g. if the number of items to display goes below\na defined threshold).\n\nThe server-side API endpoint should return a JSON object with two\nproperties:\n\n+ `categories`: an array of category descriptions: each item should\n be an object with two properties: `category` - containing the name of the category\n and `count` - containing a count of items available under this category.\n+ `items`: an array with the items to be shown for the currently selected\n category. Those may contain HTML markup.\n\nSample JSON object for pb-split-list\n```javascript\n{\n \"items\": [\n \"<span><a href='Abegg-Arter Carl?category=A&view=correspondents&search='>Abegg-Arter, Carl</a><span class='dates'> (1836–1912)</span></span>\",\n \"<span><a href='Abegg Hans Heinrich?category=A&view=correspondents&search='>Abegg, Hans Heinrich</a><span class='dates'> (1805–1874)</span></span>\",\n \"<span><a href='Abegg Jakob?category=A&view=correspondents&search='>Abegg, Jakob</a><span class='dates'> (1801–1871)</span></span>\",\n \"<span><a href='Abys Raget?category=A&view=correspondents&search='>Abys, Raget</a><span class='dates'> (1790–1861)</span></span>\",\n \"<span><a href='Aebli Johann Peter?category=A&view=correspondents&search='>Aebli, Johann Peter</a><span class='dates'> (1804–1879)</span></span>\",\n \"<span><a href='Aepli Arnold Otto?category=A&view=correspondents&search='>Aepli, Arnold Otto</a><span class='dates'> (1816–1897)</span></span>\",\n ...\n ],\n \"categories\": [\n {\n \"category\": \"A\",\n \"count\": 22\n },\n {\n \"category\": \"B\",\n \"count\": 77\n },\n {\n \"category\": \"C\",\n \"count\": 19\n },\n ...\n ]\n}\n```\n\nSample Usage\n```xml\n<pb-split-list url=\"api/people\" subforms=\"#options\" selected=\"A\" emit=\"transcription\" subscribe=\"transcription\"></pb-split-list>\n```\nSee https://www.briefedition.alfred-escher.ch/kontexte/personen/?category=A&search=&view=correspondents for a running sample. The source code of the webpage is here: https://github.com/stazh/briefedition-escher. Relevant files are:\n- [templates/index.html](https://github.com/stazh/briefedition-escher/blob/master/templates/index.html#L223) - usage of pb-timeline\n- [modules/custom-api.json](https://github.com/stazh/briefedition-escher/blob/master/modules/custom-api.json#L1098) - `/api/people` endpoint delivering required JSON object",
|
|
10571
10941
|
"attributes": [
|
|
10572
10942
|
{
|
|
10573
10943
|
"name": "url",
|
|
@@ -11106,7 +11476,7 @@
|
|
|
11106
11476
|
"events": [
|
|
11107
11477
|
{
|
|
11108
11478
|
"name": "pb-tab",
|
|
11109
|
-
"description": "fired if selected tab changes. Details contain number of
|
|
11479
|
+
"description": "fired if selected tab changes. Details contain number of\nselected tab in propery `selected`."
|
|
11110
11480
|
}
|
|
11111
11481
|
],
|
|
11112
11482
|
"slots": [
|
|
@@ -11136,6 +11506,23 @@
|
|
|
11136
11506
|
"description": "URL pointing to a IIIF presentation manifest. Relative paths\nare interpreted relative to the API endpoint.",
|
|
11137
11507
|
"type": "string"
|
|
11138
11508
|
},
|
|
11509
|
+
{
|
|
11510
|
+
"name": "initial-view",
|
|
11511
|
+
"description": "The initial view to display. Can be 'toc' (table of contents),\n'thumbnails', 'text', 'info', 'help', 'export', or null for media only.\nDefaults to null (media view only).",
|
|
11512
|
+
"type": "string"
|
|
11513
|
+
},
|
|
11514
|
+
{
|
|
11515
|
+
"name": "enable-navigation",
|
|
11516
|
+
"description": "If true, pb-tify will respond to pb-navigate events to synchronize\nwith navigation buttons. Defaults to true.",
|
|
11517
|
+
"type": "boolean",
|
|
11518
|
+
"default": "true"
|
|
11519
|
+
},
|
|
11520
|
+
{
|
|
11521
|
+
"name": "disable-history",
|
|
11522
|
+
"description": "If set, do not update browser history when navigating.\nDefaults to false (history is enabled).",
|
|
11523
|
+
"type": "boolean",
|
|
11524
|
+
"default": "false"
|
|
11525
|
+
},
|
|
11139
11526
|
{
|
|
11140
11527
|
"name": "subscribe",
|
|
11141
11528
|
"description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
|
|
@@ -11175,11 +11562,31 @@
|
|
|
11175
11562
|
"description": "URL pointing to a IIIF presentation manifest. Relative paths\nare interpreted relative to the API endpoint.",
|
|
11176
11563
|
"type": "string"
|
|
11177
11564
|
},
|
|
11565
|
+
{
|
|
11566
|
+
"name": "initialView",
|
|
11567
|
+
"attribute": "initial-view",
|
|
11568
|
+
"description": "The initial view to display. Can be 'toc' (table of contents),\n'thumbnails', 'text', 'info', 'help', 'export', or null for media only.\nDefaults to null (media view only).",
|
|
11569
|
+
"type": "string"
|
|
11570
|
+
},
|
|
11178
11571
|
{
|
|
11179
11572
|
"name": "cssPath",
|
|
11180
11573
|
"type": "string",
|
|
11181
11574
|
"default": "\"../css/tify\""
|
|
11182
11575
|
},
|
|
11576
|
+
{
|
|
11577
|
+
"name": "enableNavigation",
|
|
11578
|
+
"attribute": "enable-navigation",
|
|
11579
|
+
"description": "If true, pb-tify will respond to pb-navigate events to synchronize\nwith navigation buttons. Defaults to true.",
|
|
11580
|
+
"type": "boolean",
|
|
11581
|
+
"default": "true"
|
|
11582
|
+
},
|
|
11583
|
+
{
|
|
11584
|
+
"name": "disableHistory",
|
|
11585
|
+
"attribute": "disable-history",
|
|
11586
|
+
"description": "If set, do not update browser history when navigating.\nDefaults to false (history is enabled).",
|
|
11587
|
+
"type": "boolean",
|
|
11588
|
+
"default": "false"
|
|
11589
|
+
},
|
|
11183
11590
|
{
|
|
11184
11591
|
"name": "subscribe",
|
|
11185
11592
|
"attribute": "subscribe",
|
|
@@ -11232,7 +11639,7 @@
|
|
|
11232
11639
|
{
|
|
11233
11640
|
"name": "pb-timeline",
|
|
11234
11641
|
"path": "./src/pb-timeline.js",
|
|
11235
|
-
"description": "A timeline component to display time series data in a bar chart like view.\n\nTime series data can be displayed in one of 6 different scales:\n\n- by decade (10Y)\n- by 5 years (5Y)\n- by years (Y)\n- by month (M)\n- by week (W)\n- by day (D)\n\nThe endpoint is expected to return a JSON object. Each property should either be a date or the special\nmarker `?`, which indicates undated resources.\nThe value associated with each entry\nshould either correspond to a count of resources or an object with properties `count` and `info
|
|
11642
|
+
"description": "A timeline component to display time series data in a bar chart like view.\n\nTime series data can be displayed in one of 6 different scales:\n\n- by decade (10Y)\n- by 5 years (5Y)\n- by years (Y)\n- by month (M)\n- by week (W)\n- by day (D)\n\nThe endpoint is expected to return a JSON object. Each property should either be a date or the special\nmarker `?`, which indicates undated resources.\nThe value associated with each entry\nshould either correspond to a count of resources or an object with properties `count` and `info`.\n`info` should be an array, containing HTML to be shown in a list within the tooltips.\nExpected JSON:\n```javascript\n{\n \"1852-01-14\": {\n \"count\": 1,\n \"info\": [\n \"<a href='/briefe/B0977' part='tooltip-link'>Alfred Escher an Joseph Wolfgang von Deschwanden, Belvoir (Enge, Zürich), Mittwoch, 14. Januar 1852</a>\"\n ]\n },\n\"1874-01-25\": {\n \"count\": 3,\n \"info\": [\n \"<a href='/briefe/B8140' part='tooltip-link'>Alfred Escher an Gustav von Mevissen, Zürich, Sonntag, 25. Januar 1874</a>\",\n \"<a href='/briefe/B8139' part='tooltip-link'>Alfred Escher an Theodor Weishaupt, Zürich, Sonntag, 25. Januar 1874</a>\",\n \"<a href='/briefe/B8143' part='tooltip-link'>Alfred Escher an Ludwig August Parcus, Zürich, Sonntag, 25. Januar 1874</a>\"\n ]\n }\n}\n```\nSample Usage:\n```xml\n<pb-timeline url=\"api/timeline\" scopes=\"['D', 'M', 'Y', '5Y', '10Y']\"\n resettable=\"\"\n subscribe=\"docs\" emit=\"timeline\">\n <span slot=\"label\">Angezeigter Zeitraum: </span>\n</pb-timeline>\n```\nSee https://www.briefedition.alfred-escher.ch/briefe/ for a running sample. The source code of the webpage is here: https://github.com/stazh/briefedition-escher. Relevant files are:\n- [templates/people.html](https://github.com/stazh/briefedition-escher/blob/master/templates/people.html#L91) - usage of pb-timeline\n- [modules/custom-api.json](https://github.com/stazh/briefedition-escher/blob/master/modules/custom-api.json#L1080) - `/api/timeline` endpoint delivering required JSON object",
|
|
11236
11643
|
"attributes": [
|
|
11237
11644
|
{
|
|
11238
11645
|
"name": "start-date",
|
|
@@ -11474,6 +11881,12 @@
|
|
|
11474
11881
|
},
|
|
11475
11882
|
{
|
|
11476
11883
|
"name": "--pb-timeline-tooltip-font-size"
|
|
11884
|
+
},
|
|
11885
|
+
{
|
|
11886
|
+
"name": "--pb-timeline-tooltip-min-width"
|
|
11887
|
+
},
|
|
11888
|
+
{
|
|
11889
|
+
"name": "--pb-timeline-tooltip-max-width"
|
|
11477
11890
|
}
|
|
11478
11891
|
],
|
|
11479
11892
|
"cssParts": [
|
|
@@ -11500,7 +11913,7 @@
|
|
|
11500
11913
|
},
|
|
11501
11914
|
{
|
|
11502
11915
|
"name": "selector",
|
|
11503
|
-
"description": "(optional) CSS selector: selects the elements to toggle client side (sets or unsets a
|
|
11916
|
+
"description": "(optional) CSS selector: selects the elements to toggle client side (sets or unsets a\nCSS class `.toggled`). Setting this property will not trigger a reload as everything is\nhandled by javascript.",
|
|
11504
11917
|
"type": "string"
|
|
11505
11918
|
},
|
|
11506
11919
|
{
|
|
@@ -11551,7 +11964,7 @@
|
|
|
11551
11964
|
},
|
|
11552
11965
|
{
|
|
11553
11966
|
"name": "global",
|
|
11554
|
-
"description": "If set, toggle the state of elements which reside\nin the surrounding HTML context below `pb-page
|
|
11967
|
+
"description": "If set, toggle the state of elements which reside\nin the surrounding HTML context below `pb-page`\n(means: elements which are not inside a `pb-view` or `pb-load`).",
|
|
11555
11968
|
"type": "boolean",
|
|
11556
11969
|
"default": "false"
|
|
11557
11970
|
},
|
|
@@ -11597,7 +12010,7 @@
|
|
|
11597
12010
|
{
|
|
11598
12011
|
"name": "selector",
|
|
11599
12012
|
"attribute": "selector",
|
|
11600
|
-
"description": "(optional) CSS selector: selects the elements to toggle client side (sets or unsets a
|
|
12013
|
+
"description": "(optional) CSS selector: selects the elements to toggle client side (sets or unsets a\nCSS class `.toggled`). Setting this property will not trigger a reload as everything is\nhandled by javascript.",
|
|
11601
12014
|
"type": "string"
|
|
11602
12015
|
},
|
|
11603
12016
|
{
|
|
@@ -11657,7 +12070,7 @@
|
|
|
11657
12070
|
{
|
|
11658
12071
|
"name": "global",
|
|
11659
12072
|
"attribute": "global",
|
|
11660
|
-
"description": "If set, toggle the state of elements which reside\nin the surrounding HTML context below `pb-page
|
|
12073
|
+
"description": "If set, toggle the state of elements which reside\nin the surrounding HTML context below `pb-page`\n(means: elements which are not inside a `pb-view` or `pb-load`).",
|
|
11661
12074
|
"type": "boolean",
|
|
11662
12075
|
"default": "false"
|
|
11663
12076
|
},
|
|
@@ -11910,6 +12323,11 @@
|
|
|
11910
12323
|
"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",
|
|
11911
12324
|
"type": "string"
|
|
11912
12325
|
},
|
|
12326
|
+
{
|
|
12327
|
+
"name": "fill",
|
|
12328
|
+
"description": "Controls the pagination-by-div algorithm: if a page would have less than\n`fill` elements, it tries to fill\nup the page by pulling following divs in. When set to 0, it will never\nattempt to fill up the page. For the annotation editor this should\nalways be 0.",
|
|
12329
|
+
"type": "number"
|
|
12330
|
+
},
|
|
11913
12331
|
{
|
|
11914
12332
|
"name": "node-id",
|
|
11915
12333
|
"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.",
|
|
@@ -11965,6 +12383,12 @@
|
|
|
11965
12383
|
"description": "The relative URL to the script on the server which will be called for loading content.",
|
|
11966
12384
|
"type": "string"
|
|
11967
12385
|
},
|
|
12386
|
+
{
|
|
12387
|
+
"name": "read-only-registry",
|
|
12388
|
+
"description": "If set to true, pb-view will only read from the registry and never write to it.\nThis is useful when pb-view is used as a simple receiver of navigation updates\nfrom other components (e.g., pb-tify). When enabled, pb-view will:\n- Still subscribe to registry changes\n- Still read from registry to determine what to display\n- Never call registry.replace or registry.commit after initial connection\n\nThis prevents pb-view from resetting the registry with stale state during navigation,\nwhich can cause bounce-back issues when used with components like pb-tify.\n\nDefault is false (pb-view can write to registry as before).",
|
|
12389
|
+
"type": "boolean",
|
|
12390
|
+
"default": "false"
|
|
12391
|
+
},
|
|
11968
12392
|
{
|
|
11969
12393
|
"name": "on-update",
|
|
11970
12394
|
"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'.",
|
|
@@ -12019,7 +12443,7 @@
|
|
|
12019
12443
|
},
|
|
12020
12444
|
{
|
|
12021
12445
|
"name": "no-scroll",
|
|
12022
|
-
"description": "If set, do not scroll the view to target node (e.g. given in URL hash)
|
|
12446
|
+
"description": "If set, do not scroll the view to target node (e.g. given in URL hash)\nafter content was loaded.",
|
|
12023
12447
|
"type": "boolean",
|
|
12024
12448
|
"default": "false"
|
|
12025
12449
|
},
|
|
@@ -12050,7 +12474,7 @@
|
|
|
12050
12474
|
},
|
|
12051
12475
|
{
|
|
12052
12476
|
"name": "wait-for",
|
|
12053
|
-
"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
|
|
12477
|
+
"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.",
|
|
12054
12478
|
"type": "string"
|
|
12055
12479
|
},
|
|
12056
12480
|
{
|
|
@@ -12098,6 +12522,12 @@
|
|
|
12098
12522
|
"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",
|
|
12099
12523
|
"type": "string"
|
|
12100
12524
|
},
|
|
12525
|
+
{
|
|
12526
|
+
"name": "fill",
|
|
12527
|
+
"attribute": "fill",
|
|
12528
|
+
"description": "Controls the pagination-by-div algorithm: if a page would have less than\n`fill` elements, it tries to fill\nup the page by pulling following divs in. When set to 0, it will never\nattempt to fill up the page. For the annotation editor this should\nalways be 0.",
|
|
12529
|
+
"type": "number"
|
|
12530
|
+
},
|
|
12101
12531
|
{
|
|
12102
12532
|
"name": "nodeId",
|
|
12103
12533
|
"attribute": "node-id",
|
|
@@ -12164,6 +12594,13 @@
|
|
|
12164
12594
|
"description": "The relative URL to the script on the server which will be called for loading content.",
|
|
12165
12595
|
"type": "string"
|
|
12166
12596
|
},
|
|
12597
|
+
{
|
|
12598
|
+
"name": "readOnlyRegistry",
|
|
12599
|
+
"attribute": "read-only-registry",
|
|
12600
|
+
"description": "If set to true, pb-view will only read from the registry and never write to it.\nThis is useful when pb-view is used as a simple receiver of navigation updates\nfrom other components (e.g., pb-tify). When enabled, pb-view will:\n- Still subscribe to registry changes\n- Still read from registry to determine what to display\n- Never call registry.replace or registry.commit after initial connection\n\nThis prevents pb-view from resetting the registry with stale state during navigation,\nwhich can cause bounce-back issues when used with components like pb-tify.\n\nDefault is false (pb-view can write to registry as before).",
|
|
12601
|
+
"type": "boolean",
|
|
12602
|
+
"default": "false"
|
|
12603
|
+
},
|
|
12167
12604
|
{
|
|
12168
12605
|
"name": "onUpdate",
|
|
12169
12606
|
"attribute": "on-update",
|
|
@@ -12233,7 +12670,7 @@
|
|
|
12233
12670
|
{
|
|
12234
12671
|
"name": "noScroll",
|
|
12235
12672
|
"attribute": "no-scroll",
|
|
12236
|
-
"description": "If set, do not scroll the view to target node (e.g. given in URL hash)
|
|
12673
|
+
"description": "If set, do not scroll the view to target node (e.g. given in URL hash)\nafter content was loaded.",
|
|
12237
12674
|
"type": "boolean",
|
|
12238
12675
|
"default": "false"
|
|
12239
12676
|
},
|
|
@@ -12270,7 +12707,7 @@
|
|
|
12270
12707
|
{
|
|
12271
12708
|
"name": "waitFor",
|
|
12272
12709
|
"attribute": "wait-for",
|
|
12273
|
-
"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
|
|
12710
|
+
"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.",
|
|
12274
12711
|
"type": "string"
|
|
12275
12712
|
},
|
|
12276
12713
|
{
|
|
@@ -12322,10 +12759,6 @@
|
|
|
12322
12759
|
"name": "pb-navigate",
|
|
12323
12760
|
"description": "When received, navigate forward or backward in the document"
|
|
12324
12761
|
},
|
|
12325
|
-
{
|
|
12326
|
-
"name": "pb-zoom",
|
|
12327
|
-
"description": "When received, zoom in or out by changing font size of the content"
|
|
12328
|
-
},
|
|
12329
12762
|
{
|
|
12330
12763
|
"name": "pb-refresh",
|
|
12331
12764
|
"description": "When received, refresh the content based on the parameters passed in the event"
|
|
@@ -12407,6 +12840,11 @@
|
|
|
12407
12840
|
"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",
|
|
12408
12841
|
"type": "string"
|
|
12409
12842
|
},
|
|
12843
|
+
{
|
|
12844
|
+
"name": "fill",
|
|
12845
|
+
"description": "Controls the pagination-by-div algorithm: if a page would have less than\n`fill` elements, it tries to fill\nup the page by pulling following divs in. When set to 0, it will never\nattempt to fill up the page. For the annotation editor this should\nalways be 0.",
|
|
12846
|
+
"type": "number"
|
|
12847
|
+
},
|
|
12410
12848
|
{
|
|
12411
12849
|
"name": "node-id",
|
|
12412
12850
|
"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.",
|
|
@@ -12462,6 +12900,12 @@
|
|
|
12462
12900
|
"description": "The relative URL to the script on the server which will be called for loading content.",
|
|
12463
12901
|
"type": "string"
|
|
12464
12902
|
},
|
|
12903
|
+
{
|
|
12904
|
+
"name": "read-only-registry",
|
|
12905
|
+
"description": "If set to true, pb-view will only read from the registry and never write to it.\nThis is useful when pb-view is used as a simple receiver of navigation updates\nfrom other components (e.g., pb-tify). When enabled, pb-view will:\n- Still subscribe to registry changes\n- Still read from registry to determine what to display\n- Never call registry.replace or registry.commit after initial connection\n\nThis prevents pb-view from resetting the registry with stale state during navigation,\nwhich can cause bounce-back issues when used with components like pb-tify.\n\nDefault is false (pb-view can write to registry as before).",
|
|
12906
|
+
"type": "boolean",
|
|
12907
|
+
"default": "false"
|
|
12908
|
+
},
|
|
12465
12909
|
{
|
|
12466
12910
|
"name": "on-update",
|
|
12467
12911
|
"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'.",
|
|
@@ -12516,7 +12960,7 @@
|
|
|
12516
12960
|
},
|
|
12517
12961
|
{
|
|
12518
12962
|
"name": "no-scroll",
|
|
12519
|
-
"description": "If set, do not scroll the view to target node (e.g. given in URL hash)
|
|
12963
|
+
"description": "If set, do not scroll the view to target node (e.g. given in URL hash)\nafter content was loaded.",
|
|
12520
12964
|
"type": "boolean",
|
|
12521
12965
|
"default": "false"
|
|
12522
12966
|
},
|
|
@@ -12547,7 +12991,7 @@
|
|
|
12547
12991
|
},
|
|
12548
12992
|
{
|
|
12549
12993
|
"name": "wait-for",
|
|
12550
|
-
"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
|
|
12994
|
+
"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.",
|
|
12551
12995
|
"type": "string"
|
|
12552
12996
|
},
|
|
12553
12997
|
{
|
|
@@ -12570,6 +13014,12 @@
|
|
|
12570
13014
|
"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",
|
|
12571
13015
|
"type": "string"
|
|
12572
13016
|
},
|
|
13017
|
+
{
|
|
13018
|
+
"name": "fill",
|
|
13019
|
+
"attribute": "fill",
|
|
13020
|
+
"description": "Controls the pagination-by-div algorithm: if a page would have less than\n`fill` elements, it tries to fill\nup the page by pulling following divs in. When set to 0, it will never\nattempt to fill up the page. For the annotation editor this should\nalways be 0.",
|
|
13021
|
+
"type": "number"
|
|
13022
|
+
},
|
|
12573
13023
|
{
|
|
12574
13024
|
"name": "nodeId",
|
|
12575
13025
|
"attribute": "node-id",
|
|
@@ -12636,6 +13086,13 @@
|
|
|
12636
13086
|
"description": "The relative URL to the script on the server which will be called for loading content.",
|
|
12637
13087
|
"type": "string"
|
|
12638
13088
|
},
|
|
13089
|
+
{
|
|
13090
|
+
"name": "readOnlyRegistry",
|
|
13091
|
+
"attribute": "read-only-registry",
|
|
13092
|
+
"description": "If set to true, pb-view will only read from the registry and never write to it.\nThis is useful when pb-view is used as a simple receiver of navigation updates\nfrom other components (e.g., pb-tify). When enabled, pb-view will:\n- Still subscribe to registry changes\n- Still read from registry to determine what to display\n- Never call registry.replace or registry.commit after initial connection\n\nThis prevents pb-view from resetting the registry with stale state during navigation,\nwhich can cause bounce-back issues when used with components like pb-tify.\n\nDefault is false (pb-view can write to registry as before).",
|
|
13093
|
+
"type": "boolean",
|
|
13094
|
+
"default": "false"
|
|
13095
|
+
},
|
|
12639
13096
|
{
|
|
12640
13097
|
"name": "onUpdate",
|
|
12641
13098
|
"attribute": "on-update",
|
|
@@ -12705,7 +13162,7 @@
|
|
|
12705
13162
|
{
|
|
12706
13163
|
"name": "noScroll",
|
|
12707
13164
|
"attribute": "no-scroll",
|
|
12708
|
-
"description": "If set, do not scroll the view to target node (e.g. given in URL hash)
|
|
13165
|
+
"description": "If set, do not scroll the view to target node (e.g. given in URL hash)\nafter content was loaded.",
|
|
12709
13166
|
"type": "boolean",
|
|
12710
13167
|
"default": "false"
|
|
12711
13168
|
},
|
|
@@ -12742,7 +13199,7 @@
|
|
|
12742
13199
|
{
|
|
12743
13200
|
"name": "waitFor",
|
|
12744
13201
|
"attribute": "wait-for",
|
|
12745
|
-
"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
|
|
13202
|
+
"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.",
|
|
12746
13203
|
"type": "string"
|
|
12747
13204
|
},
|
|
12748
13205
|
{
|
|
@@ -12770,10 +13227,6 @@
|
|
|
12770
13227
|
"name": "pb-navigate",
|
|
12771
13228
|
"description": "When received, navigate forward or backward in the document"
|
|
12772
13229
|
},
|
|
12773
|
-
{
|
|
12774
|
-
"name": "pb-zoom",
|
|
12775
|
-
"description": "When received, zoom in or out by changing font size of the content"
|
|
12776
|
-
},
|
|
12777
13230
|
{
|
|
12778
13231
|
"name": "pb-refresh",
|
|
12779
13232
|
"description": "When received, refresh the content based on the parameters passed in the event"
|
|
@@ -12843,20 +13296,20 @@
|
|
|
12843
13296
|
{
|
|
12844
13297
|
"name": "pb-zoom",
|
|
12845
13298
|
"path": "./src/pb-zoom.js",
|
|
12846
|
-
"description": "Zoom button to enlarge/shrink the font for the views. This component
|
|
13299
|
+
"description": "Zoom button to enlarge/shrink the font for the views. This component manages\nthe global zoom level by setting CSS custom properties on the document root.",
|
|
12847
13300
|
"attributes": [
|
|
12848
|
-
{
|
|
12849
|
-
"name": "icon",
|
|
12850
|
-
"description": "The icon to use",
|
|
12851
|
-
"type": "string",
|
|
12852
|
-
"default": "\"icons:zoom-in\""
|
|
12853
|
-
},
|
|
12854
13301
|
{
|
|
12855
13302
|
"name": "direction",
|
|
12856
13303
|
"description": "Either 'in' or 'out'",
|
|
12857
13304
|
"type": "string",
|
|
12858
13305
|
"default": "\"in\""
|
|
12859
13306
|
},
|
|
13307
|
+
{
|
|
13308
|
+
"name": "zoom-factor",
|
|
13309
|
+
"description": "The current zoom factor",
|
|
13310
|
+
"type": "number",
|
|
13311
|
+
"default": "1"
|
|
13312
|
+
},
|
|
12860
13313
|
{
|
|
12861
13314
|
"name": "subscribe",
|
|
12862
13315
|
"description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
|
|
@@ -12890,13 +13343,6 @@
|
|
|
12890
13343
|
}
|
|
12891
13344
|
],
|
|
12892
13345
|
"properties": [
|
|
12893
|
-
{
|
|
12894
|
-
"name": "icon",
|
|
12895
|
-
"attribute": "icon",
|
|
12896
|
-
"description": "The icon to use",
|
|
12897
|
-
"type": "string",
|
|
12898
|
-
"default": "\"icons:zoom-in\""
|
|
12899
|
-
},
|
|
12900
13346
|
{
|
|
12901
13347
|
"name": "direction",
|
|
12902
13348
|
"attribute": "direction",
|
|
@@ -12904,6 +13350,13 @@
|
|
|
12904
13350
|
"type": "string",
|
|
12905
13351
|
"default": "\"in\""
|
|
12906
13352
|
},
|
|
13353
|
+
{
|
|
13354
|
+
"name": "zoomFactor",
|
|
13355
|
+
"attribute": "zoom-factor",
|
|
13356
|
+
"description": "The current zoom factor",
|
|
13357
|
+
"type": "number",
|
|
13358
|
+
"default": "1"
|
|
13359
|
+
},
|
|
12907
13360
|
{
|
|
12908
13361
|
"name": "subscribe",
|
|
12909
13362
|
"attribute": "subscribe",
|
|
@@ -12947,6 +13400,20 @@
|
|
|
12947
13400
|
"name": "pb-zoom",
|
|
12948
13401
|
"description": "sends an event for e.g. pb-views to react to"
|
|
12949
13402
|
}
|
|
13403
|
+
],
|
|
13404
|
+
"cssProperties": [
|
|
13405
|
+
{
|
|
13406
|
+
"name": "--pb-zoom-factor",
|
|
13407
|
+
"description": "the zoom factor, e.g. 1.0 for normal size, 1.5 for 150%, 0.5 for 50%"
|
|
13408
|
+
},
|
|
13409
|
+
{
|
|
13410
|
+
"name": "--pb-min-zoom",
|
|
13411
|
+
"description": "the minimum zoom factor, e.g. 0.5 for 50%"
|
|
13412
|
+
},
|
|
13413
|
+
{
|
|
13414
|
+
"name": "--pb-max-zoom",
|
|
13415
|
+
"description": "the maximum zoom factor, e.g. 3.0 for 300%"
|
|
13416
|
+
}
|
|
12950
13417
|
]
|
|
12951
13418
|
},
|
|
12952
13419
|
{
|