@guiexpert/preact-table 10.1.91 → 10.1.93

package/GuiexpertTable.d.ts

@@ -1,5 +1,5 @@
 import { Component } from 'preact';
-import { FocusModelIf, GeModelChangeEvent, GeMouseEvent, GeScrollEvent, SelectionModelIf, TableApi, TableModelIf, TableOptions } from '@guiexpert/table';
+import { FocusModelIf, GeModelChangeEvent, GeMouseEvent, GeScrollEvent, GeStateChangeEvent, SelectionModelIf, TableApi, TableModelIf, TableOptions } from '@guiexpert/table';
 
 export type GeMouseEventFn = (evt: GeMouseEvent) => void;
 export type GeCheckboxEventFn = (evt: any[]) => void;
@@ -8,6 +8,7 @@ export type GeModelChangeEventFn = (evt: GeModelChangeEvent) => void;
 export type GeSelectionChangeEventFn = (evt: SelectionModelIf) => void;
 export type GeFocusChangeEventFn = (evt: FocusModelIf) => void;
 export type GeScrollEventFn = (evt: GeScrollEvent) => void;
+export type GeStateChangeEventFn = (evt: GeStateChangeEvent) => void;
 export interface GuiexpertTableProps {
     tableModel: TableModelIf;
     tableOptions?: TableOptions;
@@ -23,6 +24,17 @@ export interface GuiexpertTableProps {
     licenseKey?: string;
     selectionChanged?: GeSelectionChangeEventFn;
     focusChanged?: GeFocusChangeEventFn;
+    /**
+     * The state changed (column layout, sorting, scroll position, tree, checked/selected rows …) – once after the
+     * changes settled. Save `evt.state` (e.g. on your server) and pass it back as `tableOptions.initialState`.
+     * @since 1.1.92
+     */
+    stateChanged?: GeStateChangeEventFn;
+    /**
+     * `true` shows the loading overlay ("Loading…" with a CSS spinner) over the body, `false` hides it.
+     * Changing it does **not** re-create the table. Texts: `tableOptions.overlayOptions`. @since 1.1.92
+     */
+    loading?: boolean;
 }
 /**
  * GuiexpertTable is a Preact component that wraps the GuiExpert Table (`@guiexpert/table`).
@@ -36,6 +48,8 @@ export interface GuiexpertTableProps {
 export declare class GuiexpertTable extends Component<GuiexpertTableProps> {
     ref: import('preact').RefObject<HTMLDivElement>;
     private tableScope?;
+    /** the overlay was shown by the loading prop: loading={false} hides only that one */
+    private shownByProp;
     constructor(props: GuiexpertTableProps);
     componentDidMount(): void;
     componentDidUpdate(previousProps: Readonly<GuiexpertTableProps>): void;
@@ -45,6 +59,8 @@ export declare class GuiexpertTable extends Component<GuiexpertTableProps> {
      * The event callbacks are always taken from the current props.
      */
     initTable(ele: HTMLDivElement, props: GuiexpertTableProps): void;
+    /** Shows or hides the loading overlay according to the `loading` prop. */
+    private applyLoading;
     /** Releases the table (listeners, resize observer, cell renderers). */
     private destroyTable;
     render(): import("preact").JSX.Element;

package/index.cjs

@@ -1 +1 @@
-"use strict";var p=Object.defineProperty;var b=(a,s,o)=>s in a?p(a,s,{enumerable:!0,configurable:!0,writable:!0,value:o}):a[s]=o;var u=(a,s,o)=>b(a,typeof s!="symbol"?s+"":s,o);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const m=require("preact/jsx-runtime"),d=require("preact"),l=require("@guiexpert/table");class C extends d.Component{constructor(o){super(o);u(this,"ref",d.createRef());u(this,"tableScope")}componentDidMount(){const o=this.ref.current;o&&this.initTable(o,this.props)}componentDidUpdate(o){const i=this.ref.current;i&&(o.tableModel!==this.props.tableModel||o.tableOptions!==this.props.tableOptions)&&this.initTable(i,this.props),this.props.licenseKey&&this.props.licenseKey!==o.licenseKey&&l.LicenseManager.getInstance().setLicenseKey(this.props.licenseKey)}componentWillUnmount(){this.destroyTable()}initTable(o,i){var g;this.destroyTable();const r=()=>this.props,h={onSelectionChanged:t=>{var e,n;return(n=(e=r()).selectionChanged)==null?void 0:n.call(e,t)},onFocusChanged:t=>{var e,n;return(n=(e=r()).focusChanged)==null?void 0:n.call(e,t)},onScroll:t=>{var e,n;return(n=(e=r()).scroll)==null?void 0:n.call(e,t)},onCheckboxChanged:t=>{var e,n;return(n=(e=r()).checkboxChanged)==null?void 0:n.call(e,t)},onContextmenu:t=>{var e,n;return(n=(e=r()).contextmenu)==null?void 0:n.call(e,t)},onModelChanged:t=>{var e,n;return(n=(e=r()).modelChanged)==null?void 0:n.call(e,t)},onMouseClicked:t=>{var e,n;return(n=(e=r()).mouseClicked)==null?void 0:n.call(e,t)},onMouseDragging:t=>{var e,n;return(n=(e=r()).mouseDragging)==null?void 0:n.call(e,t)},onMouseDraggingEnd:t=>{var e,n;return(n=(e=r()).mouseDraggingEnd)==null?void 0:n.call(e,t)},onMouseMoved:t=>{var e,n;return(n=(e=r()).mouseMoved)==null?void 0:n.call(e,t)}},c=new l.TableScope(o,i.tableModel,new l.SimpleDomService,i.tableOptions??new l.TableOptions,h);this.tableScope=c,c.firstInit(),(g=i.tableReady)==null||g.call(i,c.getApi()),i.licenseKey&&l.LicenseManager.getInstance().setLicenseKey(i.licenseKey)}destroyTable(){var o;(o=this.tableScope)==null||o.destroy(),this.tableScope=void 0}render(){return m.jsx("div",{ref:this.ref,className:"container-div",style:{width:"100%",height:"100%",backgroundColor:"transparent",padding:"0",margin:"0"}})}}class y{constructor(s){this.Component=s}render(s,o,i,r,h,c,g){const t={cellDiv:s,rowIndex:o,columnIndex:i,areaIdent:r,areaModel:h,cellValue:c};return d.render(d.h(this.Component,t),s),()=>{d.render(null,s)}}}exports.ComponentRendererWrapper=y;exports.GuiexpertTable=C;
+"use strict";var u=Object.defineProperty;var b=(r,i,t)=>i in r?u(r,i,{enumerable:!0,configurable:!0,writable:!0,value:t}):r[i]=t;var h=(r,i,t)=>b(r,typeof i!="symbol"?i+"":i,t);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const y=require("preact/jsx-runtime"),d=require("preact"),c=require("@guiexpert/table");class m extends d.Component{constructor(t){super(t);h(this,"ref",d.createRef());h(this,"tableScope");h(this,"shownByProp",!1)}componentDidMount(){const t=this.ref.current;t&&this.initTable(t,this.props)}componentDidUpdate(t){const s=this.ref.current;s&&(t.tableModel!==this.props.tableModel||t.tableOptions!==this.props.tableOptions)&&this.initTable(s,this.props),!!t.loading!=!!this.props.loading&&this.applyLoading(),this.props.licenseKey&&this.props.licenseKey!==t.licenseKey&&c.LicenseManager.getInstance().setLicenseKey(this.props.licenseKey)}componentWillUnmount(){this.destroyTable()}initTable(t,s){var g;this.destroyTable();const a=()=>this.props,p={onSelectionChanged:o=>{var e,n;return(n=(e=a()).selectionChanged)==null?void 0:n.call(e,o)},onFocusChanged:o=>{var e,n;return(n=(e=a()).focusChanged)==null?void 0:n.call(e,o)},onScroll:o=>{var e,n;return(n=(e=a()).scroll)==null?void 0:n.call(e,o)},onCheckboxChanged:o=>{var e,n;return(n=(e=a()).checkboxChanged)==null?void 0:n.call(e,o)},onContextmenu:o=>{var e,n;return(n=(e=a()).contextmenu)==null?void 0:n.call(e,o)},onModelChanged:o=>{var e,n;return(n=(e=a()).modelChanged)==null?void 0:n.call(e,o)},onMouseClicked:o=>{var e,n;return(n=(e=a()).mouseClicked)==null?void 0:n.call(e,o)},onMouseDragging:o=>{var e,n;return(n=(e=a()).mouseDragging)==null?void 0:n.call(e,o)},onMouseDraggingEnd:o=>{var e,n;return(n=(e=a()).mouseDraggingEnd)==null?void 0:n.call(e,o)},onMouseMoved:o=>{var e,n;return(n=(e=a()).mouseMoved)==null?void 0:n.call(e,o)},onStateChanged:o=>{var e,n;return(n=(e=a()).stateChanged)==null?void 0:n.call(e,o)}},l=new c.TableScope(t,s.tableModel,new c.SimpleDomService,s.tableOptions??new c.TableOptions,p);this.tableScope=l,l.firstInit(),this.shownByProp=!1,this.applyLoading(),(g=s.tableReady)==null||g.call(s,l.getApi()),s.licenseKey&&c.LicenseManager.getInstance().setLicenseKey(s.licenseKey)}applyLoading(){var t,s;this.props.loading?((t=this.tableScope)==null||t.showLoadingOverlay(),this.shownByProp=!0):this.shownByProp&&((s=this.tableScope)==null||s.hideOverlay(),this.shownByProp=!1)}destroyTable(){var t;(t=this.tableScope)==null||t.destroy(),this.tableScope=void 0}render(){return y.jsx("div",{ref:this.ref,className:"container-div",style:{width:"100%",height:"100%",backgroundColor:"transparent",padding:"0",margin:"0"}})}}class C{constructor(i){this.Component=i}render(i,t,s,a,p,l,g){const o={cellDiv:i,rowIndex:t,columnIndex:s,areaIdent:a,areaModel:p,cellValue:l};return d.render(d.h(this.Component,o),i),()=>{d.render(null,i)}}}exports.ComponentRendererWrapper=C;exports.GuiexpertTable=m;

package/index.js

@@ -1,22 +1,24 @@
-var p = Object.defineProperty;
-var b = (a, i, o) => i in a ? p(a, i, { enumerable: !0, configurable: !0, writable: !0, value: o }) : a[i] = o;
-var h = (a, i, o) => b(a, typeof i != "symbol" ? i + "" : i, o);
-import { jsx as u } from "preact/jsx-runtime";
-import { Component as C, createRef as y, render as g, h as f } from "preact";
-import { LicenseManager as m, TableScope as M, SimpleDomService as S, TableOptions as T } from "@guiexpert/table";
-class w extends C {
-  constructor(o) {
-    super(o);
-    h(this, "ref", y());
-    h(this, "tableScope");
+var m = Object.defineProperty;
+var b = (r, i, t) => i in r ? m(r, i, { enumerable: !0, configurable: !0, writable: !0, value: t }) : r[i] = t;
+var c = (r, i, t) => b(r, typeof i != "symbol" ? i + "" : i, t);
+import { jsx as y } from "preact/jsx-runtime";
+import { Component as u, createRef as f, render as p, h as C } from "preact";
+import { LicenseManager as g, TableScope as S, SimpleDomService as M, TableOptions as w } from "@guiexpert/table";
+class O extends u {
+  constructor(t) {
+    super(t);
+    c(this, "ref", f());
+    c(this, "tableScope");
+    /** the overlay was shown by the loading prop: loading={false} hides only that one */
+    c(this, "shownByProp", !1);
   }
   componentDidMount() {
-    const o = this.ref.current;
-    o && this.initTable(o, this.props);
+    const t = this.ref.current;
+    t && this.initTable(t, this.props);
   }
-  componentDidUpdate(o) {
+  componentDidUpdate(t) {
     const s = this.ref.current;
-    s && (o.tableModel !== this.props.tableModel || o.tableOptions !== this.props.tableOptions) && this.initTable(s, this.props), this.props.licenseKey && this.props.licenseKey !== o.licenseKey && m.getInstance().setLicenseKey(this.props.licenseKey);
+    s && (t.tableModel !== this.props.tableModel || t.tableOptions !== this.props.tableOptions) && this.initTable(s, this.props), !!t.loading != !!this.props.loading && this.applyLoading(), this.props.licenseKey && this.props.licenseKey !== t.licenseKey && g.getInstance().setLicenseKey(this.props.licenseKey);
   }
   componentWillUnmount() {
     this.destroyTable();
@@ -25,66 +27,75 @@ class w extends C {
    * Creates the table in `ele` (a table created before is destroyed first) and calls `tableReady`.
    * The event callbacks are always taken from the current props.
    */
-  initTable(o, s) {
+  initTable(t, s) {
     var d;
     this.destroyTable();
-    const r = () => this.props, l = {
-      onSelectionChanged: (t) => {
+    const a = () => this.props, h = {
+      onSelectionChanged: (o) => {
         var e, n;
-        return (n = (e = r()).selectionChanged) == null ? void 0 : n.call(e, t);
+        return (n = (e = a()).selectionChanged) == null ? void 0 : n.call(e, o);
       },
-      onFocusChanged: (t) => {
+      onFocusChanged: (o) => {
         var e, n;
-        return (n = (e = r()).focusChanged) == null ? void 0 : n.call(e, t);
+        return (n = (e = a()).focusChanged) == null ? void 0 : n.call(e, o);
       },
-      onScroll: (t) => {
+      onScroll: (o) => {
         var e, n;
-        return (n = (e = r()).scroll) == null ? void 0 : n.call(e, t);
+        return (n = (e = a()).scroll) == null ? void 0 : n.call(e, o);
       },
-      onCheckboxChanged: (t) => {
+      onCheckboxChanged: (o) => {
         var e, n;
-        return (n = (e = r()).checkboxChanged) == null ? void 0 : n.call(e, t);
+        return (n = (e = a()).checkboxChanged) == null ? void 0 : n.call(e, o);
       },
-      onContextmenu: (t) => {
+      onContextmenu: (o) => {
         var e, n;
-        return (n = (e = r()).contextmenu) == null ? void 0 : n.call(e, t);
+        return (n = (e = a()).contextmenu) == null ? void 0 : n.call(e, o);
       },
-      onModelChanged: (t) => {
+      onModelChanged: (o) => {
         var e, n;
-        return (n = (e = r()).modelChanged) == null ? void 0 : n.call(e, t);
+        return (n = (e = a()).modelChanged) == null ? void 0 : n.call(e, o);
       },
-      onMouseClicked: (t) => {
+      onMouseClicked: (o) => {
         var e, n;
-        return (n = (e = r()).mouseClicked) == null ? void 0 : n.call(e, t);
+        return (n = (e = a()).mouseClicked) == null ? void 0 : n.call(e, o);
       },
-      onMouseDragging: (t) => {
+      onMouseDragging: (o) => {
         var e, n;
-        return (n = (e = r()).mouseDragging) == null ? void 0 : n.call(e, t);
+        return (n = (e = a()).mouseDragging) == null ? void 0 : n.call(e, o);
       },
-      onMouseDraggingEnd: (t) => {
+      onMouseDraggingEnd: (o) => {
         var e, n;
-        return (n = (e = r()).mouseDraggingEnd) == null ? void 0 : n.call(e, t);
+        return (n = (e = a()).mouseDraggingEnd) == null ? void 0 : n.call(e, o);
       },
-      onMouseMoved: (t) => {
+      onMouseMoved: (o) => {
         var e, n;
-        return (n = (e = r()).mouseMoved) == null ? void 0 : n.call(e, t);
+        return (n = (e = a()).mouseMoved) == null ? void 0 : n.call(e, o);
+      },
+      onStateChanged: (o) => {
+        var e, n;
+        return (n = (e = a()).stateChanged) == null ? void 0 : n.call(e, o);
       }
-    }, c = new M(
-      o,
+    }, l = new S(
+      t,
       s.tableModel,
-      new S(),
-      s.tableOptions ?? new T(),
-      l
+      new M(),
+      s.tableOptions ?? new w(),
+      h
     );
-    this.tableScope = c, c.firstInit(), (d = s.tableReady) == null || d.call(s, c.getApi()), s.licenseKey && m.getInstance().setLicenseKey(s.licenseKey);
+    this.tableScope = l, l.firstInit(), this.shownByProp = !1, this.applyLoading(), (d = s.tableReady) == null || d.call(s, l.getApi()), s.licenseKey && g.getInstance().setLicenseKey(s.licenseKey);
+  }
+  /** Shows or hides the loading overlay according to the `loading` prop. */
+  applyLoading() {
+    var t, s;
+    this.props.loading ? ((t = this.tableScope) == null || t.showLoadingOverlay(), this.shownByProp = !0) : this.shownByProp && ((s = this.tableScope) == null || s.hideOverlay(), this.shownByProp = !1);
   }
   /** Releases the table (listeners, resize observer, cell renderers). */
   destroyTable() {
-    var o;
-    (o = this.tableScope) == null || o.destroy(), this.tableScope = void 0;
+    var t;
+    (t = this.tableScope) == null || t.destroy(), this.tableScope = void 0;
   }
   render() {
-    return /* @__PURE__ */ u(
+    return /* @__PURE__ */ y(
       "div",
       {
         ref: this.ref,
@@ -100,21 +111,21 @@ class w extends C {
     );
   }
 }
-class O {
+class k {
   constructor(i) {
     this.Component = i;
   }
-  render(i, o, s, r, l, c, d) {
-    const t = {
+  render(i, t, s, a, h, l, d) {
+    const o = {
       cellDiv: i,
-      rowIndex: o,
+      rowIndex: t,
       columnIndex: s,
-      areaIdent: r,
-      areaModel: l,
-      cellValue: c
+      areaIdent: a,
+      areaModel: h,
+      cellValue: l
     };
-    return g(f(this.Component, t), i), () => {
-      g(null, i);
+    return p(C(this.Component, o), i), () => {
+      p(null, i);
     };
   }
   // private mount(
@@ -138,6 +149,6 @@ class O {
   // }
 }
 export {
-  O as ComponentRendererWrapper,
-  w as GuiexpertTable
+  k as ComponentRendererWrapper,
+  O as GuiexpertTable
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guiexpert/preact-table",
-  "version": "10.1.91",
+  "version": "10.1.93",
   "license": "MIT",
   "author": "Dr. Marc Kronberg <info@gui.expert> (https://gui.expert)",
   "repository": {
@@ -31,7 +31,7 @@
   },
   "dependencies": {
     "tslib": "^2.3.0",
-    "@guiexpert/table": "^1.1.91"
+    "@guiexpert/table": "^1.1.93"
   },
   "peerDependencies": {
     "preact": "^10.0.0"