@tenorlab/react-dashboard 1.4.1 → 1.4.2

package/dist/core.d.ts

@@ -14,6 +14,12 @@ export declare const createDynamicEntry: (key: string, loader: TWidgetFactoryBas
  */
 export declare const createStaticEntry: <TFrameworkComponentType = any>(key: string, component: TFrameworkComponentType, metaData?: TWidgetMetaInfoBase) => [string, IDynamicWidgetCatalogEntryBase];
 
+/**
+ * @name cssSettingsCatalog
+ * @description Catalog of available dashboard settings (array of IDashboardSettingEntry)
+ * @see IDashboardSettingEntry
+ * @remarks step should never be less than 0.1 as we do some rounding in other places ...
+ */
 export declare const cssSettingsCatalog: IDashboardSettingEntry[];
 
 /**
@@ -49,7 +55,18 @@ export declare const DashboardMaxZoomScale: 1;
 
 export declare const DashboardMinZoomScale: 0.7;
 
+/**
+ * @name dashboardSettingsUtils
+ * @description Contains utils for the dashboard custom settings
+ */
 export declare const dashboardSettingsUtils: {
+    /**
+     * @name incrementOrDecrementValue
+     * @description Increments or decrement a value based on the direction parameter
+     * @param item: an instance of IDashboardSettingEntry
+     * @param direction: -1 (for decrement) or 1 (for increment)
+     * @returns the update item
+     */
     incrementOrDecrementValue: (item: IDashboardSettingEntry, direction: -1 | 1) => IDashboardSettingEntry;
 };
 
@@ -272,6 +289,13 @@ export declare type TWidgetMetaInfoBase<TFrameworkElementType = any> = {
 
 export declare type TWidgetSize = 'default' | 'large' | 'xlarge';
 
+/**
+ * @name useDashboardStorageService
+ * @description
+ * This implementation of IDashboardStorageService uses localStorage to store custom dashboard configurations.
+ * Developers can implement their own version of the dashboard storage service to store the data in a database or other way if needed.
+ * @returns An instance of IDashboardStorageService
+ */
 export declare const useDashboardStorageService: () => IDashboardStorageService;
 
 export { }

package/dist/core.es.js

@@ -77,6 +77,13 @@ const w = [
     value: "1.0rem"
   }
 ], S = ["rem", "pc", "cm", "in", "em", "vh", "vw", "%"], b = (e, t) => S.includes(e) ? t : 1, E = {
+  /**
+   * @name incrementOrDecrementValue
+   * @description Increments or decrement a value based on the direction parameter
+   * @param item: an instance of IDashboardSettingEntry
+   * @param direction: -1 (for decrement) or 1 (for increment)
+   * @returns the update item
+   */
   incrementOrDecrementValue: (e, t) => {
     const i = e.value.match(/([\d.]+)/), a = i ? parseFloat(i[1]) : 0, s = e.value.match(/([^\d.]+)/), n = s ? s[1] : e.defaultUnit, r = b(n, e.step) * t, c = `${Math.max(a + r, e.minValue).toFixed(1)}${n}`;
     return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tenorlab/react-dashboard",
-  "version": "1.4.1",
+  "version": "1.4.2",
   "description": "Foundation components for creating user-configurable dashboards in React",
   "author": "Damiano Fusco",
   "type": "module",
@@ -54,7 +54,7 @@
     "zustand": "^5.0.0 || ^5.0.9"
   },
   "devDependencies": {
-    "@tenorlab/dashboard-core": "^1.0.1",
+    "@tenorlab/dashboard-core": "^1.4.1",
     "@types/node": "^24.10.1",
     "@types/react": "19.2.3",
     "@types/react-dom": "19.2.3",