@teipublisher/pb-components 1.26.0 → 1.28.1

package/src/pb-table-grid.js

@@ -0,0 +1,212 @@
+import { LitElement, html, css } from 'lit-element';
+import { Grid } from "gridjs";
+import { pbMixin } from './pb-mixin.js';
+import { resolveURL } from './utils.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;
+    }
+
+    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';
+            }
+        }
+    }
+
+    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;
+                            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() {
+        const themes = resolveURL(this.cssPath);
+        return html`
+            <link href="${themes}/mermaid.min.css" rel="stylesheet">
+            ${ 
+                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-view-annotate.js

@@ -454,7 +454,8 @@ class PbViewAnnotate extends PbView {
 
     console.log('<pb-view-annotate> Range: %o', range);
     const span = document.createElement('span');
-    span.className = `annotation annotation-${teiRange.type} ${teiRange.type}`;
+    const addClass = teiRange.properties[this.key] === '' ? 'incomplete' : '';
+    span.className = `annotation annotation-${teiRange.type} ${teiRange.type} ${addClass}`;
     span.dataset.type = teiRange.type;
     span.dataset.annotation = JSON.stringify(teiRange.properties);
 
@@ -657,9 +658,12 @@ class PbViewAnnotate extends PbView {
       range = clearProperties(range);
       this.emitTo('pb-annotations-changed', { ranges: this._ranges });
     }
-
-    const json = Object.assign(JSON.parse(span.dataset.annotation), properties);
+    const jsonOld = JSON.parse(span.dataset.annotation);
+    const json = Object.assign(jsonOld || {}, properties);
     span.dataset.annotation = JSON.stringify(json);
+    if (json[this.key] !== '') {
+      span.classList.remove('incomplete');
+    }
   }
 
   _editAnnotation(ev) {
@@ -753,7 +757,7 @@ class PbViewAnnotate extends PbView {
         ev.preventDefault();
         ev.stopPropagation();
         const type = span.dataset.type;
-        const data = JSON.parse(span.dataset.annotation);
+        const data = JSON.parse(span.dataset.annotation) || {};
         const color = this._annotationColors.get(type);
         typeInd.innerHTML = type;
         typeInd.style.backgroundColor = `var(--pb-annotation-${type})`;
@@ -896,7 +900,7 @@ class PbViewAnnotate extends PbView {
         const annoData = node.parentNode.dataset.annotation;
         const annoType = node.parentNode.dataset.type;
         if (annoData && annoType) {
-          const parsed = JSON.parse(annoData);
+          const parsed = JSON.parse(annoData) || {};
           isAnnotated = annoType === type;
           ref = parsed[this.key];
         }
@@ -1004,6 +1008,17 @@ class PbViewAnnotate extends PbView {
       classes.push(`
         .annotation-${type}::after {
           background-color: var(--pb-annotation-${type});
+          border-color: var(--pb-annotation-${type});
+          color: var(${color.isLight ? '--pb-color-primary' : '--pb-color-inverse'});
+        }
+        .annotation-${type}.incomplete::after {
+          background: repeating-linear-gradient(
+            315deg,
+            var(--pb-annotation-${type}),
+            var(--pb-annotation-${type}) 5px,
+            var(${color.isLight ? '--pb-annotation-stripes-light' : '--pb-annotation-stripes-dark'}) 5px,
+            var(${color.isLight ? '--pb-annotation-stripes-light' : '--pb-annotation-stripes-dark'}) 10px
+          );
           color: var(${color.isLight ? '--pb-color-primary' : '--pb-color-inverse'});
         }
       `);
@@ -1064,7 +1079,7 @@ class PbViewAnnotate extends PbView {
             font-variant: normal;
             padding: 2px;
         }
-        
+
         [part=highlight] {
           border: 3px solid rgb(255, 174, 0);
           border-radius: 8px;

package/src/pb-view.js

@@ -496,6 +496,15 @@ export class PbView extends pbMixin(LitElement) {
 
     _refresh(ev) {
         if (ev && ev.detail) {
+            if (ev.detail.hash && !(ev.detail.id || ev.detail.path || ev.detail.odd || ev.detail.view || ev.detail.position)) {
+                // if only the scroll target has changed: scroll to the element without reloading
+                this._scrollTarget = ev.detail.hash;
+                const target = this.shadowRoot.getElementById(this._scrollTarget);
+                if (target) {
+                    setTimeout(() => target.scrollIntoView());
+                }
+                return;
+            }
             if (ev.detail.path) {
                 const doc = this.getDocument();
                 doc.path = ev.detail.path;
@@ -641,7 +650,7 @@ export class PbView extends pbMixin(LitElement) {
                 if (target) {
                     setTimeout(() => {
                         target.scrollIntoView();
-                    });
+                    }, 100);
                 }
                 this._scrollTarget = null;
             });