@luzmo/analytics-components-kit 1.1.1 → 1.2.1

package/custom-elements.json

@@ -14258,6 +14258,110 @@
               "name": "chart-actions-extra"
             }
           ],
+          "members": [
+            {
+              "kind": "method",
+              "name": "endInteraction",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Ends open option gestures in the config panel now, keeping their values. Call before swapping `chart` or removing the element."
+            },
+            {
+              "kind": "field",
+              "name": "language",
+              "type": {
+                "text": "string"
+              },
+              "default": "'en'",
+              "description": "The language for UI labels.\nSupported values: 'en', 'nl', 'fr', 'de', 'es'",
+              "attribute": "language",
+              "reflects": true,
+              "inheritedFrom": {
+                "name": "LocalizedMixin",
+                "module": "src/utils/base/localized-mixin.ts"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "_syncLocale",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "inheritedFrom": {
+                "name": "LocalizedMixin",
+                "module": "src/utils/base/localized-mixin.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "shadowRoot",
+              "type": {
+                "text": "ShadowRoot"
+              },
+              "privacy": "private",
+              "inheritedFrom": {
+                "name": "LuzmoMixin",
+                "module": "src/utils/base/base.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "_dirParent",
+              "type": {
+                "text": "HTMLElement | undefined"
+              },
+              "privacy": "private",
+              "inheritedFrom": {
+                "name": "LuzmoMixin",
+                "module": "src/utils/base/base.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "dir",
+              "type": {
+                "text": "'ltr' | 'rtl'"
+              },
+              "privacy": "private",
+              "inheritedFrom": {
+                "name": "LuzmoMixin",
+                "module": "src/utils/base/base.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "isLTR",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "readonly": true,
+              "inheritedFrom": {
+                "name": "LuzmoMixin",
+                "module": "src/utils/base/base.ts"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "hasVisibleFocusInTree",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "inheritedFrom": {
+                "name": "LuzmoMixin",
+                "module": "src/utils/base/base.ts"
+              }
+            }
+          ],
           "events": [
             {
               "type": {
@@ -14270,9 +14374,30 @@
               "type": {
                 "text": "CustomEvent<InteractiveVizItemChartChangedEventDetail>"
               },
-              "description": "Fired when the config panel changes slots, filters, or options (full chart). Applied to `chart` first unless `controlled` is set.",
+              "description": "Fired when the config panel changes slots, filters, or options (full chart). Applied to `chart` first unless `controlled` is set. With `live-interactions`, option updates inside a gesture carry `interaction`.",
               "name": "luzmo-chart-changed"
             },
+            {
+              "type": {
+                "text": "CustomEvent<InteractiveVizItemInteractionEventDetail>"
+              },
+              "description": "With `live-interactions`: an option drag or held key in the config panel first changed its value, right before that `luzmo-chart-changed`; `detail.optionKey` names the option and `detail.chart` is the chart it started on.",
+              "name": "luzmo-option-interaction-start"
+            },
+            {
+              "type": {
+                "text": "CustomEvent<InteractiveVizItemInteractionEventDetail>"
+              },
+              "description": "With `live-interactions`: the gesture ended, after its last `luzmo-chart-changed`. `detail.changed` is false when the value is back at its start; `detail.chart` is still the chart it started on.",
+              "name": "luzmo-option-interaction-end"
+            },
+            {
+              "type": {
+                "text": "CustomEvent<InteractiveVizItemInteractionEventDetail>"
+              },
+              "description": "With `live-interactions`: the gesture was cancelled and the control reverted to its start value.",
+              "name": "luzmo-option-interaction-cancel"
+            },
             {
               "type": {
                 "text": "CustomEvent<InteractiveVizItemFeedbackChangedEventDetail>"
@@ -14421,6 +14546,15 @@
               "description": "When present, chart changes are only emitted and the host sets `chart`; otherwise they are applied here and still emitted.",
               "fieldName": "controlled"
             },
+            {
+              "name": "live-interactions",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Applies and emits option changes live while a control is dragged or a key is held, without debounce, and\nforwards `luzmo-option-interaction-*` events. Off by default.",
+              "fieldName": "liveInteractions"
+            },
             {
               "name": "size",
               "type": {
@@ -14455,101 +14589,7 @@
             "module": "/src/utils/base"
           },
           "tagName": "luzmo-interactive-viz-item",
-          "customElement": true,
-          "members": [
-            {
-              "kind": "field",
-              "name": "language",
-              "type": {
-                "text": "string"
-              },
-              "default": "'en'",
-              "description": "The language for UI labels.\nSupported values: 'en', 'nl', 'fr', 'de', 'es'",
-              "attribute": "language",
-              "reflects": true,
-              "inheritedFrom": {
-                "name": "LocalizedMixin",
-                "module": "src/utils/base/localized-mixin.ts"
-              }
-            },
-            {
-              "kind": "method",
-              "name": "_syncLocale",
-              "privacy": "private",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "inheritedFrom": {
-                "name": "LocalizedMixin",
-                "module": "src/utils/base/localized-mixin.ts"
-              }
-            },
-            {
-              "kind": "field",
-              "name": "shadowRoot",
-              "type": {
-                "text": "ShadowRoot"
-              },
-              "privacy": "private",
-              "inheritedFrom": {
-                "name": "LuzmoMixin",
-                "module": "src/utils/base/base.ts"
-              }
-            },
-            {
-              "kind": "field",
-              "name": "_dirParent",
-              "type": {
-                "text": "HTMLElement | undefined"
-              },
-              "privacy": "private",
-              "inheritedFrom": {
-                "name": "LuzmoMixin",
-                "module": "src/utils/base/base.ts"
-              }
-            },
-            {
-              "kind": "field",
-              "name": "dir",
-              "type": {
-                "text": "'ltr' | 'rtl'"
-              },
-              "privacy": "private",
-              "inheritedFrom": {
-                "name": "LuzmoMixin",
-                "module": "src/utils/base/base.ts"
-              }
-            },
-            {
-              "kind": "field",
-              "name": "isLTR",
-              "type": {
-                "text": "boolean"
-              },
-              "privacy": "private",
-              "readonly": true,
-              "inheritedFrom": {
-                "name": "LuzmoMixin",
-                "module": "src/utils/base/base.ts"
-              }
-            },
-            {
-              "kind": "method",
-              "name": "hasVisibleFocusInTree",
-              "privacy": "public",
-              "return": {
-                "type": {
-                  "text": "boolean"
-                }
-              },
-              "inheritedFrom": {
-                "name": "LuzmoMixin",
-                "module": "src/utils/base/base.ts"
-              }
-            }
-          ]
+          "customElement": true
         }
       ],
       "exports": [
@@ -16295,6 +16335,17 @@
               "attribute": "size",
               "reflects": true
             },
+            {
+              "kind": "field",
+              "name": "liveInteractions",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Emits options updates live, without the control's debounce, plus `luzmo-option-interaction-*` events\naround drags and held keys. Off by default.",
+              "attribute": "live-interactions",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "_controlTypeLoaded",
@@ -16359,6 +16410,16 @@
               "name": "changedOptions",
               "description": "Callback that updates `options` and emits `luzmo-options-changed`; used internally by the rendered control."
             },
+            {
+              "kind": "method",
+              "name": "endInteraction",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Ends the control's open gesture now, keeping its value. Call before removing or rebinding the element."
+            },
             {
               "kind": "field",
               "name": "shadowRoot",
@@ -16428,8 +16489,29 @@
               "type": {
                 "text": "CustomEvent<ItemOptionsChangedEventDetail>"
               },
-              "description": "Announces that the `options` of the element have changed",
+              "description": "Announces that the `options` of the element have changed. With `live-interactions`, updates inside a gesture carry `interaction`.",
               "name": "luzmo-options-changed"
+            },
+            {
+              "type": {
+                "text": "CustomEvent<ItemOptionInteractionEventDetail>"
+              },
+              "description": "With `live-interactions`: a drag or held key first changed the control's value, right before that options update. A press that never changes the value emits no lifecycle. `detail.optionKey` is set.",
+              "name": "luzmo-option-interaction-start"
+            },
+            {
+              "type": {
+                "text": "CustomEvent<ItemOptionInteractionEventDetail>"
+              },
+              "description": "With `live-interactions`: the gesture ended, after its last options update. `detail.changed` is false when the value is back at its start.",
+              "name": "luzmo-option-interaction-end"
+            },
+            {
+              "type": {
+                "text": "CustomEvent<ItemOptionInteractionEventDetail>"
+              },
+              "description": "With `live-interactions`: the gesture was cancelled and the control reverted to its start value.",
+              "name": "luzmo-option-interaction-cancel"
             }
           ],
           "attributes": [
@@ -16533,6 +16615,15 @@
               "default": "'m'",
               "description": "The size variant of the option control (`s`, `m`, `l`, `xl`).",
               "fieldName": "size"
+            },
+            {
+              "name": "live-interactions",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Emits options updates live, without the control's debounce, plus `luzmo-option-interaction-*` events\naround drags and held keys. Off by default.",
+              "fieldName": "liveInteractions"
             }
           ],
           "superclass": {
@@ -17455,6 +17546,17 @@
               "attribute": "debounce",
               "reflects": true
             },
+            {
+              "kind": "field",
+              "name": "liveInteractions",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Emits value updates live, without `debounce`, plus interaction lifecycle events for drags and held keys.",
+              "attribute": "live-interactions",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "debounceTimeout",
@@ -17462,6 +17564,16 @@
                 "text": "any"
               },
               "description": "Internal timer handle used to debounce change events."
+            },
+            {
+              "kind": "method",
+              "name": "endInteraction",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Ends an open color drag or held-key gesture now, keeping its value. Call before removing the element."
             }
           ],
           "events": [
@@ -17470,7 +17582,21 @@
               "type": {
                 "text": "CustomEvent<ItemOptionChangedEventDetail>"
               },
-              "description": "Emitted when the option value changes."
+              "description": "Emitted when the option value changes. With `live-interactions`, emitted on every color change and carries `interaction` inside a gesture."
+            },
+            {
+              "type": {
+                "text": "CustomEvent<ItemOptionInteractionEventDetail>"
+              },
+              "description": "With `live-interactions`: a color area, hue or opacity drag or held key first changed the color, right before that value update. A press that never changes the color emits no lifecycle.",
+              "name": "luzmo-option-interaction-start"
+            },
+            {
+              "type": {
+                "text": "CustomEvent<ItemOptionInteractionEventDetail>"
+              },
+              "description": "With `live-interactions`: the gesture ended (including when the popover closes), after its last value update.",
+              "name": "luzmo-option-interaction-end"
             }
           ],
           "attributes": [
@@ -17545,6 +17671,15 @@
               "default": "50",
               "description": "Delay in milliseconds before the change event is emitted after the user stops interacting.",
               "fieldName": "debounce"
+            },
+            {
+              "name": "live-interactions",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Emits value updates live, without `debounce`, plus interaction lifecycle events for drags and held keys.",
+              "fieldName": "liveInteractions"
             }
           ],
           "superclass": {
@@ -17574,14 +17709,39 @@
           "kind": "class",
           "description": "",
           "name": "LuzmoItemOptionColorRange",
-          "members": [],
+          "members": [
+            {
+              "kind": "method",
+              "name": "endInteraction",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Ends open color gestures now, keeping their values. Call before removing the element."
+            }
+          ],
           "events": [
             {
               "name": "luzmo-option-changed",
               "type": {
                 "text": "CustomEvent<ItemOptionChangedEventDetail>"
               },
-              "description": "Emitted when the option value changes."
+              "description": "Emitted when the option value changes. With `live-interactions`, emitted immediately and carries `interaction` while a stop's color is dragged."
+            },
+            {
+              "type": {
+                "text": "CustomEvent<ItemOptionInteractionEventDetail>"
+              },
+              "description": "With `live-interactions`: a color drag or held key on one stop first changed its color, right before that value update. Each stop has its own gestures; one that never changes its color emits no lifecycle.",
+              "name": "luzmo-option-interaction-start"
+            },
+            {
+              "type": {
+                "text": "CustomEvent<ItemOptionInteractionEventDetail>"
+              },
+              "description": "With `live-interactions`: that stop's gesture ended, after its last value update.",
+              "name": "luzmo-option-interaction-end"
             }
           ],
           "attributes": [
@@ -17691,6 +17851,15 @@
               "description": "The debounce time in milliseconds",
               "fieldName": "debounce"
             },
+            {
+              "name": "live-interactions",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Emits value updates live, without `debounce`, plus interaction lifecycle events for color drags and held keys",
+              "fieldName": "liveInteractions"
+            },
             {
               "name": "parseValue",
               "type": {
@@ -17749,13 +17918,39 @@
               "name": "--luzmo-item-option-guidelines-shared-gap"
             }
           ],
+          "members": [
+            {
+              "kind": "method",
+              "name": "endInteraction",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Ends open color gestures now, keeping their values. Call before removing the element."
+            }
+          ],
           "events": [
             {
               "name": "luzmo-option-changed",
               "type": {
                 "text": "CustomEvent<ItemOptionChangedEventDetail>"
               },
-              "description": "Emitted when the guidelines value changes."
+              "description": "Emitted when the guidelines value changes. With `live-interactions`, emitted immediately and carries `interaction` while a line's color is dragged."
+            },
+            {
+              "type": {
+                "text": "CustomEvent<ItemOptionInteractionEventDetail>"
+              },
+              "description": "With `live-interactions`: a color drag or held key on one line first changed its color, right before that value update. Each line has its own gestures; one that never changes its color emits no lifecycle.",
+              "name": "luzmo-option-interaction-start"
+            },
+            {
+              "type": {
+                "text": "CustomEvent<ItemOptionInteractionEventDetail>"
+              },
+              "description": "With `live-interactions`: that line's gesture ended, after its last value update.",
+              "name": "luzmo-option-interaction-end"
             }
           ],
           "attributes": [
@@ -17769,6 +17964,15 @@
               "default": "DEFAULT_GUIDELINE_DEBOUNCE",
               "description": "Delay in milliseconds before color and number changes are emitted.",
               "fieldName": "debounce"
+            },
+            {
+              "name": "live-interactions",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Emits value updates live, without `debounce`, plus interaction lifecycle events for color drags and held keys.",
+              "fieldName": "liveInteractions"
             }
           ],
           "superclass": {
@@ -18685,6 +18889,27 @@
               "attribute": "auth-token",
               "reflects": true
             },
+            {
+              "kind": "field",
+              "name": "liveInteractions",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Emits options updates live, without the controls' debounce, plus `luzmo-option-interaction-*` events\naround drags and held keys. Off by default.",
+              "attribute": "live-interactions",
+              "reflects": true
+            },
+            {
+              "kind": "method",
+              "name": "endInteraction",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Ends the open gestures of every option now, keeping their values. Call before removing or rebinding the panel."
+            },
             {
               "kind": "field",
               "name": "shadowRoot",
@@ -18754,8 +18979,29 @@
               "type": {
                 "text": "CustomEvent<ItemOptionsChangedEventDetail>"
               },
-              "description": "Announces that the `options` of the element have changed",
+              "description": "Announces that the `options` of the element have changed. With `live-interactions`, updates inside a gesture carry `interaction`.",
               "name": "luzmo-options-changed"
+            },
+            {
+              "type": {
+                "text": "CustomEvent<ItemOptionInteractionEventDetail>"
+              },
+              "description": "With `live-interactions`: bubbles from the option whose drag or held key first changed its value, right before that options update; `detail.optionKey` names it.",
+              "name": "luzmo-option-interaction-start"
+            },
+            {
+              "type": {
+                "text": "CustomEvent<ItemOptionInteractionEventDetail>"
+              },
+              "description": "With `live-interactions`: bubbles from the option whose gesture ended, after its last options update.",
+              "name": "luzmo-option-interaction-end"
+            },
+            {
+              "type": {
+                "text": "CustomEvent<ItemOptionInteractionEventDetail>"
+              },
+              "description": "With `live-interactions`: bubbles from the option whose gesture was cancelled and reverted.",
+              "name": "luzmo-option-interaction-cancel"
             }
           ],
           "attributes": [
@@ -18851,6 +19097,15 @@
               },
               "description": "The auth token of the databroker",
               "fieldName": "authToken"
+            },
+            {
+              "name": "live-interactions",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Emits options updates live, without the controls' debounce, plus `luzmo-option-interaction-*` events\naround drags and held keys. Off by default.",
+              "fieldName": "liveInteractions"
             }
           ],
           "superclass": {
@@ -19352,6 +19607,27 @@
               "description": "Delay in milliseconds before the change event is emitted after the user stops interacting.",
               "attribute": "debounce",
               "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "liveInteractions",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Emits value updates live, without `debounce`, plus interaction lifecycle events for drags and held keys.",
+              "attribute": "live-interactions",
+              "reflects": true
+            },
+            {
+              "kind": "method",
+              "name": "endInteraction",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Ends an open drag or held-key gesture now, keeping its value. Call before removing the element."
             }
           ],
           "events": [
@@ -19360,7 +19636,28 @@
               "type": {
                 "text": "CustomEvent<ItemOptionChangedEventDetail>"
               },
-              "description": "Emitted when the option value changes."
+              "description": "Emitted when the option value changes. With `live-interactions`, emitted on every drag or key step and carries `interaction` inside a gesture."
+            },
+            {
+              "type": {
+                "text": "CustomEvent<ItemOptionInteractionEventDetail>"
+              },
+              "description": "With `live-interactions`: a drag or held key first changed the value, right before that value update. A press that never changes the value emits no lifecycle.",
+              "name": "luzmo-option-interaction-start"
+            },
+            {
+              "type": {
+                "text": "CustomEvent<ItemOptionInteractionEventDetail>"
+              },
+              "description": "With `live-interactions`: the gesture ended, after its last value update. `changed` is false when the value is back at its start.",
+              "name": "luzmo-option-interaction-end"
+            },
+            {
+              "type": {
+                "text": "CustomEvent<ItemOptionInteractionEventDetail>"
+              },
+              "description": "With `live-interactions`: the pointer was cancelled and the slider reverted to its start value.",
+              "name": "luzmo-option-interaction-cancel"
             }
           ],
           "attributes": [
@@ -19418,6 +19715,15 @@
               "description": "Delay in milliseconds before the change event is emitted after the user stops interacting.",
               "fieldName": "debounce"
             },
+            {
+              "name": "live-interactions",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Emits value updates live, without `debounce`, plus interaction lifecycle events for drags and held keys.",
+              "fieldName": "liveInteractions"
+            },
             {
               "name": "parseValue",
               "type": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luzmo/analytics-components-kit",
-  "version": "1.1.1",
+  "version": "1.2.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/cumulio-internal/analytics-components-kit.git"