@trebco/treb 25.6.4 → 25.7.3

package/dist/treb.d.ts

@@ -1,4 +1,4 @@
-/*! API v25.6. Copyright 2018-2023 trebco, llc. All rights reserved. LGPL: https://treb.app/license */
+/*! API v25.7. Copyright 2018-2023 trebco, llc. All rights reserved. LGPL: https://treb.app/license */
 
 /**
  * add our tag to the map
@@ -50,16 +50,21 @@ export interface EmbeddedSpreadsheetOptions {
 
     /**
      * key in localStorage for persisting document.
+     * @deprecated - this was renamed to local_storage for clarity. if both
+     * storage_key and local_storage are set we will use the value in local_storage.
+     */
+    storage_key?: string | boolean;
+
+    /**
+     * persist user changes to document in browser localStorage.
      *
-     * it's possible to set this to boolean `true`, in which case we will
-     * generate a storage key based on the page URI.
+     * if set to a string, the value is used as the storage key.
      *
-     * that can be convenient for quickly setting up a document, but don't
-     * use it if the page URI might change (the storage will get lost)
-     * or if there are multiple spreadsheets on the same page (they will
-     * overwrite each other).
+     * if set to `true`, we will generate a storage key based on the page URI.
+     * don't do that if you have multiple spreadsheets on a single page, or
+     * they will overwrite each other.
      */
-    storage_key?: string | boolean;
+    local_storage?: string | boolean;
 
     /** don't load immediately (?) */
     toll_initial_load?: boolean;
@@ -112,10 +117,15 @@ export interface EmbeddedSpreadsheetOptions {
     /** show tab bar (multi sheet) */
     tab_bar?: boolean | 'auto';
 
-    /** allow add tab */
+    /**
+     * allow add/delete tab
+     */
     add_tab?: boolean;
 
-    /** show delete tab */
+    /**
+     * show delete tab
+     * @deprecated - implied by add_tab
+     */
     delete_tab?: boolean;
 
     /** set a reference in global (self) */
@@ -526,7 +536,7 @@ export declare class EmbeddedSpreadsheet {
     UnmergeCells(range?: RangeReference): void;
 
     /**
-     * revert to the network version of this document, if both `storage_key`
+     * revert to the network version of this document, if both `local_storage`
      * and `network_document` are set.
      */
     Revert(): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trebco/treb",
-  "version": "25.6.4",
+  "version": "25.7.3",
   "license": "LGPL-3.0-or-later",
   "homepage": "https://treb.app",
   "repository": {
@@ -16,7 +16,7 @@
     "@typescript-eslint/eslint-plugin": "^5.30.4",
     "@typescript-eslint/parser": "^5.30.4",
     "archiver": "^5.3.0",
-    "cssnano": "^5.1.5",
+    "cssnano": "^6.0.0",
     "esbuild": "^0.17.11",
     "eslint": "^8.19.0",
     "fast-xml-parser": "^4.0.7",

package/treb-embed/src/custom-element/spreadsheet-constructor.ts

@@ -423,7 +423,7 @@ export class SpreadsheetConstructor {
       // add-tab and delete-tab will still work for the menu
 
       'add-tab': !!sheet.options.add_tab,
-      'delete-tab': !!sheet.options.delete_tab,
+      'delete-tab': (!!sheet.options.delete_tab || !!sheet.options.add_tab),
 
       // we actually don't want to remove stats if it's not in use, because
       // we need it for layout

package/treb-embed/src/embedded-spreadsheet.ts

@@ -280,7 +280,7 @@ export class EmbeddedSpreadsheet {
    * 
    * @internal
    */
-  public options: EmbeddedSpreadsheetOptions & { storage_key: string|undefined };
+  public options: EmbeddedSpreadsheetOptions & { local_storage: string|undefined };
 
   /**
    * @internal
@@ -491,10 +491,16 @@ export class EmbeddedSpreadsheet {
 
     // super();
 
+    // we renamed this option, default to the new name
+
+    if (options.storage_key && !options.local_storage) {
+      options.local_storage = options.storage_key;
+    }
+
     // consolidate options w/ defaults. note that this does not
     // support nested options, for that you need a proper merge
 
-    this.options = { ...DefaultOptions, ...options, storage_key: this.ResolveStorageKey(options.storage_key, 'document') };
+    this.options = { ...DefaultOptions, ...options, local_storage: this.ResolveStorageKey(options.local_storage, 'document') };
 
     if (typeof this.options.imaginary_value === 'string') {
       NumberFormat.imaginary_character = this.options.imaginary_value;
@@ -521,8 +527,8 @@ export class EmbeddedSpreadsheet {
     // don't load if we're a split view. we can also skip the 
     // unload event, as parent will already have that set
 
-    if (this.options.storage_key && !this.options.toll_initial_load && !options.model) {
-      data = localStorage.getItem(this.options.storage_key) || undefined;
+    if (this.options.local_storage && !this.options.toll_initial_load && !options.model) {
+      data = localStorage.getItem(this.options.local_storage) || undefined;
       if (data) {
         source = LoadSource.LOCAL_STORAGE;
       }
@@ -539,10 +545,10 @@ export class EmbeddedSpreadsheet {
     // this one should not be done for a split view, but we should still
     // do it if the toll flag is set, and storage key is set. 
 
-    if (this.options.storage_key && !options.model ) {
+    if (this.options.local_storage && !options.model ) {
       window.addEventListener('beforeunload', () => {
-        if (this.options.storage_key) {
-          this.SaveLocalStorage(this.options.storage_key);
+        if (this.options.local_storage) {
+          this.SaveLocalStorage(this.options.local_storage);
         }
       });
     }
@@ -571,7 +577,7 @@ export class EmbeddedSpreadsheet {
       expand_formula_button: this.options.expand_formula_button,
       tab_bar: this.options.tab_bar,
       add_tab: this.options.add_tab,
-      delete_tab: this.options.delete_tab,
+      // delete_tab: this.options.delete_tab,
       expand: this.options.expand,
 
     };
@@ -927,9 +933,9 @@ export class EmbeddedSpreadsheet {
     }
 
     // don't load if we are a split view
-    // UPDATE: don't load if we have a localStorage document. this is taking
-    // over the old alterante_document flow, because it doesn't make any sense
-    // otherwise. what would storage_key with document_name mean otherwise?
+    // UPDATE: don't load if we have a local_storage document. this is taking
+    // over the old alternate_document flow, because it doesn't make any sense
+    // otherwise. what would local_storage with document_name mean otherwise?
 
     if (network_document && !options.model && !data) {
       this.LoadNetworkDocument(network_document, this.options);
@@ -2319,16 +2325,16 @@ export class EmbeddedSpreadsheet {
   }
 
   /**
-   * revert to the network version of this document, if both `storage_key` 
+   * revert to the network version of this document, if both `local_storage` 
    * and `network_document` are set.
    */
   public Revert(): void {
 
     if (this.options.inline_document) {
       this.LoadDocument(this.options.inline_document);
-      if (this.options.storage_key) {
+      if (this.options.local_storage) {
         this.SaveLocalStorage('reverted_backup');
-        localStorage.removeItem(this.options.storage_key);
+        localStorage.removeItem(this.options.local_storage);
       }
       return;
     }
@@ -2351,9 +2357,9 @@ export class EmbeddedSpreadsheet {
       // flush storage? what about mistakes? maybe we should 
       // back it up somewhere? (...)
 
-      if (this.options.storage_key) {
+      if (this.options.local_storage) {
         this.SaveLocalStorage('reverted_backup');
-        localStorage.removeItem(this.options.storage_key);
+        localStorage.removeItem(this.options.local_storage);
       }
 
       return;
@@ -2514,7 +2520,7 @@ export class EmbeddedSpreadsheet {
     // FIXME: this is weird, why do we have a method for this, why
     // does it modify the key, and so on
 
-    this.options.storage_key = key;
+    this.options.local_storage = key;
     const json = localStorage.getItem(key);
 
     if (json) {
@@ -3243,7 +3249,7 @@ export class EmbeddedSpreadsheet {
    * @param key optional storage key. if omitted, the method will use
    * the key from local options (set at create time).
    */
-  public SaveLocalStorage(key = this.options.storage_key): void {
+  public SaveLocalStorage(key = this.options.local_storage): void {
 
     // API v1 OK
 
@@ -4761,8 +4767,8 @@ export class EmbeddedSpreadsheet {
 
       // console.info(json);
 
-      if (this.options.storage_key) {
-        localStorage.setItem(this.options.storage_key, json);
+      if (this.options.local_storage) {
+        localStorage.setItem(this.options.local_storage, json);
       }
       if (this.options.undo) {
         this.PushUndo(json, undo_selection, false);

package/treb-embed/src/options.ts

@@ -60,16 +60,21 @@ export interface EmbeddedSpreadsheetOptions {
 
   /** 
    * key in localStorage for persisting document. 
+   * @deprecated - this was renamed to local_storage for clarity. if both
+   * storage_key and local_storage are set we will use the value in local_storage.
+   */
+  storage_key?: string|boolean;
+
+  /**
+   * persist user changes to document in browser localStorage.
    * 
-   * it's possible to set this to boolean `true`, in which case we will 
-   * generate a storage key based on the page URI. 
+   * if set to a string, the value is used as the storage key.
    * 
-   * that can be convenient for quickly setting up a document, but don't 
-   * use it if the page URI might change (the storage will get lost)
-   * or if there are multiple spreadsheets on the same page (they will
-   * overwrite each other).
+   * if set to `true`, we will generate a storage key based on the page URI. 
+   * don't do that if you have multiple spreadsheets on a single page, or 
+   * they will overwrite each other.
    */
-  storage_key?: string|boolean;
+  local_storage?: string|boolean;
 
   /** don't load immediately (?) */
   toll_initial_load?: boolean;
@@ -132,10 +137,15 @@ export interface EmbeddedSpreadsheetOptions {
   /** show tab bar (multi sheet) */
   tab_bar?: boolean|'auto';
 
-  /** allow add tab */
+  /** 
+   * allow add/delete tab 
+   */
   add_tab?: boolean;
 
-  /** show delete tab */
+  /** 
+   * show delete tab 
+   * @deprecated - implied by add_tab 
+   */
   delete_tab?: boolean;
 
   /** set a reference in global (self) */
@@ -287,7 +297,7 @@ export const DefaultOptions: EmbeddedSpreadsheetOptions = {
   dnd: false,
   add_tab: false,
   expand_formula_button: false,
-  delete_tab: false,
+  // delete_tab: false,
 
   // changing default value for expand -> false, it might be
   // useful to disable it but the common expectation is that 

package/treb-embed/style/dark-theme.scss

@@ -35,7 +35,6 @@
   --treb-chart-grid-color: #976;
   --treb-chart-text-color: #fff;
   --treb-dialog-background: #000;
-  --treb-dialog-border-color: #fff;
   --treb-dialog-color: #fff;
   --treb-dropdown-background: #000;
   --treb-dropdown-border-color: #fff;
@@ -51,14 +50,14 @@
   --treb-grid-header-background: #444;
   --treb-grid-header-grid-color: #000;
   --treb-note-background: #333;
-  --treb-note-border-color: #fff;
+  --treb-note-border-color: #aaa;
   --treb-note-color: #fff;
   --treb-note-marker-color: pink;
   --treb-resize-tooltip-background: #fff;
   --treb-resize-tooltip-color: #000;
   --treb-scale-slider-accent-color: #fff;
   --treb-scale-slider-background: #333;
-  --treb-scale-slider-border-color: #fff;
+  --treb-scale-slider-border-color: #aaa;
   --treb-selection-color: yellow;
   --treb-selection-fill-opacity: .2;
   --treb-sidebar-button-background: #000;
@@ -72,7 +71,6 @@
   --treb-toolbar-active-button-background: #555;
   --treb-toolbar-button-background: #000;
   --treb-toolbar-hover-button-background: #444;
-  --treb-ui-border-color: #666;
   --treb-ui-color: #fff;
   --treb-table-header-background: #334; // DarkSlateGray;
   --treb-table-odd-background: #122;
@@ -92,6 +90,26 @@
   --treb-resize-handle-color: lightblue;
   --treb-resize-frame-color: lightblue;
   --treb-formula-bar-locked-background: #234;
+
+  // updates
+
+  --treb-grid-background: rgb(30,30,30);
+  --treb-grid-header-background: rgb(86,86,86);
+  --treb-grid-header-color: rgb(221,221,221);
+  --treb-tab-bar-active-tab-background: field;
+  --treb-tab-bar-tab-background: transparent;
+  --treb-tab-bar-tab-border-color: #444;
+  --treb-ui-border-color: #aaa;
+
+  // we should split toolbar buttons and menus
+
+  --treb-toolbar-button-background: rgb(86,86,86);
+  --treb-toolbar-button-background: rgb(33,33,33);
+  --treb-toolbar-border-color: rgb(67,67,67);
+
+  --treb-toolbar-color: rgb(221,221,221);
+  
+
 }
 
 .treb-dark-theme {

package/treb-embed/style/layout.scss

@@ -53,6 +53,11 @@
   
   text-align: start;
 
+  // set a default font, as well. we used to inherit but that
+  // does not necessarily make sense.
+
+  font-family: var(--treb-default-font, system-ui, $font-stack);
+
   div, button, input, ul, ol, li, a, textarea {
 
     // maybe this is being too aggressive. we could be a little 
@@ -60,7 +65,9 @@
     // unexpected side effects.
 
     all: revert;
+    
     box-sizing: border-box;
+    font-family: var(--treb-default-font, system-ui, $font-stack);
 
   }
 

package/treb-grid/src/types/grid_options.ts

@@ -1,24 +1,24 @@
-/*
- * This file is part of TREB.
- *
- * TREB is free software: you can redistribute it and/or modify it under the 
- * terms of the GNU General Public License as published by the Free Software 
- * Foundation, either version 3 of the License, or (at your option) any 
- * later version.
- *
- * TREB is distributed in the hope that it will be useful, but WITHOUT ANY 
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 
- * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 
- * details.
- *
- * You should have received a copy of the GNU General Public License along 
- * with TREB. If not, see <https://www.gnu.org/licenses/>. 
- *
- * Copyright 2022-2023 trebco, llc. 
- * info@treb.app
- * 
- */
-
+/*
+ * This file is part of TREB.
+ *
+ * TREB is free software: you can redistribute it and/or modify it under the 
+ * terms of the GNU General Public License as published by the Free Software 
+ * Foundation, either version 3 of the License, or (at your option) any 
+ * later version.
+ *
+ * TREB is distributed in the hope that it will be useful, but WITHOUT ANY 
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along 
+ * with TREB. If not, see <https://www.gnu.org/licenses/>. 
+ *
+ * Copyright 2022-2023 trebco, llc. 
+ * info@treb.app
+ * 
+ */
+
 import type { CellValue } from 'treb-base-types';
 import type { StatsEntry } from './tab_bar';
 
@@ -57,8 +57,8 @@ export interface GridOptions {
   /** allow add tab */
   add_tab?: boolean;
 
-  /** show delete tab in the tab bar */
-  delete_tab?: boolean;
+  /* * show delete tab in the tab bar */
+  // delete_tab?: boolean;
 
   /** show the "insert function" button. requires formula bar. */
   insert_function_button?: boolean;