@kubex/zinc 1.1.116 → 1.1.117

package/dist/custom-elements.json

@@ -16461,6 +16461,18 @@
           "kind": "class",
           "description": "",
           "name": "ZnFormGroup",
+          "cssProperties": [
+            {
+              "description": "Offset the label column sticks at while the inputs scroll past.",
+              "name": "--zn-form-group-sticky-top"
+            }
+          ],
+          "cssParts": [
+            {
+              "description": "The column holding the label, help text and chip.",
+              "name": "form-control-text"
+            }
+          ],
           "slots": [
             {
               "description": "The default slot.",
@@ -16535,6 +16547,201 @@
               },
               "default": "false",
               "attribute": "pad"
+            },
+            {
+              "kind": "field",
+              "name": "tracked",
+              "type": {
+                "text": "HTMLElement | null"
+              },
+              "privacy": "private",
+              "default": "null",
+              "description": "The scroller the label is tracked against by hand; null while native sticky is enough."
+            },
+            {
+              "kind": "field",
+              "name": "frame",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "private",
+              "default": "0"
+            },
+            {
+              "kind": "field",
+              "name": "rebind",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "offset",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "private",
+              "default": "0"
+            },
+            {
+              "kind": "field",
+              "name": "resizeObserver",
+              "type": {
+                "text": "ResizeObserver | null"
+              },
+              "privacy": "private",
+              "default": "null"
+            },
+            {
+              "kind": "field",
+              "name": "labelColumn",
+              "type": {
+                "text": "HTMLElement | null"
+              },
+              "privacy": "private",
+              "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "schedule",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "rebind",
+                  "default": "false",
+                  "type": {
+                    "text": "boolean"
+                  }
+                }
+              ],
+              "description": "Coalesces scroll and resize work into one frame, and out of the ResizeObserver callback."
+            },
+            {
+              "kind": "method",
+              "name": "findScroller",
+              "privacy": "private",
+              "description": "Native sticky only follows the nearest scroll container. Where that container isn't the one\nthe user actually scrolls — a `zn-panel` body sized to its content inside a scrolling\nslideout, say — the label never moves, so it gets translated by hand instead."
+            },
+            {
+              "kind": "method",
+              "name": "trackScroller",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "scroller",
+                  "type": {
+                    "text": "HTMLElement | null"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "scrollTarget",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "EventTarget | null"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "scroller",
+                  "type": {
+                    "text": "HTMLElement | null"
+                  }
+                }
+              ],
+              "description": "The document scrolls through the window, every other scroller reports its own events."
+            },
+            {
+              "kind": "field",
+              "name": "onScroll",
+              "privacy": "private",
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "onViewportResize",
+              "privacy": "private",
+              "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "positionLabel",
+              "privacy": "private"
+            },
+            {
+              "kind": "method",
+              "name": "nearestScrollContainer",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "HTMLElement | null"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "from",
+                  "type": {
+                    "text": "HTMLElement"
+                  }
+                }
+              ],
+              "description": "The box native sticky would anchor to, whether or not it can be scrolled."
+            },
+            {
+              "kind": "method",
+              "name": "scrollingAncestor",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "HTMLElement | null"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "from",
+                  "type": {
+                    "text": "HTMLElement"
+                  }
+                }
+              ],
+              "description": "The nearest ancestor the user can actually scroll, falling back to the document."
+            },
+            {
+              "kind": "method",
+              "name": "isScrollContainer",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "overflow",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "ancestors",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "HTMLElement[]"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "from",
+                  "type": {
+                    "text": "HTMLElement"
+                  }
+                }
+              ],
+              "description": "Walks the flattened tree, so slots and shadow boundaries are crossed the way layout does."
             }
           ],
           "attributes": [
@@ -16598,7 +16805,7 @@
           "tagNameWithoutPrefix": "form-group",
           "tagName": "zn-form-group",
           "customElement": true,
-          "jsDoc": "/**\n * @summary Short summary of the component's intended use.\n * @documentation https://zinc.style/components/form-group\n * @status experimental\n * @since 1.0\n *\n * @slot - The default slot.\n * @slot chip - A chip displayed under the form group's help text.\n *\n */",
+          "jsDoc": "/**\n * @summary Short summary of the component's intended use.\n * @documentation https://zinc.style/components/form-group\n * @status experimental\n * @since 1.0\n *\n * @slot - The default slot.\n * @slot chip - A chip displayed under the form group's help text.\n *\n * @csspart form-control-text - The column holding the label, help text and chip.\n *\n * @cssproperty --zn-form-group-sticky-top - Offset the label column sticks at while the inputs scroll past.\n *\n */",
           "documentation": "https://zinc.style/components/form-group",
           "status": "experimental",
           "since": "1.0"
@@ -51125,7 +51332,7 @@
   "package": {
     "name": "@kubex/zinc",
     "description": "A collection of web components for building web applications based off of @shoelace-style/Shoelace",
-    "version": "1.1.116",
+    "version": "1.1.117",
     "author": "",
     "license": "MIT"
   }

package/dist/vscode.html-custom-data.json

@@ -1922,7 +1922,7 @@
     },
     {
       "name": "zn-form-group",
-      "description": "Short summary of the component's intended use.\n---\n\n\n### **Slots:**\n - _default_ - The default slot.\n- **chip** - A chip displayed under the form group's help text.",
+      "description": "Short summary of the component's intended use.\n---\n\n\n### **Slots:**\n - _default_ - The default slot.\n- **chip** - A chip displayed under the form group's help text.\n\n### **CSS Properties:**\n - **--zn-form-group-sticky-top** - Offset the label column sticks at while the inputs scroll past. _(default: undefined)_\n\n### **CSS Parts:**\n - **form-control-text** - The column holding the label, help text and chip.",
       "attributes": [
         {
           "name": "label",

package/dist/web-types.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
   "name": "@kubex/zinc",
-  "version": "1.1.116",
+  "version": "1.1.117",
   "description-markup": "markdown",
   "contributions": {
     "html": {
@@ -4509,7 +4509,7 @@
         },
         {
           "name": "zn-form-group",
-          "description": "Short summary of the component's intended use.\n---\n\n\n### **Slots:**\n - _default_ - The default slot.\n- **chip** - A chip displayed under the form group's help text.",
+          "description": "Short summary of the component's intended use.\n---\n\n\n### **Slots:**\n - _default_ - The default slot.\n- **chip** - A chip displayed under the form group's help text.\n\n### **CSS Properties:**\n - **--zn-form-group-sticky-top** - Offset the label column sticks at while the inputs scroll past. _(default: undefined)_\n\n### **CSS Parts:**\n - **form-control-text** - The column holding the label, help text and chip.",
           "doc-url": "",
           "attributes": [
             {

package/dist/zn.d.ts

@@ -7288,7 +7288,7 @@ declare module "components/form-actions/index" {
     }
 }
 declare module "components/form-group/form-group.component" {
-    import { type CSSResultGroup } from 'lit';
+    import { type CSSResultGroup, type PropertyValues } from 'lit';
     import ZincElement from "internal/zinc-element";
     /**
      * @summary Short summary of the component's intended use.
@@ -7299,6 +7299,10 @@ declare module "components/form-group/form-group.component" {
      * @slot - The default slot.
      * @slot chip - A chip displayed under the form group's help text.
      *
+     * @csspart form-control-text - The column holding the label, help text and chip.
+     *
+     * @cssproperty --zn-form-group-sticky-top - Offset the label column sticks at while the inputs scroll past.
+     *
      */
     export default class ZnFormGroup extends ZincElement {
         static styles: CSSResultGroup;
@@ -7318,6 +7322,37 @@ declare module "components/form-group/form-group.component" {
         forceCols: boolean;
         layout: string;
         pad: boolean;
+        /** The scroller the label is tracked against by hand; null while native sticky is enough. */
+        private tracked;
+        private frame;
+        private rebind;
+        private offset;
+        private resizeObserver;
+        connectedCallback(): void;
+        disconnectedCallback(): void;
+        protected firstUpdated(changedProperties: PropertyValues): void;
+        private get labelColumn();
+        /** Coalesces scroll and resize work into one frame, and out of the ResizeObserver callback. */
+        private schedule;
+        /**
+         * Native sticky only follows the nearest scroll container. Where that container isn't the one
+         * the user actually scrolls — a `zn-panel` body sized to its content inside a scrolling
+         * slideout, say — the label never moves, so it gets translated by hand instead.
+         */
+        private findScroller;
+        private trackScroller;
+        /** The document scrolls through the window, every other scroller reports its own events. */
+        private scrollTarget;
+        private readonly onScroll;
+        private readonly onViewportResize;
+        private positionLabel;
+        /** The box native sticky would anchor to, whether or not it can be scrolled. */
+        private nearestScrollContainer;
+        /** The nearest ancestor the user can actually scroll, falling back to the document. */
+        private scrollingAncestor;
+        private isScrollContainer;
+        /** Walks the flattened tree, so slots and shadow boundaries are crossed the way layout does. */
+        private ancestors;
         render(): import("lit-html").TemplateResult<1>;
     }
 }