@record-evolution/widget-filter-calendar 1.0.5 → 1.0.6

package/dist/widget-filter-calendar.js

@@ -554,7 +554,7 @@ var Nt = Object.defineProperty, jt = Object.getOwnPropertyDescriptor, $ = (r, t,
 };
 let u = class extends w {
   constructor() {
-    super(...arguments), this.defaultRange = [], this.version = "1.0.5";
+    super(...arguments), this.defaultRange = [], this.version = "1.0.6";
   }
   update(r) {
     r.has("theme") && this.registerTheme(this.theme), (r.has("route") || r.has("inputData")) && this.updateRangeFromRoute(), super.update(r);
@@ -730,7 +730,7 @@ $([
   Ht("lit-flatpickr")
 ], u.prototype, "flatpickr", 2);
 u = $([
-  Ot("widget-filter-calendar-1.0.5")
+  Ot("widget-filter-calendar-1.0.6")
 ], u);
 export {
   u as WidgetfilterCalendar

package/package.json

@@ -3,7 +3,7 @@
     "description": "Webcomponent widget-filter-calendar for IronFlock UI",
     "license": "MIT",
     "author": "widget-filter-calendar",
-    "version": "1.0.5",
+    "version": "1.0.6",
     "engines": {
         "node": ">=24.9.0",
         "npm": ">=10.0.2"

package/src/definition-schema.d.ts

@@ -5,20 +5,26 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
+/**
+ * The text label displayed on the calendar input field. Use descriptive text like 'Select Date Range' or 'Filter Period' to guide users.
+ */
 export type Label = string;
 /**
- * The key used to identify the time range start when referenced in data filter configurations.
+ * The URL parameter key for the start timestamp (e.g., 'startTime', 'from'). Other widgets can reference this parameter in their data filter configurations to filter data from this date. Leave empty for single-date mode using only endKey.
  */
 export type TimeRangeStartKey = string;
 /**
- * The key used to identify the time range end when referenced in data filter configurations.
+ * The URL parameter key for the end timestamp (e.g., 'endTime', 'to'). Other widgets can reference this parameter in their data filter configurations to filter data until this date. Leave empty for single-date mode using only startKey.
  */
 export type TimeRangeEndKey = string;
 /**
- * The number of months to display in the calendar widget.
+ * How many calendar months to show simultaneously in the picker (1-3). Use 2 for date range selection to easily see start and end months. Use 1 for compact layouts or single date selection.
  */
 export type NumberOfMonthsToDisplay = number;
 
+/**
+ * A date/time range picker filter widget using Flatpickr calendar. Use this widget to allow users to select date ranges for filtering dashboard data. Supports single date selection (configure only startKey or endKey) or date range selection (configure both). The selected timestamps are stored as URL parameters and can be referenced by other widgets' data queries. Ideal for time-series dashboards, historical data analysis, and report generation with customizable time windows.
+ */
 export interface InputData {
   label?: Label;
   startKey?: TimeRangeStartKey;

package/src/definition-schema.json

@@ -1,9 +1,11 @@
 {
     "title": "Input Data",
+    "description": "A date/time range picker filter widget using Flatpickr calendar. Use this widget to allow users to select date ranges for filtering dashboard data. Supports single date selection (configure only startKey or endKey) or date range selection (configure both). The selected timestamps are stored as URL parameters and can be referenced by other widgets' data queries. Ideal for time-series dashboards, historical data analysis, and report generation with customizable time windows.",
     "type": "object",
     "properties": {
         "label": {
             "title": "Label",
+            "description": "The text label displayed on the calendar input field. Use descriptive text like 'Select Date Range' or 'Filter Period' to guide users.",
             "order": 1,
             "dataDrivenDisabled": true,
             "type": "string"
@@ -12,21 +14,21 @@
             "title": "Time Range Start Key",
             "order": 2,
             "dataDrivenDisabled": true,
-            "description": "The key used to identify the time range start when referenced in data filter configurations.",
+            "description": "The URL parameter key for the start timestamp (e.g., 'startTime', 'from'). Other widgets can reference this parameter in their data filter configurations to filter data from this date. Leave empty for single-date mode using only endKey.",
             "type": "string"
         },
         "endKey": {
             "title": "Time Range End Key",
             "order": 3,
             "dataDrivenDisabled": true,
-            "description": "The key used to identify the time range end when referenced in data filter configurations.",
+            "description": "The URL parameter key for the end timestamp (e.g., 'endTime', 'to'). Other widgets can reference this parameter in their data filter configurations to filter data until this date. Leave empty for single-date mode using only startKey.",
             "type": "string"
         },
         "numMonths": {
             "title": "Number of Months to Display",
             "order": 4,
             "dataDrivenDisabled": true,
-            "description": "The number of months to display in the calendar widget.",
+            "description": "How many calendar months to show simultaneously in the picker (1-3). Use 2 for date range selection to easily see start and end months. Use 1 for compact layouts or single date selection.",
             "type": "number"
         }
     }