@teipublisher/pb-components 1.43.5 → 1.44.1

package/src/pb-table-grid.js

@@ -1,219 +1,219 @@
-import { LitElement, html, css } from 'lit-element';
-import { Grid } from "gridjs";
-import { pbMixin } from './pb-mixin.js';
-import { resolveURL } from './utils.js';
-import { loadStylesheets, importStyles } from "./theming.js";
-import '@polymer/paper-input/paper-input';
-import '@polymer/iron-icons';
-import '@polymer/iron-form';
-import '@polymer/paper-icon-button';
-import './pb-table-column.js';
-
-/**
- * A table grid based on [gridjs](https://gridjs.io/), which loads its data from a server endpoint
- * specified in `source`. If `source` is a relative URI, it will be resolved relative to the
- * TEI Publisher endpoint.
- * 
- * The JSON data returned by the endpoint should be an object with two properties:
- * 
- * * `count`: the overall number of rows available on the server
- * * `results`: an array containing each record as an object
- * 
- * The parameters send to the server are as follows:
- * 
- * 
- * Parameter | Description
- * ---------|----------
- * limit | number of records to return for each page
- * start | start offset from which to return records
- * order | the id of the column to sort by
- * dir | sort direction: either 'asc' or 'desc'
- * search | an optional search string entered by the user
- * 
- * Table columns are configured via nested `<pb-table-column>` elements:
- * 
- * ```html
- * <pb-table-column label="Name" property="name" sort width="33%"></pb-table-column>
- * <pb-table-column label="Born" property="birth"></pb-table-column>
- * <pb-table-column label="Died" property="death"></pb-table-column>
- * ```
- */
-export class PbTableGrid extends pbMixin(LitElement) {
-    static get properties() {
-        return {
-            /**
-             * URI of the server-side endpoint to retrieve data from.
-             * Relative URIs are resolved relative to the configured TEI Publisher endpoint.
-             */
-            source: {
-                type: String
-            },
-            /**
-             * Path to the gridjs theme CSS files.
-             */
-            cssPath: {
-                type: String,
-                attribute: 'css-path'
-            },
-            /**
-             * If specified, columns (without a fixed width) will be resizable.
-             */
-            resizable: {
-                type: Boolean
-            },
-            perPage: {
-                type: Number,
-                attribute: 'per-page'
-            },
-            height: {
-                type: String
-            },
-            /**
-             * If specified, enable server-side search.
-             */
-            search: {
-                type: Boolean
-            },
-            _params: {
-                type: Object
-            },
-            ...super.properties
-        };
-    }
-
-    constructor() {
-        super();
-        this.cssPath = '../css/gridjs';
-        this._params = {};
-        this.resizable = false;
-        this.search = false;
-        this.perPage = 10;
-        this.height = null;
-        this.fixedHeader = false;
-    }
-
-    async connectedCallback() {
-        super.connectedCallback();
-
-        this.subscribeTo('pb-search-resubmit', (ev) => {
-            this._params = Object.assign({}, ev.detail.params);
-            this._submit();
-        });
-
-        window.addEventListener('popstate', (ev) => {
-            this._params = ev.state;
-            this._submit();
-        });
-
-        if (!this.height) {
-            const property = getComputedStyle(this).getPropertyValue('--pb-table-grid-height');
-            if (property) {
-                this.height = property;
-            } else {
-                this.height = 'auto';
-            }
-        }
-
-        const gridjsTheme = await loadStylesheets([`${resolveURL(this.cssPath)}/mermaid.min.css`]);
-        const theme = importStyles(this);
-        const sheets = [...this.shadowRoot.adoptedStyleSheets, gridjsTheme];
-        if (theme) {
-            sheets.push(theme);
-        }
-        this.shadowRoot.adoptedStyleSheets = sheets;
-    }
-
-    firstUpdated() {
-        const table = this.shadowRoot.getElementById('table');
-
-        const pbColumns = this.querySelectorAll('pb-table-column');
-        const columns = [];
-        pbColumns.forEach((column) => columns.push(column.data()));
-        PbTableGrid.waitOnce('pb-page-ready', () => {
-            this._params = this.getParameters();
-            const url = this.toAbsoluteURL(this.source);
-            const config = {
-                height: this.height,
-                fixedHeader: true,
-                columns,
-                resizable: this.resizable,
-                server: {
-                    url,
-                    then: data => data.results,
-                    total: data => data.count
-                },
-                sort: {
-                    multiColumn: false,
-                    enabled: true,
-                    server: {
-                        url: (prev, cols) => {
-                            if (!cols.length) return prev;
-                            const col = cols[0];
-                            return `${prev}${prev.indexOf('?') > -1 ? '&' : '?'}order=${columns[col.index].id}&dir=${col.direction === 1 ? 'asc' : 'desc'}`;
-                        }
-                    }
-                },
-                pagination: {
-                    enabled: true,
-                    limit: this.perPage,
-                    server: {
-                        url: (prev, page, limit) => {
-                            const form = this.shadowRoot.getElementById('form');
-                            if (form) {
-                                Object.assign(this._params, form.serializeForm());
-                            }
-                            this._params.limit = limit;
-                            this._params.start = page * limit + 1;
-                            this.setParameters(this._params);
-                            this.pushHistory('grid', this._params);
-
-                            return `${prev}${prev.indexOf('?') > -1 ? '&' : '?'}${new URLSearchParams(this._params).toString()}`;
-                        }
-                    }
-                }
-            };
-
-            this.grid = new Grid(config);
-            this.grid.on('load', () => {
-                this.emitTo('pb-results-received', {
-                    "params": this._params
-                });
-            });
-
-            this.grid.render(table);
-        });
-    }
-
-    _submit() {
-        this.grid.forceRender();
-    }
-
-    render() {
-        return html`
-            ${ 
-                this.search ? html`
-                    <iron-form id="form">
-                        <form action="">
-                            <paper-input id="search" name="search" label="Search" @keyup="${(e) => e.keyCode == 13 ? this._submit() : null}">
-                                <paper-icon-button icon="search" @click="${this._submit}" slot="suffix"></paper-icon-button>
-                            </paper-input>
-                        </form>
-                    </iron-form>
-                ` : null 
-            }
-            <div id="table"></div>
-        `;
-    }
-
-    static get styles() {
-        return css`
-            :host {
-                display: block;
-            }
-            button {
-                border: 0;
-            }
-        `;
-    }
-}
+import { LitElement, html, css } from 'lit-element';
+import { Grid } from "gridjs";
+import { pbMixin } from './pb-mixin.js';
+import { resolveURL } from './utils.js';
+import { loadStylesheets, importStyles } from "./theming.js";
+import '@polymer/paper-input/paper-input';
+import '@polymer/iron-icons';
+import '@polymer/iron-form';
+import '@polymer/paper-icon-button';
+import './pb-table-column.js';
+
+/**
+ * A table grid based on [gridjs](https://gridjs.io/), which loads its data from a server endpoint
+ * specified in `source`. If `source` is a relative URI, it will be resolved relative to the
+ * TEI Publisher endpoint.
+ * 
+ * The JSON data returned by the endpoint should be an object with two properties:
+ * 
+ * * `count`: the overall number of rows available on the server
+ * * `results`: an array containing each record as an object
+ * 
+ * The parameters send to the server are as follows:
+ * 
+ * 
+ * Parameter | Description
+ * ---------|----------
+ * limit | number of records to return for each page
+ * start | start offset from which to return records
+ * order | the id of the column to sort by
+ * dir | sort direction: either 'asc' or 'desc'
+ * search | an optional search string entered by the user
+ * 
+ * Table columns are configured via nested `<pb-table-column>` elements:
+ * 
+ * ```html
+ * <pb-table-column label="Name" property="name" sort width="33%"></pb-table-column>
+ * <pb-table-column label="Born" property="birth"></pb-table-column>
+ * <pb-table-column label="Died" property="death"></pb-table-column>
+ * ```
+ */
+export class PbTableGrid extends pbMixin(LitElement) {
+    static get properties() {
+        return {
+            /**
+             * URI of the server-side endpoint to retrieve data from.
+             * Relative URIs are resolved relative to the configured TEI Publisher endpoint.
+             */
+            source: {
+                type: String
+            },
+            /**
+             * Path to the gridjs theme CSS files.
+             */
+            cssPath: {
+                type: String,
+                attribute: 'css-path'
+            },
+            /**
+             * If specified, columns (without a fixed width) will be resizable.
+             */
+            resizable: {
+                type: Boolean
+            },
+            perPage: {
+                type: Number,
+                attribute: 'per-page'
+            },
+            height: {
+                type: String
+            },
+            /**
+             * If specified, enable server-side search.
+             */
+            search: {
+                type: Boolean
+            },
+            _params: {
+                type: Object
+            },
+            ...super.properties
+        };
+    }
+
+    constructor() {
+        super();
+        this.cssPath = '../css/gridjs';
+        this._params = {};
+        this.resizable = false;
+        this.search = false;
+        this.perPage = 10;
+        this.height = null;
+        this.fixedHeader = false;
+    }
+
+    async connectedCallback() {
+        super.connectedCallback();
+
+        this.subscribeTo('pb-search-resubmit', (ev) => {
+            this._params = Object.assign({}, ev.detail.params);
+            this._submit();
+        });
+
+        window.addEventListener('popstate', (ev) => {
+            this._params = ev.state;
+            this._submit();
+        });
+
+        if (!this.height) {
+            const property = getComputedStyle(this).getPropertyValue('--pb-table-grid-height');
+            if (property) {
+                this.height = property;
+            } else {
+                this.height = 'auto';
+            }
+        }
+
+        const gridjsTheme = await loadStylesheets([`${resolveURL(this.cssPath)}/mermaid.min.css`]);
+        const theme = importStyles(this);
+        const sheets = [...this.shadowRoot.adoptedStyleSheets, gridjsTheme];
+        if (theme) {
+            sheets.push(theme);
+        }
+        this.shadowRoot.adoptedStyleSheets = sheets;
+    }
+
+    firstUpdated() {
+        const table = this.shadowRoot.getElementById('table');
+
+        const pbColumns = this.querySelectorAll('pb-table-column');
+        const columns = [];
+        pbColumns.forEach((column) => columns.push(column.data()));
+        PbTableGrid.waitOnce('pb-page-ready', () => {
+            this._params = this.getParameters();
+            const url = this.toAbsoluteURL(this.source);
+            const config = {
+                height: this.height,
+                fixedHeader: true,
+                columns,
+                resizable: this.resizable,
+                server: {
+                    url,
+                    then: data => data.results,
+                    total: data => data.count
+                },
+                sort: {
+                    multiColumn: false,
+                    enabled: true,
+                    server: {
+                        url: (prev, cols) => {
+                            if (!cols.length) return prev;
+                            const col = cols[0];
+                            return `${prev}${prev.indexOf('?') > -1 ? '&' : '?'}order=${columns[col.index].id}&dir=${col.direction === 1 ? 'asc' : 'desc'}`;
+                        }
+                    }
+                },
+                pagination: {
+                    enabled: true,
+                    limit: this.perPage,
+                    server: {
+                        url: (prev, page, limit) => {
+                            const form = this.shadowRoot.getElementById('form');
+                            if (form) {
+                                Object.assign(this._params, form.serializeForm());
+                            }
+                            this._params.limit = limit;
+                            this._params.start = page * limit + 1;
+                            this.setParameters(this._params);
+                            this.pushHistory('grid', this._params);
+
+                            return `${prev}${prev.indexOf('?') > -1 ? '&' : '?'}${new URLSearchParams(this._params).toString()}`;
+                        }
+                    }
+                }
+            };
+
+            this.grid = new Grid(config);
+            this.grid.on('load', () => {
+                this.emitTo('pb-results-received', {
+                    "params": this._params
+                });
+            });
+
+            this.grid.render(table);
+        });
+    }
+
+    _submit() {
+        this.grid.forceRender();
+    }
+
+    render() {
+        return html`
+            ${ 
+                this.search ? html`
+                    <iron-form id="form">
+                        <form action="">
+                            <paper-input id="search" name="search" label="Search" @keyup="${(e) => e.keyCode == 13 ? this._submit() : null}">
+                                <paper-icon-button icon="search" @click="${this._submit}" slot="suffix"></paper-icon-button>
+                            </paper-input>
+                        </form>
+                    </iron-form>
+                ` : null 
+            }
+            <div id="table"></div>
+        `;
+    }
+
+    static get styles() {
+        return css`
+            :host {
+                display: block;
+            }
+            button {
+                border: 0;
+            }
+        `;
+    }
+}
 customElements.define('pb-table-grid', PbTableGrid);

package/src/pb-timeline.js

@@ -25,7 +25,37 @@ import { translate } from "./pb-i18n.js";
  * The value associated with each entry
  * should either correspond to a count of resources or an object with properties `count` and `info`. 
  * `info` should be an array, containing HTML to be shown in a list within the tooltips.
- *
+ * Expected JSON: 
+ * ```javascript
+ * {
+ *  "1852-01-14": {
+ *      "count": 1,
+ *      "info": [
+ *        "<a href='/briefe/B0977' part='tooltip-link'>Alfred Escher an Joseph Wolfgang von Deschwanden, Belvoir (Enge, Zürich), Mittwoch, 14. Januar 1852</a>"
+ *     ]
+ *   },
+ * "1874-01-25": {
+ *    "count": 3,
+ *     "info": [
+ *         "<a href='/briefe/B8140' part='tooltip-link'>Alfred Escher an Gustav von Mevissen, Zürich, Sonntag, 25. Januar 1874</a>",
+ *         "<a href='/briefe/B8139' part='tooltip-link'>Alfred Escher an Theodor Weishaupt, Zürich, Sonntag, 25. Januar 1874</a>",
+ *         "<a href='/briefe/B8143' part='tooltip-link'>Alfred Escher an Ludwig August Parcus, Zürich, Sonntag, 25. Januar 1874</a>"
+ *     ]
+ *  }
+ * }
+ * ```
+ * Sample Usage:
+ * ```xml
+ * <pb-timeline url="api/timeline" scopes="['D', 'M', 'Y', '5Y', '10Y']"
+ *      resettable=""
+ *      subscribe="docs" emit="timeline">
+ *   <span slot="label">Angezeigter Zeitraum: </span>
+ * </pb-timeline>
+ * ```
+ * See 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: 
+ * - [templates/people.html](https://github.com/stazh/briefedition-escher/blob/master/templates/people.html#L91) - usage of pb-timeline
+ * - [modules/custom-api.json](https://github.com/stazh/briefedition-escher/blob/master/modules/custom-api.json#L1080) - `/api/timeline` endpoint delivering required JSON object
+ * 
  * @slot label - Inserted before the label showing the currently displayed time range
  * 
  * @fires pb-timeline-date-changed - Triggered when user clicks on a single entry